Les cookies nous permettent de vous proposer nos services plus facilement. En utilisant nos services, vous nous donnez expressément votre accord pour exploiter ces cookies.En savoir plus OK

Customer-Journey-Analyzer-User-Guide-First-Published:-2019-02-18-Last-Modified-2020-02-25

Cliquez sur le pdf pour le télécharger

Affectation-statique-d-ID-d-unite-de-numerotation-ou-de-manuel-sur-les-Commutateurs-SG550XG-et-SG350XG.html

CHAPTER-6-1-System-Administration-Guide-for-Cisco-Unity-Connection-Release-10-x-6-System-Distribution-List.html

Cisco-Integrated-Services-Routers-Performance-Overview-2013.html

Cisco-IOS-Configuration-Fundamentals-Command-Reference-April-2010.html

Cisco-IP-Communicator-version-2.0-en-Francais.html

Cisco-Prime-Network-3.10-User-Guide-November-2012.html

CISCO-VALIDATED-DESIGN-September-2018-Solution-1-1-Software-Defined-Access-Deployment-Guide.html

Cisco-Wireless-Solutions-Software-Compatibility-Matrix-Last-Updated-December-12-2017.html

Ciscowebex_150409-Japonais.html

Configuration-et-cablage-des-gammes-de-routeurs-d-acces-Cisco-850-et-Cisco-870-Guide-de-demarrage-rapide.html

Customer-Journey-Analyzer-User-Guide-First-Published:-2019-02-18-Last-Modified-2020-02-25.html

Data-Sheet-Cisco-220-Series-Smart-Switches.html

Guide-de-l'utilisateur-des-telephones-IP-Cisco-Unified-7941G-7941G-GE-7942-7961G-7961G-GE-et-7962-pour-Cisco-Unified-Communications-Manager-9.0-SCCP-et-SIP-Premiere-publication-1-Janvier-2012-Derniere-modification-18-Ju.html

Guide-de-l'utilisateur-du-telephone-IP-Cisco-Unified-7931G-pour-Cisco-Unified-Communications-Manager-9.0-SCCP-et-SIP.html

Guide-de-l-utilisateur-des-telephones-IP-Cisco-7811-7821-7841-et-7861-pour-Cisco-Unified-Communications-Manager-10-0-SIP-Premiere-publication-05-Mai-2015.html

Guide-de-l-utilisateur-des-telephones-IP-Cisco-8800-Series-Premiere-publication-2015-11-25-Derniere-modification-2020-01-23.html

Guide-de-l-utilisateur-des-telephones-IP-Cisco-serie-7800-Premiere-publication-2015-11-25-Derniere-modification-2019-09-05.html

Guide-de-l-utilisateur-des-telephones-IP-Cisco-Unified-6921-6941-6945-et-6961-pour-Cisco-Unified-Communications-Manager-10-0-SCCP-et-SIP-Premiere-publication-14-Novembre-2013.html

Guide-de-l-utilisateur-des-telephones-IP-Cisco-Unified-8941-et-8945-pour-Cisco-Unified-Communications-Manager-10-0-SCCP-et-SIP-Premiere-publication-09-Janvier-2014-Derniere-modification-13-Janvier-2014.html

Guide-de-l-utilisateur-des-telephones-IP-sans-fil-Cisco-8821-et-8821-EX-Premiere-publication-2016-06-29-Derniere-modification-:-2019-12-13.html

Guide-de-l-utilisateur-du-bureau-Cisco-Finesse-des-agents-et-superviseurs-version-12-5-1-Premiere-publication-27-Janvier-2020.html

Le-telephone-IP-Cisco-serie-7800-Les-modeles-de-telephones-IP-Cisco-7811-7821-7841-et-7861.html

Manuel-des-telephones-IP-Cisco-Unified-7960G-et-7940G-pour-Cisco-Unified-Communications-Manager-7-0-SCCP.html

Manuel-du-telephone-Cisco-Unified-IP-Conference-Station-7937G-pour-Cisco-Unified-Communications-Manager-6-0.html

Manuel-du-telephone-Cisco-Unified-IP-Conference-Station-7937G-pour-Cisco-Unified-Communications-Manager-6.0.html

Manuel-du-telephone-IP-Cisco-Unified-7961G-7961G-GE-7941G-7941G-GE-pour-Cisco-Unified-Communications-Manager-6-1-SCCP-et-SIP.html

Manuel-du-telephone-sans-fil-IP-Cisco-Unified-7921G-pour-Cisco-Unified-Communications-Manager-7.0.html

Manuel_d_utilisation_des_cisco_spa525g.html

Manuel_d_utilisation_des_cisco_spa5xx.html

Mode-de-introduction-manuel-de-profil-de-configuration-d'IPSec-sur-RV160-et-RV260.html

Nom-d-utilisateur-et-mot-de-passe-par-defaut-pour-Cisco-Transport-Controller.html

Orchestrator-de-maree-d-entreprise-editez-satisfait-livre-par-Cisco.html

sitemap.txt

Telephones-IP-Cisco-Unified-7970-pour-Cisco-Unified-CallManager-5-1-SCCP-et-SIP.html

Understanding-Layer-3-Ether-Channel-Support-on-the-Cisco-Integrated-Services-Router.html

User-Guide-for-the-Cisco-Application-Networking-Manager-5-2-February-2012.html

Customer Journey Analyzer User Guide First Published: 2019-02-18 Last Modified: 2020-02-25 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 © 2020 Cisco Systems, Inc. All rights reserved. CONTENTS CHAPTER 1 Home 1 Customer Journey Analyzer 1 Supported Browsers 1 Access the Customer Journey Analyzer 2 Analyzer Title Bar Buttons 2 Tasks to Perform on Visualization or Dashboard Page 3 CHAPTER 2 Visualization 5 Run a Visualization 5 Reports 6 Stock Reports 7 Historical Reports 10 Real-time Reports 50 Drill Down to a Portion of the Visualization 73 Modify Visualization Attributes 74 Change the Visualization Output Format 75 Visualization Creation Overview 75 Create a Visualization 77 Create a Compound Visualization 80 Create a Visualization Displaying Actual Values 81 Create and Share an Enhanced Field 81 Create an Enhanced Field 81 Share an Enhanced Field 82 Delete a Shared Enhanced Field 82 Settings for a Sample-Based Visualization 82 Select a Formula for a Measure 83 Customer Journey Analyzer User Guide iii Define Filters 84 Filter Using a Field 84 Filter Using a Measure 84 Create a Formula Based on a Profile Variable 85 Creating and Using Shared Formulas 85 Create a Shared Formula 85 Edit a Shared Formula 86 Delete a Shared Formula 86 Create and Format a Visualization Title 86 Format a Table 86 Format a Profile Variable 87 Format a Chart 87 Edit the Visualization Name 88 CHAPTER 3 Dashboard 89 Run a Dashboard 89 View Stock Report Dashboard 90 Business Metrics 90 Abandoned Contacts 90 Design Dashboards 91 CHAPTER 4 Variables 93 Create, Edit, View, and Delete Variables 93 APPENDIX A Type of Records Available in Each Repository 95 Standard ASR and AAR Fields and Measures 96 Agent Session Repository (ASR) 96 Agent Activity Repository (AAR) 100 Standard CSR and CAR Fields and Measures 102 Customer Session Repository (CSR) 102 Customer Activity Repository (CAR) 108 Customer Journey Analyzer User Guide iv Contents CHAPTER 1 Home • Customer Journey Analyzer, on page 1 • Supported Browsers, on page 1 • Access the Customer Journey Analyzer, on page 2 • Analyzer Title Bar Buttons, on page 2 • Tasks to Perform on Visualization or Dashboard Page, on page 3 Customer Journey Analyzer Customer Journey Analyzer mines real-time and historical data from multiple data sources and systems to generate specific business views of the data. The Analyzer visually displays trends to help you discern patterns and gain insight for continuous improvement. The Analyzer’s standard visualizations tie business data to traditional operational metrics, with visibility across both operational and business performance indicators in a single consolidated view. You can customize your Analyzer experience by creating dashboardsthat display your choice of visualizations and schedule Historical Reports for automatic distribution to email recipients. Supported Browsers The Customer Journey Analyzer supports any of these Browser versions: Browser Microsoft Windows 10 Mac OS X Chromebook Google Chrome 76.0.3809 76.0.3809 or higher 76.0.3809 or higher Mozilla Firefox ESR 68 or higher ESRs ESR 68 and higher ESRs NA Microsoft Edge 42.17134 or higher NA NA Chromium NA NA 73 or higher Customer Journey Analyzer User Guide 1 • Ensure the browser pop-ups are enabled. • Ensure to install Adobe Flash Player (for motion charts). Note Access the Customer Journey Analyzer To access the Customer Journey Analyzer: Procedure Step 1 Open your Web browser and navigate to the URL provided by your administrator. Step 2 On the login page that appears, enter your email address and password. Step 3 Click Sign In. The Customer Journey Analyzer home page appears, displaying a summary of all the data for each of the four data types in your repository, such as Total Agent Activity Records, Total Agent Session Records, Total Customer Activity Records, and Total Customer Session Records. You can expand and minimize More Details option. The following are displayed: • Today • Yesterday • This Week • Last Week • This Month • Last Month • Total Records Analyzer Title Bar Buttons The Analyzer title bar displays the home button. Clicking on which the navigation bar options are displayed. For more information, see Tasks to Perform on Visualization or Dashboard Page, on page 3. The following options are available under the user name drop-down list: • Support • Feedback • Help Customer Journey Analyzer User Guide 2 Home Access the Customer Journey Analyzer • Log Out If you resize your browser window to make it narrow, your user account name is not displayed on the button label. Tasks to Perform on Visualization or Dashboard Page The Visualization and Dashboard pages display all the directories of visualizations or dashboards and provides the following task to perform: • Create, rename, and delete folders or subfolders beneath the parent directory. There are two types of folders: • View only folder appears as . • Custom folder (user created) appears as . Note • Create, run, edit, search, filter, delete, and schedule a visualization or dashboard. • Export visualization Historical Reports either to Microsoft Excel or CSV file. • Change the view to either a list or a grid. Procedure to perform each task: • To add a new folder: 1. From the Home page, click the Visualization or Dashboard icon. 2. Select the folder where you like to create a new folder. 3. Click Create New > Folder. 4. In the dialog box, enter a name and click OK. • To filter either by Folders, Visualizations, or Compounds: 1. From the Home page, click the Visualization or Dashboard icon. 2. Select your choice from the Show drop-down list. • To Search: 1. From the Home page, click the Visualization or Dashboard icon. 2. In the Search field, enter the name of the visualization or dashboard. Note You can only search in the parent folder and not in the subfolders. Customer Journey Analyzer User Guide 3 Home Tasks to Perform on Visualization or Dashboard Page • To perform other tasks, in the Visualization or Dashboard page, click on a respective folder, visualization, or a dashboard: Action Appears In Description Rename Folder Rename a folder. Folder Delete Folder Folder Delete a folder. You can delete only an empty folder. Runs the selected report or dashboard. You can individually filter data based on the parameters displayed for visualizations and dashboards. After running a Stock Dashboard, you can use global filters (that is on top right) to filter the data. Note Visualization Dashboard Run Visualization Creates a copy of the default visualization or dashboard Dashboard Create a Copy Displays more details about the selected item,such asthe title, date range, and number of scheduled jobs for a visualization. Visualization Dashboard Details Opens a dialog box where you can save the selected historical visualization as a Microsoft Excel or CSV file. The export option isn’t available for real-time or compound visualizations. Visualization Dashboard Export as Excel Visualization Dashboard Export as CSV Opens a page where you can schedule the selected visualization to run on a periodic basis and associate it with an email list for automatic distribution. Schedule Visualization Job(s) Opensthe selected visualization or dashboard on a page where you can edit it. Custom Created Reports Edit Deletes the selected visualization or dashboard. You can’t delete a visualization that is used in a dashboard. Custom Created Reports Delete Customer Journey Analyzer User Guide 4 Home Tasks to Perform on Visualization or Dashboard Page CHAPTER 2 Visualization • Run a Visualization, on page 5 • Reports, on page 6 • Drill Down to a Portion of the Visualization, on page 73 • Modify Visualization Attributes, on page 74 • Change the Visualization Output Format, on page 75 • Visualization Creation Overview, on page 75 • Create a Visualization, on page 77 • Create a Compound Visualization, on page 80 • Create a Visualization Displaying Actual Values, on page 81 • Create and Share an Enhanced Field, on page 81 • Settings for a Sample-Based Visualization, on page 82 • Select a Formula for a Measure, on page 83 • Define Filters, on page 84 • Create a Formula Based on a Profile Variable, on page 85 • Creating and Using Shared Formulas, on page 85 • Create and Format a Visualization Title, on page 86 • Format a Table, on page 86 • Format a Profile Variable, on page 87 • Format a Chart, on page 87 • Edit the Visualization Name, on page 88 Run a Visualization To run a visualization: Procedure Step 1 Click the Visualization icon on the navigation bar. Step 2 Navigate to the visualization you want to run and click the button and select Run from the context menu. By default you can view a set of stock reports. To edit a Historical and Realtime report, you can Create a Copy and click Save As to save it to your folder. For more information, see Reports. Customer Journey Analyzer User Guide 5 Step 3 After the visualization is rendered, click the navigation icon to see the Data Summary. You can see the last refreshed time of a data in the Data Summary tab. If you are running a visualization with multiple modules (compound visualization), the Data Summary tab displays a drop-down list of all the modulesin the visualization so you can display the detailsfor each individual module. Step 4 Click the Details tab to display the following settings and panels. Click a panel title to expand or collapse the panel. If you are running a compound visualization, the details are displayed separately, depending on which module is selected in the drop-down list at the top of the tab. • Start Time-Displays either the time period for a historical visualization or Real-time for a real-time visualization. • Compute-For a real-time visualization,specifies Duration and Refresh Rate.Possible valuesfor Duration: • None. Provides a view of current activity. • 5, 10, 15, or 30 minutes. Provides a view of everything that happened from up to 30 minutes ago to the current moment. • Start of Day. Provides a view of everything that happened since midnight. For a time-based historical visualization, specifies the compute interval and the number of records to be considered in the visualization. For a sample-based visualization, specifies the frequency, band, and whether or not the calculations are cumulative (see Settings for a Sample-Based Visualization, on page 82). An additional panel is present for each field to which a filter has been applied, so you can see which values have been filtered in or out of the visualization. Step 5 Click Settings to display the segments and variables associated with the visualization. You can also change the Output Type. For more information, see Change the Visualization Output Format, on page 75. Step 6 If the visualization is in a chart format: • The underlying table used to construct it is displayed beneath the chart. Click the Hide Table link to hide the table, and the Show Table link to redisplay it. • Rest your pointer over a bar, line, slice, area, or bubble in the chart to display information about the segment that the item represents. Step 7 If the visualization is historical, you can click the Export button on the title bar to export the visualization as a Microsoft Excel or CSV file. Real-time and compound visualizations cannot be exported. Reports In the Analyzer, there is a set of canned reports, which allow you to see real-time data or historical data. To view the read-only reports, navigate to Visualizations. Customer Journey Analyzer User Guide 6 Visualization Reports Stock Reports Folder hierarchy and reports links in Stock Report are as follows: Historical Agent Reports Agent, on page 10 Reports Agent - Chart, on page 14 Agent Outdial Statistics, on page 15 Agent Statistics, on page 15 Site, on page 16 Site Chart, on page 21 Team, on page 21 Team Chart, on page 26 Team Statistics, on page 26 Agent Trace Report Agent Trace, on page 27 Auxiliary Idle Reports Agent Idle Auxiliary, on page 31 Reports Site Idle Auxiliary, on page 32 Team Idle Auxiliary, on page 32 Wrap-up Agent WrapUp Auxiliary, on page 33 Reports Site WrapUp Auxiliary, on page 33 Team WrapUp Auxiliary, on page 34 Customer Journey Analyzer User Guide 7 Visualization Stock Reports Contact Center Average Service Level Card, on page 34 Overview Historical Reports Contact Details in Queue Longest Contact in Queue Card, on page 35 Team Details, on page 35 Multimedia Reports Agent Volume, on page 36 Agent Volume - Chart, on page 36 Contact by DNIS, on page 37 Contact Reason, on page 37 Contact Reason - Chart, on page 38 Contact Volume, on page 38 Contact Volume - Chart, on page 39 CSR-Yesterday, on page 39 Entry Point Contact Volume - CAR, on page 41 Entry Point Contact Volume - Chart, on page 41 Incoming, Short Contacts - Entry point, on page 42 Queue Abandoned Chart, on page 42 Queue Abandoned, on page 42 Queue Service Level, on page 44 Queue Contact Volume - Chart, on page 43 Queued Contact Volume, on page 44 Site Contact Volume - Chart, on page 45 Sites Contact Details, on page 46 Teams Contact Details, on page 47 Volume Report, on page 48 Volume Report - Chart, on page 48 My Team & Queue Average Handle Time Card, on page 49 Stats Average Wrapup Time Card, on page 49 My Team Stats, on page 49 Total Handled Card, on page 49 Customer Journey Analyzer User Guide 8 Visualization Stock Reports Interval Agent Interval Realtime, on page 50 Reports Agent Reports Real-Time Reports Agent Interval Realtime - Chart, on page 52 Agent Outdial Statistics Realtime, on page 52 Queue Statistics Realtime, on page 53 Site Interval Realtime, on page 54 Site Interval Realtime - Chart, on page 55 Team Interval Realtime, on page 55 Team Interval Realtime Report-Chart, on page 57 Team Statistics Realtime, on page 57 Snapshot Agent Realtime, on page 58 Reports Agent State - Site Realtime, on page 59 Agent State - Team Realtime, on page 60 Agent Statistics Realtime, on page 61 Contact Center Average Service Level Card Real-Time, on page 62 Overview Contact Details in Queue Real-Time, on page 62 Longest Contact in Queue Card, on page 35 Average Handle Time Card Real-Time, on page 72 Team Details Real-Time, on page 63 Total Abandoned Contacts Card Real-Time, on page 63 Interval Abandoned - Chart, on page 63 Reports Multimedia Reports Abandoned Realtime, on page 64 Entry Point Interval Realtime - Chart, on page 65 Incoming, Short, IVR RealTime - Entry point, on page 65 Queue Service Level Realtime, on page 66 Queue Service Level Realtime - Chart, on page 67 Sites Contact Details Realtime, on page 67 Sites Contact Details Realtime - Chart, on page 68 Team Contact Details Realtime, on page 68 Team Contact Details Realtime - Chart, on page 70 Customer Journey Analyzer User Guide 9 Visualization Stock Reports Snapshot Entry Point Incoming Realtime - Chart , on page 70 Snapshot Snapshot Entry Point IVR Realtime - Chart, on page 70 Reports Snapshot Entry Point Realtime, on page 70 Snapshot Entry Point Realtime - Chart, on page 71 Snapshot Queue Realtime - Chart, on page 71 Snapshot Queue Service Level Realtime, on page 72 My Team & QueueStats Average Handle Time Card Real-Time, on page 72 My Team Stats Real-Time, on page 72 Team State Chart Real-Time, on page 73 Total Handled Card Real-Time, on page 73 Historical Reports Note These reports are not available for Cloud Connect users. Agent Reports Agent The Agent report is used to display agent statistics. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula Name of agent Used As: Row Segment Agent Name Interval Time Period Last 7 Days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Total number of times an agent logged in on Count of Agent Channel ID that day. Login Count Sum of Outdial Connected Count + Sum of Connected Count Contact Handled The total number of calls handled. Maximum Logout Timestamp - Minimum Login Timestamp The total amount of time agents were logged in. Staff Hours Customer Journey Analyzer User Guide 10 Visualization Historical Reports Parameter Description Formula Initial Login Time The date and time the agent logged in. Minimum Login Timestamp Final Logout Time The date and time the agent logged out. Maximum Logout Timestamp ((Sum of Connected Duration + Sum of Wrapup Duration) + (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration)) / (Maximum Logout Timestamp - Minimum Login Timestamp) The measure of time agents spent on calls compared to available and idle time. Occupancy The number of times an agent went into the Sum of Idle Count Idle state. Idle Count The total amount of time agent spent in the Sum of Idle Duration Idle state. Total Idle Time Sum of Idle Duration / Sum of Idle Count The average length of time agents were in the Idle state. Average Idle Time The number of times an agent went into the Sum of Available Count Available state. Available Count The total amount of time agents spent in the Sum of Available Duration Available state. Total Available Time Sum of Available Duration /Sum of Available Count The average length of time agents were in the Available state. Average Available Time The number of times an agent went into the Sum of Ringing Count Inbound Reserved state. Inbound Reserved Count The total amount of time agents spent in the Sum of Ringing Duration Reserved state, during which a call is coming in to an agent’s station but hasn’t yet been answered. Inbound Reserved Total Time Sum of Ringing Duration / Sum of Ringing Count The average length of time agents were in the Inbound Reserved state. Average Inbound Reserved Time The number of times an agent put an inbound Sum of Hold Count caller on hold. Inbound Hold Count The total amount of time the inbound calls Sum of Hold Duration were on hold. Inbound Hold Total Time Sum of Hold Duration/ Sum of Hold Count Average Inbound Hold The average hold time for inbound calls. Time The number of inbound calls that got Sum of Connected Count connected to an agent. Inbound connected Count Sum of Connected Duration-Sum of Hold Duration The total amount of time an agent was talking with a caller. Inbound Connected Total Time Customer Journey Analyzer User Guide 11 Visualization Agent Parameter Description Formula The total amount of time the agents got Sum of Connected Duration connected to inbound calls. Inbound Contact Total Time Sum of Connected Duration/Sum of Connected Count Average Inbound Contact The average inbound contact time. Time The number of times an agent was in the Sum of Outdial Ringing Count Outdial Reserved state, a state indicating that the agent has initiated an outdial call, but the call isn’t connected yet. Outdial Reserved Count The total amount of time agents were in the Sum of Outdial Ringing Duration Outdial Reserved state Outdial Reserved Total Time Sum of Outdial Ringing Duration/ Sum of Outdial Ringing Count The average amount of time agents were in the Outdial Reserved state. Average Outdial Reserved Time The number of times an agent put an outbound Sum of Outdial Hold Count caller on hold. Outdial Hold Count The total amount of time the outbound calls Sum of Outdial Hold Duration were on hold. Outdial Hold Total Time Sum of Outdial Hold Duration / Sum of Outdial Hold Count Average Outdial Hold The average hold time for outbound calls. Time The number of times an agent attempted to Sum of Outdial Ringing Count make an outdial call. Outdial Attempted Count The number of outdial callsthat got connected Sum of Outdial Connected Count to an agent. Outdial Connected Count Sum of Outdial Connected Duration - Sum of Outdial Hold Duration The total amount of time an agent was talking in an outdial call. Outdial Connected Total Time Sum of Outdial Connected Duration The total amount of time the agents got connected to outbound calls. Outdial Contact Total Time Sum of Outdial Connected Duration/ Sum of Outdial Connected Count Average Outdial Contact The average outbound contact time. Time The number of calls that were answered (that Sum of Disconnected Count is, connected to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden Disconnected Count The number of times agents went into the Sum of Wrapup Count Wrap-up state after an inbound call. Inbound WrapUp Count The total amount of time agents spent in the Sum of Wrapup Duration Wrap-up state after an inbound call. Inbound WrapUp Total Time Customer Journey Analyzer User Guide 12 Visualization Agent Parameter Description Formula Sum of Wrapup Duration/ Sum of Wrapup Count The average length of time agents were in the Wrap-up state after an inbound call. Average Inbound Wrap Up Time The number of times agents went into the Sum of Outdial Wrapup Count Wrap-up state after an outbound call. Outdial WrapUp Count The total amount of time agents spent in the Sum of Outdial Wrapup Duration Wrap-up state after an outbound call. Outdial Wrapup Total Time Sum of Outdial Wrapup Duration / Sum of Outdial Wrapup Count The average length of time agents were in the Wrap-up state after an outbound call. Average Outdial Wrapup Time The number of times an agent was in the Not Sum of Not Responded Count Responding state. Not Responding Count The total amount of time agents spent in the Sum of Not Responded Duration Not Responding state. Not Responding Total Time Sum of Not Responded Duration / Sum of Not Responded Count The average length of time agents were in the Not Responding state. Average Not Responding Time The number of times agents answered a Sum of Consult Count consult request from another agent. Consult Answer Count The total amount of time agents spent Sum of Consult Duration answering consult requests. Consult Answer Total Time Sum of Consult Duration / Sum of Consult Count The average length of time agents spent answering consult requests. Average Consult Answer Time The number of times agents sent a consult Sum of Consult Request Count request to another agent. Consult Request Count The total amount of time agents spent Sum of Consult Request Duration consulting other agents. Consult Request Total Time Sum of Consult Request Duration / Sum of Consult Request Count The average length of time agents spent consulting other agents. Average Consult Request Time The number of times agents answered a Sum of Consult Answer Count consult request from another agent Consult Count The total amount of time agents spent Sum of Consult Answer Duration answering consult requests. Total Consult Time Sum of Consult Answer Duration / Sum of Consult Answer Count The average length of time agents spent answering consult requests. Average Consult Time The number of times an agent initiated a Sum of Conference Count conference call. Conference Count The number of times agentsinitiated a consult Sum of CTQ Request Count to queue while handling an inbound call. Inbound CTQ Request Count The total amount of time agents spent Sum of CTQ Request Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Request Time Customer Journey Analyzer User Guide 13 Visualization Agent Parameter Description Formula The number of times agents answered a Sum of CTQ Answer Count consult-to-queue request from another agent who was handling an inbound call. Inbound CTQ Answer Count The total amount of time agents spent Sum of CTQ Answer Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Answer Time Sum of Outdial CTQ Request Count The number of times agents initiated a consult-to-queue request while handling an outdial call. Outdial CTQ Request Count Sum of Outdial CTQ Request Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Request Time Sum of Outdial CTQ Answer Count The number of times agents answered a consult-to-queue request from another agent who was handling an outdial call. Outdial CTQ Answer Count Sum of Outdial CTQ Answer Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Answer Time Sum of Agent To Agent Transfer Count The number of times an agent transferred an inbound call to another agent. Agent Transfer Sum of Agent Transfer To Queue Request Count The number of times an agent requeued an inbound call. Agent Requeue The number of times an agent transferred an Sum of Blind Transfer Count inbound call without consulting first. Blind Transfer The average length of time spent handling an (Sum of Connected Duration + inbound call. Inbound Average Handle Time (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration) / Sum of Outdial Connected Count The average length of time spent handling an outbound call. Outdial Average Handle Time Agent - Chart This report represents the number of contacts handled by an agent. You can filter data by contact type. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Bar Chart Media Type Description Formula Count of Connected Count (Channel Type = telephony) + Count of Outdial Connected Count (Channel Type = telephony) The media type of the telephony contact. Voice Customer Journey Analyzer User Guide 14 Visualization Agent - Chart Media Type Description Formula Count of Connected Count (Channel Type = chat) Chat The media type of the chat contact. Count of Connected Count (Channel Type = email) + Count of Outdial Connected Count (Channel Type = email) The media type of the email contact. Email Agent Outdial Statistics This report represents the number of outdial calls made by an agent. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time Period Last 7 Days The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type The date and time the agent logged Minimum Login Timestamp in. Initial Login Time The number of outbound calls Sum of Outdial Connected Count handled. Outdial Contact Handled (sum of outdial connected duration + Sum of outdial wrap-up duration) / Sum of outdial connected count The average handle time for outbound calls. Outdial Average Handle Time The total amount of time an agent Sum of Outdial Duration was talking with a party on an outdial call. Outdial Connected Time Outdial Connected Time/Outdial Contact Handled The average outdial connected time. Outdial Average Connected Time Outdial Connected Time - Outdial Hold Duration The total amount of time an agent was talking with a party on an outdial call. Outdial Talk Time Agent Statistics This report represents the statistics of an agent. Customer Journey Analyzer User Guide 15 Visualization Agent Outdial Statistics Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time Period Last 7 Days The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type The date and time the agent logged Minimum Login Timestamp in. Login Time Handled = Sum of outdial connected count + Sum of connected count The total number of interactions handled. Handled Total Handle time = (Sum of connected duration + Sum of wrap-up duration)+(Sum of outdial connected duration + Sum of outdial wrap-up) The cumulative amount of time spent handling calls. Total Handle Time Avg Handle Time = (Sum of connected duration + Sum of wrap-up duration) + (Sum of outdial connected duration + Sum of outdial wrap-up) / Sum of connected count. The average length of time spent handling a call (connected time plus wrap-up time), divided by number of answered calls. Avg Handle Time Site This report provides a detailed view of number of agent statistics in each site. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula The call center location to which a call got distributed. Used As: Row Segment Site Name Interval Time Period Last 7 Days Customer Journey Analyzer User Guide 16 Visualization Site Parameter Description Formula The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type Sum of Connected Count + Sum of Outdial Connected Count The total number of contacts handled. Contact Handled Sum of Logout Timestamp - Sum of Login Timestamp The total amount of time agents were logged in. Staff Hours ((Sum of Connected Duration + Sum of Wrapup Duration) + (Sum of Outdial Connected Duration+Sum of Outdial Wrapup Duration)) / (Maximum Logout Timestamp - Minimum Login Timestamp) The measure of time agents spent on calls compared to available and idle time. Occupancy The number of times an agent went Sum of Idle Count into the Idle state. Idle Count The total amount of time agents Sum of Idle Duration spent in the Idle state. Total Idle Time Sum of Idle Duration / Sum of Idle Count The average length of time agents were in the Idle state. Average Idle Time The number of times an agent went Sum of Available Count into the Available state. Available Count The total amount of time agents Sum of Available Duration spent in the Available state. Total Available Time Sum of Available Duration / Sum of Available Count The average length of time agents were in the Available state. Average Available Time The number of times an agent went Sum of Ringing Count into the Inbound Reserved state. Inbound Reserved Count The total number of time the agents Sum of Ringing Duration spent in the Reserved state (time duration after a call is ringing and before a call is answered). Inbound Reserved Total Time Sum of Ringing Duration / Sum of Ringing Count The average length of time agents were in the Inbound Reserved state. Average Inbound Reserved Time The number of times an agent put Sum of Hold Count an inbound caller on hold. Inbound Hold Count The total amount of time the Sum of Hold Duration inbound calls were on hold. Inbound Hold Time Customer Journey Analyzer User Guide 17 Visualization Site Parameter Description Formula Sum of Hold Duration / Sum of Hold Count The average hold time for inbound calls. Average Inbound Hold Time The number of inbound calls that Sum of Connected Count got connected to an agent. Inbound Connected Count Sum of Connected Duration - Sum of Hold Duration The total amount of time the agents got connected to inbound calls. Inbound Connected Total Time The number of agents currently Sum of Connected Duration connected to an inbound call. Inbound Contact Total Time Sum of Connected Duration / Sum of Connected Count The average inbound connected time. Average Inbound Contact Total time The number of times an agent was Sum of Outdial Ringing Count in the Outdial Reserved state (time duration after a call is ringing and before a call is answered). Outdial Reserved Count The total amount of time agents Sum of Outdial Ringing Duration were in the Outdial Reserved state Outdial Reserved Total Time Sum of Outdial Ringing Duration / Sum of Outdial Ringing Count The average amount of time agents were in the Outdial Reserved state. Average Outdial Reserved Time The number of times an agent put Sum of Outdial Hold Count an outdial call on hold. Outdial Hold Count The total amount of time the outdial Sum of Outdial Hold Duration calls were on hold. Outdial Total Hold Time Sum of Outdial Hold Duration / Sum of Outdial Hold Count The average hold time for outdial calls. Average Outdial Hold Time The number of times an agent Sum of Outdial Ringing Count attempted to make an outdial call. Outdial Attempted Count The number of outdial calls that Sum of Outdial Connected Count were connected to an agent. Outdial Connected Count Sum of Outdial Connected Duration- Sum of Outdial Hold Duration The total amount of time an agent was talking in an outdial call. Outdial Connected Total Time The total amount of time agents Sum of Outdial Connected Duration were connected to outdial calls. Outdial Contact Total Time Sum of Outdial Connected Duration / Sum of Outdial Connected Count The average outdial connected time. Average Outdial Contact Time Customer Journey Analyzer User Guide 18 Visualization Site Parameter Description Formula The number of calls that got Sum of Disconnected Count connected to an agent, but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden Disconnected Count The number of times agents went Sum of Wrapup Count into the Wrap-up state after an inbound call. Inbound WrapUp Count The total amount of time agents Sum of Wrapup Duration spent in the Wrap-up state after an inbound call. Inbound Wrapup Total Time Sum of Wrapup Duration / Sum of Wrapup Count The average length of time agents were in the Wrap-up state after an inbound call. Average Inbound Wrap Up Time The number of times agents went Sum of Outdial Wrapup Count into the Wrap-up state after an outdial call. Outdial Wrapup Count The total amount of time agents Sum of Outdial Wrapup Duration spent in the Wrap-up state after an outdial call. Outdial Wrapup Total Time Sum of Outdial Wrapup Duration / Sum of Outdial Wrapup Count The average length of time agents were in the Wrap-up state after an outdial call. Average Outdial Wrapup Time The number of times an agent was Sum of Not Responded Count in the Not Responding state. Not Responding Count The total amount of time agents Sum of Not Responded Duration spent in the Not Responding state. Not Responding Total Time Sum of Not Responded Duration / Sum of Not Responded Count The average length of time agents were in the Not Responding state. Average Not Responding Time The number of times agents Sum of Consult Count answered a consult request from another agent. Consult Answer Count The total amount of time agents Sum of Consult Duration spent answering consult requests. Consult Answer Total Time Sum of Consult Duration / Sum of Consult Count The average length of time agents spent answering consult requests. Average Consult Answer Time The number of times agents sent a Sum of Consult Request Count consult request to another agent. Consult Request Count Customer Journey Analyzer User Guide 19 Visualization Site Parameter Description Formula The total amount of time agents Sum of Consult Request Duration spent consulting other agents. Consult Request Total Time Sum of Consult Request Duration / Sum of Consult Request Count The average length of time agents spent consulting other agents. Average Consult Request Time The number of times agents Sum of Consult Answer Count answered consult requests plus the number of times agents consulted other agents. Consult Count Total Consult Answer Time plus Sum of Consult Answer Duration Total Consult Request Time. Total Consult Time Sum of Consult Answer Duration / Sum of Consult Answer Count The average length of consulting time. Average Consult Time The number of times an agent Sum of Conference Count initiated a conference call. Conference Count The number of times agents Sum of CTQ Request Count initiated a consult to queue while handling an inbound call. Inbound CTQ Request Count The total amount of time agents Sum of CTQ Request Duration spent answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Request Time The number of times agents Sum of CTQ Answer Count answered a consult-to-queue request from another agent who was handling an inbound call. Inbound CTQ Answer Count The total amount of time agents Sum of CTQ Answer Duration spent answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Answer Time Sum of Outdial CTQ Request Count The number of times agents initiated a consult-to-queue request while handling an outdial call. Outdial CTQ Request Count Sum of Outdial CTQ Request Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Request Time The number of times agents Sum of Outdial CTQ Answer Count answered a consult-to-queue request from another agent who was handling an outdial call. Outdial CTQ Answer Count Customer Journey Analyzer User Guide 20 Visualization Site Parameter Description Formula Sum of Outdial CTQ Answer Duration The total amount of time agents spent answering consult-to queue requests from an agent handling an outdial call. Outdial CTQ Total Answer Time Sum of Agent To Agent Transfer Count The number of times an agent transferred an inbound call to another agent. Agent Transfer Sum of Agent Transfer To Queue Request Count The number of times an agent requeued an inbound call. Agent Requeue The number of times an agent Sum of Blind Transfer Count transferred an inbound call without consulting first. Blind Transfer (Sum of Connected Duration + Sum of Wrapup Duration) / Sum of Connected Count The average length of time spent handling an inbound call. Inbound Average Handle Time (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration) / Sum of Outdial Connected Count The average length of time spent handling an outdial call. Outdial Average Handle Time Site Chart This report represents a chart view of the number of contacts handled per channel type for a site. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Bar Chart Parameters Description Formula Count of Connected Count (Channel Type = telephony) + Count of Outdial Connected Count (Channel Type = telephony) The media type of the telephony contact. Voice Count of Connected Count (Channel Type = chat) Chat The media type of the chat contact. Count of Connected Count (Channel Type = email) + Count of Outdial Connected Count (Channel Type = email) The media type of the email contact. Email Team This report represents the channel type used by each agent in the team. The report displays the following details about the activity of each agent in the report since initial login. Customer Journey Analyzer User Guide 21 Visualization Site Chart Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula The name of a team. Used As: Row Segment Team Name Interval Time period Last 7 Days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Sum of Connected Count + Sum of Outdial Connected Count Contact Handled The total number of contacts handled Sum of Logout Timestamp -Sum of Login Timestamp The total amount of time agents were logged in. Staff Hours ((Sum of Connected Duration +Sum of Wrapup Duration)+(Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration)) / (Maximum Logout Timestamp - Minimum Login Timestamp) The measure of time agents spent on calls compared to available and idle time. Occupancy When an agent goes to idle, all the channels Sum of Idle Count go to idle state. Idle Count The total amount of time agents spent in the Sum of Idle Duration Idle state. Total Idle Time Sum of Idle Duration / Sum of Idle Count The average length of time agents were in the Idle state. Average Idle Time The number of times an agent went into the Sum of Available Count Available state. Available Count The total amount of time agents spent in the Sum of Available Duration Available state. Total Available Time Sum of Available Duration / Sum of Available Count The average length of time agents were in the Available state. Average Available Time The number of times an agent went into the Sum of Ringing Count Inbound Reserved state Inbound Reserved Count The total amount of time agents spent in the Sum of Ringing Duration Reserved state (time duration once the call is ringing and before the call gets answered). Inbound Reserved Total Time Sum of Ringing Duration / Sum of Ringing Count The average length of time agents were in the Inbound Reserved state. Average Inbound Reserved Time Customer Journey Analyzer User Guide 22 Visualization Team Parameter Description Formula The number of times an agent put an inbound Sum of Hold Count caller on hold. Inbound Hold Count The total amount of time the inbound calls Sum of Hold Duration were on hold. Inbound Hold Time Sum of Hold Duration / Sum of Hold Count Average Inbound Hold The average hold time for inbound calls. Time The number of inbound calls that were Sum of Connected Count connected to an agent. Inbound Connected Count Sum of Connected Duration - Sum of Hold Duration The total amount of time an agent wastalking with a caller. Inbound Connected Total Time The total amount of time agents were Sum of Connected Duration connected to inbound calls. Inbound Contact Total Time Sum of Connected Duration /Sum of Connected Count Average Inbound Contact The average inbound connected time. Total time The number of times the agent was in the Sum of Outdial Ringing Count Outdial Reserved state (time duration once the call is ringing and before the call gets answered). Outdial Reserved Count The total amount of time agents were in the Sum of Outdial Ringing Duration Outdial Reserved state Outdial Reserved Total Time Sum of Outdial Ringing Duration / Sum of Outdial Ringing Count The average amount of time agents were in the Outdial Reserved state. Average Outdial Reserved Time The number of times an agent put an outdial Sum of Outdial Hold Count call on hold. Outdial Hold Count The total amount of time the outdial calls were Sum of Outdial Hold Duration on hold. Outdial Total Hold Time Sum of Outdial Hold Duration / Sum of Outdial Hold Count Average Outdial Hold The average hold time for outdial calls. Time The number of times an agent attempted to Sum of Outdial Ringing Count make an outdial call. Outdial Attempted Count The number of outdial callsthat got connected Sum of Outdial Connected Count to an agent. Outdial Connected Count Sum of Outdial Connected Duration - Sum of Outdial Hold Duration The total amount of time an agent wastalking with a party on an outdial call. Outdial Connected Total Time Sum of Outdial Connected Duration The total amount of time agents got connected to outdial calls. Outdial Contact Total Time Sum of Outdial Connected Duration / Sum of Outdial Connected Count Average Outdial Contact The average outdial connected time. Time Customer Journey Analyzer User Guide 23 Visualization Team Parameter Description Formula The number of calls that got connected to an Sum of Disconnected Count agent, but then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden Disconnect Count The number of times agents went into the Sum of Wrapup Count Wrap-up state after an inbound call. Inbound WrapUp Count The total amount of time agents spent in the Sum of Wrapup Duration Wrap-up state after an inbound call. Inbound Wrapup Total Time Sum of Wrapup Duration / Sum of Wrapup Count The average length of time agents were in the Wrap-up state after an inbound call. Average Inbound Wrap Up Time The number of times agents went into the Sum of Outdial Wrapup Count Wrap-up state after an outdial call. Outdial Wrapup Count The total amount of time agents spent in the Sum of Outdial Wrapup Duration Wrap-up state after an outdial call. Outdial Wrapup Total Time Sum of Outdial Wrapup Duration / Sum of Outdial Wrapup Count The average length of time agents were in the Wrap-up state after an outdial call. Average Outdial Wrapup Time The number of times an agent was in the Not Sum of Not Responded Count Responding state. Not Responding Count The total amount of time agents spent in the Sum of Not Responded Duration Not Responding state. Not Responding Total Time Sum of Not Responded Duration / Sum of Not Responded Count The average length of time agents were in the Not Responding state. Average Not Responding Time The number of times agents answered a Sum of Consult Count consult request from another agent. Consult Answer Count The total amount of time agents spent Sum of Consult Duration answering consult requests. Consult Answer Total Time Sum of Consult Duration / Sum of Consult Count The average length of time agents spent answering consult requests. Average Consult Answer Time The number of times agents sent a consult Sum of Consult Request Count request to another agent. Consult Request Count The total amount of time agents spent Sum of Consult Request Duration consulting other agents. Consult Request Total Time Sum of Consult Request Duration / Sum of Consult Request Count The average length of time agents spent consulting other agents. Average Consult Request Time The number of times agents answered consult Sum of Consult Answer Count requests plus the number of times agents consulted other agents. Consult Count Total Consult Answer Time plus Total Sum of Consult Answer Duration Consult Request Time. Total Consult Time Customer Journey Analyzer User Guide 24 Visualization Team Parameter Description Formula Sum of Consult Answer Duration / Sum of Consult Answer Count Average Consult Time The average length of consulting time. The number of times an agent initiated a Sum of Conference Count conference call. Conference Count The number of times agentsinitiated a consult Sum of CTQ Request Count to queue while handling an inbound call. Inbound CTQ Request Count The total amount of time agents spent Sum of CTQ Request Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Request Time The number of times agents answered a Sum of CTQ Answer Count consult-to-queue request from another agent who was handling an inbound call. Inbound CTQ Answer Count The total amount of time agents spent Sum of CTQ Answer Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Answer Time Sum of Outdial CTQ Request Count The number of times agents initiated a consult-to-queue request while handling an outdial call. Outdial CTQ Request Count Sum of Outdial CTQ Request Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Request Time Sum of Outdial CTQ Answer Count The number of times agents answered a consult-to-queue request from another agent who was handling an outdial call. Outdial CTQ Answer Count Sum of Outdial CTQ Answer Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Answer Time Sum of Agent To Agent Transfer Count The number of times an agent transferred an inbound call to another agent. Agent Transfer Sum of Agent Transfer To Queue Request Count The number of times an agent requeued an inbound call. Agent Requeue The number of times an agent transferred an Sum of Blind Transfer Count inbound call without consulting first. Blind Transfer The average length of time spent handling an (Sum of Connected Duration+ inbound call. Inbound Average Handle Time (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration) / Sum of Outdial Connected Count The average length of time spent handling an outdial call. Outdial Average Handle Time Customer Journey Analyzer User Guide 25 Visualization Team Team Chart The report displays the channel type details of each agent in a chart format. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Bar Chart Parameter Description Formula Count of Connected Count (Channel Type = telephony) + Count of Outdial Connected Count (Channel Type = telephony) The media type of the telephony contact. Voice Count of Connected Count (Channel Type = chat) Chat The media type of the chat contact. Count of Connected Count (Channel Type = email) + Count of Outdial Connected Count (Channel Type = email) The media type of the email contact. Email Team Statistics This report represents team statistics in a detailed format. Report Path: Stock Reports > Historical Reports > Agent Reports Output Type: Table Parameter Description Formula The name of a team Used As: Row Segment Team Name Interval Time period Last 7 Days The media type of the contact,such astelephony, email, or chat. Used As: Row Segment Channel Type Idle Count The number of times an agent went into the Idle state. Sum of Idle Count The number of times an agent went into the Available Sum of Available Count state. Available Count The number of inbound calls that got connected to an Sum of connected Count agent. Connected Count The number of times agents answered a consult request Sum of Consult Count from another agent. Consult Count The number of times agents went into the Wrap-up Sum of Wrapup Count state. Wrapup Count Customer Journey Analyzer User Guide 26 Visualization Team Chart Parameter Description Formula Sum of Not Responded Count The number of times an agent was in the Not Responding state. Not Responded Count The number of agents who got connected to or are Sum Outdial Count wrapping up an outdial call. Outdial Count Agent Trace This report represents which site or team the agent belongs to with a detailed statistic report. Report Path: Stock Reports > Historical Reports > Agent Trace Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time Period Last 7 Days The call center location to which a call got distributed. Used As: Row Segment Site Name A group of agents at a specific site who handle a particular type of call. Used As: Row Segment Team Name The dial number the agent used to log in to the Agent Desktop Used As: Row Segment Agent Endpoint (DN) The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type The date and time the agent logged in for the Minimum Login Timestamp first time. This column appears only in agent-level summary reports. Initial Login Time The date and time the agent logged out. This Maximum Logout Timestamp column appears only in agent level summary reports. Final Logout Time Sum of Logout Timestamp -Sum of Login Timestamp The total amount of time agents were logged in. Staff Hours Customer Journey Analyzer User Guide 27 Visualization Agent Trace Parameter Description Formula ((Sum of Connected Duration + Sum of Wrapup Duration) + (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration)) / (Maximum Logout Timestamp - Minimum Login Timestamp) The measure of time agents spent on calls compared to available and idle time. Occupancy The number of times an agent went into the Sum of Idle Count Idle state. Idle Count The total amount of time agents spent in the Sum of Idle Duration Idle state. Total Idle Time The number of times an agent went into the Sum of Available Count Available state. Available Count The total amount of time agents spent in the Sum of Available Duration Available state. Total Available Time Sum of Available Duration /Sum of Available Count The average time agents were in the Available state. Avg Available Time The number of times an agent went into the Sum of Ringing Count Inbound Reserved state. Inbound Reserved Count The total amount of time agents spent in the Sum of Ringing Duration Reserved state (time duration once the call is ringing and before the call gets answered). Inbound Reserved Total Time Sum of Ringing Duration / Sum of Ringing Count The average total amount of time agents spent in the Reserved state (time duration once the call is ringing and before the call gets answered). Avg Inbound Reserved Time The number of times an agent put an inbound Sum of Hold Count caller on hold. Inbound Hold Count The total amount of time the inbound calls were Sum of Hold Duration on hold. Inbound Total Hold Time The number of inbound callsthat got connected Sum of Connected Count to an agent. Inbound Connected Count Sum of Connected DurationSum of Hold Duration The total amount of time an agent was talking with a caller Inbound Connected Total Time The total amount of time agents got connected Sum of Connected Duration to inbound calls. Inbound Contact Total Time Sum of Connected Duration / Sum of Connected Count Avg Inbound Contact The average inbound contact time. Total time Customer Journey Analyzer User Guide 28 Visualization Agent Trace Parameter Description Formula The number of times an agent was in the Sum of Outdial Ringing Count Outdial Reserved state (time duration once the call is ringing and before the call gets answered). Outdial Reserved Count Sum of Outdial Ringing Duration / Sum of Outdial RingingCount The total amount of time agents were in the Outdial Reserved state. Outdial Reserved Total Time Sum of Outdial Ringing Duration / Sum of Outdial Ringing Count Average time the agents were in the Outdial Reserved state. Average Outdial Reserved Time The number of times an agent put an outdial Sum of Outdial Hold Count call on hold. Outdial Hold Count The total amount of time the outdial calls were Sum of Outdial Hold Duration on hold. Outdial Total Hold Time Sum of Outdial Hold Duration / Sum of Outdial Hold Count Avg Outdial Total Hold The average hold time for outbound calls. Time The number of outdial calls that got connected Sum of Outdial Connected Count to an agent. Outdial Connected Count Sum of Outdial Connected Duration - Sum of Outdial Hold Duration The total amount of time an agent was talking with a party on an outdial call. Outdial Connected Total Time Sum of Outdial Connected Duration The total amount of time agents got connected to outdial calls. Outdial Contact Total Time Sum of Outdial Connected Duration / Sum of Outdial Connected Count Average Outdial Contact The average outbound contact time. Time The number of calls that got connected to an Sum of Disconnected Count agent, but then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden DisconnectCount The number of times agents went into the Sum of Wrapup Count Wrap-up state after an inbound call. Inbound Wrap Up Count The total amount of time agents spent in the Sum of Wrapup Duration Wrap-up state after an inbound call. Inbound Wrap Up Total Time Sum of Wrapup Duration / Sum of Wrapup Count The percentage of time agents were in the Wrap-up state after an inbound call. Average Inbound Wrap Up Time The number of times agents went into the Sum of Outdial Wrapup Count Wrap-up state after an outdial call. Outdial Wrap Up Count The total amount of time agents spent in the Sum of Outdial Wrapup Duration Wrap-up state after an outdial call. Outdial Wrap Up Total Time Customer Journey Analyzer User Guide 29 Visualization Agent Trace Parameter Description Formula Sum of Outdial Wrapup Duration / Sum of Outdial Wrapup Count The average time agents were in the Wrap-up state after an outbound call. Average Outdial Wrap Up Time Reason Reason identifier Count of Reason Sum of Idle Duration / Sum of Idle Count Avg Idle Time The average time agents were in the Idle state. Sum of Hold Duration / Sum of Hold Count Avg Inbound Hold Time The average hold time for inbound calls. The number of times an agent attempted to Sum of Outdial Ringing Count make an outdial call. Outdial Attempted Count The number of times an agent was in the Not Sum of Not Responded Count Responding state. Not Responding Count The total amount of time agents spent in the Sum of Not Responded Duration Not Responding state. Not Responding Total Time Sum of Not Responded Duration / Sum of Not Responded Count The average time agents were in the Not Responding state. Avg Not Responding Time The number of times agents answered a consult Sum of Consult Count request from another agent. Consult Count The total amount of time agents spent Sum of Consult Duration answering consult requests. Consult Total Time Sum of Consult Answer Duration / Sum of Consult Answer Count The average time agents spent answering consult requests. Avg Consult Answer Time The number of times agent sent a consult Sum of Consult Request Count request to another agent. Consult Request Count The total amount of time agents spent Sum of Consult Request Duration consulting other agents. Consult Request Total Time Sum of Consult Request Duration / Sum of Consult Request Count The average time agentsspent consulting other agents. Avg Consult Request Time The number of times agents answered consult Sum of Consult Answer Count requests plus the number of times agents consulted other agents. Consult Answer Count Total Consult Answer Time plus Total Consult Sum of Consult Answer Duration Request Time. Total Consult Answer Time The number of times an agent initiated a Sum of Conference Count conference call. Conference Count The number of times agents initiated a consult Sum of CTQ Request Count to queue while handling an inbound call. Inbound CTQ Request Count Customer Journey Analyzer User Guide 30 Visualization Agent Trace Parameter Description Formula The total amount of time agents spent Sum of CTQ Request Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Request Time The number of times agents answered a Sum of CTQ Answer Count consult-to-queue request from another agent who was handling an inbound call. Inbound CTQ Answer Count The total amount of time agents spent Sum of CTQ Answer Duration answering consult-to-queue requests from an agent handling an inbound call. Inbound Total CTQ Answer Time Sum of Outdial CTQ Request Count The number of times agents initiated a consult-to-queue request while handling an outdial call. Outdial CTQ Request Count Sum of Outdial CTQ Request Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Request Time Sum of Outdial CTQ Answer Count The number of times agents answered a consult-to-queue request from another agent who was handling an outdial call. Outdial CTQ Answer Count Sum of Outdial CTQ Answer Duration The total amount of time agents spent answering consult-to-queue requests from an agent handling an outdial call. Outdial CTQ Total Answer Time Sum of Agent To Agent Transfer Count The number of times an agent transferred an inbound call to another agent. Agent Transfer Sum of Agent Transfer To Queue Request Count The number of times an agent requeued an inbound call. Agent Requeue The number of times an agent transferred an Sum of Blind Transfer Count inbound call without consulting first. Blind Transfer (Sum of Connected Duration + Sum of Wrapup Duration) / Sum of Connected count The average length of time agents were in the Wrap-up state after an inbound call. Inbound Average Handle Time (Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration) / Sum of Outdial Connected Count The average length of time agents were in the Wrap-up state after an outdial call. Outdial Average Handle Time Auxiliary Reports Idle Report Agent Idle Auxiliary Customer Journey Analyzer User Guide 31 Visualization Auxiliary Reports This report represents the agent idle time. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Idle Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time Period Last 7 Days Name of the code Used As: Column Segment Idle Code Name Count of Record Unique ID The number of values specifying a condition for including records. Count The amount of time during which the agent was engaged in the Sum of Activity Duration activity. Duration Site Idle Auxiliary This report represents the agent idle time for a site. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Idle Reports Output Type: Table Parameter Definition Formula Name of site. Used As: Row Segment Site Name Interval Time Period. Last 7 Days Name of the code. Used As: Column Segment Idle Code Name Count of Record Unique ID Count Count of records. Duration The amount of time. Sum of Activity Duration Team Idle Auxiliary This report represents the agent idle time for a team. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Idle Reports Output Type: Table Customer Journey Analyzer User Guide 32 Visualization Site Idle Auxiliary Parameter Definition Formula Name of the team. Used As: Row Segment Team Name Interval Time period. Last 7 Days Name of code applied Used As: Column Segment Idle Code Name Count of Record Unique ID Count The total number of calls. Duration The total time. Sum of Activity Duration Wrap-up Reports Agent WrapUp Auxiliary This report represents the agent name and the wrap-up code reason. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Wrap-up Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time period Last 7 Days The name of the wrap-up code applied. Used As: Column Segment Wrapup Code Name Count of Contact Session ID Count The number of values within the specified range. Duration The number of seconds that the interaction was active. Sum of Wrap-up Duration Site WrapUp Auxiliary This report represents the site and the wrap-up code used by agents in a particular site. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Wrap-up Reports Output Type: Table Parameter Description Formula Name of the site. Used As: Row Segment Site Name Customer Journey Analyzer User Guide 33 Visualization Wrap-up Reports Parameter Description Formula Interval Time period Last 7 Days Name of the wrap-up code applied. Used As: Column Segment Wrapup Code Name Count of Contact Session ID Count The number of values for specific condition. The amount of time during which the agent was engaged Sum of Wrapup Duration in the activity. Duration Team WrapUp Auxiliary This report represents the team name and the wrap-up code used by agents belonging to a particular team. Report Path: Stock Reports > Historical Reports > Auxiliary Reports > Wrap-up Reports Output Type: Table Parameter Description Formula Name of the team. Used As: Row Segment Team Name Interval Time period Last 7 Days The name of the wrap-up code applied. Used As: Column Segment Wrapup Code Name Count of Contact Session ID Count The number of values. The amount of time during which the agent was engaged Sum of Wrapup Duration in the activity. Duration Contact Center Overview Average Service Level Card This pie chart shows average service level that includes all channels. Report Path: Stock Reports > Historical Reports > Contact Center Overview Output Type: Chart Contact Details in Queue This report provides contact details by queue. Report Path: Stock Reports > Historical Reports > Contact Center Overview Output Type: Table Customer Journey Analyzer User Guide 34 Visualization Team WrapUp Auxiliary Parameter Description Formula Interval Time Period Last 7 Days The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type The last queue that the contact was in. Used As: Row Segment Queue Name # Contacts The total amount of contacts. Count of Contact Session ID Avg Queue Wait Time Average of total queue duration. Average of Queue Duration Longest time any contact spent in Maximum Queue Duration queues. Longest Contact in Queue Number of contacts that were Count of Contact Session ID abandoned. # Abandoned Contacts Longest Contact in Queue Card This report provides the longest duration of the contact, channel type, and queue name. Report Path: Stock Reports > Historical Reports > Contact Center Overview Output Type: Card Team Details This report provides team details. Report Path: Stock Reports > Historical Reports > Contact Center Overview Output Type: Table Parameter Description Formula Interval Time Period Last 7 Days Team Name Name of the team. Agent Name Name of the agent. The total amount of contacts that were logged in. Total Log In Count Initial Login Time Timestamp of first login in interval. Minimum Login Timestamp Timestamp of last logout within Maximum Logout Timestamp interval. Final Logout Time Staff Hours Duration logged-in during interval. Sum of Login Time Customer Journey Analyzer User Guide 35 Visualization Longest Contact in Queue Card Parameter Description Formula Number of times the agent's state Sum of Idle Count changed to idle. Idle Counts Number of contacts handled in Sum of Connected Count sessions started in this interval. # Contacts Handled Number of contacts handled with Voice Connected Count telephony channel type. # Calls Handled Number of contacts handled with Chat Outdial Connected Count chat channel type. # Chats Handled Number of contacts handled with Email Connected Count email channel type. # Emails Handled Multimedia Reports Agent Volume This report represents the number of customers handled by an agent and the average CSAT score. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula Interval Time Period Last 7 days The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name The media type of the contact,such astelephony, email, or chat. Used As: Profile Segment Channel Type Count of Contact Session ID (Termination Type = normal) Handled The total number of interactions handled. (Sum of Hold Duration + Sum of Connected Duration + Sum of Wrapup Duration) / Count of ContactSession ID (Termination Type = Normal) Avg Handle The average length of time spent handling a call. Time Avg CSAT Represents Average customer satisfaction score. Avg of CSAT score Agent Volume - Chart This report represents the content type handled by an agent. You can filter data based on content type or date. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Customer Journey Analyzer User Guide 36 Visualization Multimedia Reports Parameter Description Formula Count of Contact Session ID (Channel Type = telephony, Termination Type=normal) The media type of the telephony contact. Voice Count of Contact Session ID (Channel Type = chat, Termination Type=normal) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = email, Termination Type=normal) The media type of the email contact. Email Contact by DNIS This report represents the contact DNIS for a customer. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameters Description Formula Interval Time period Last 7 days DNIS number for an incoming call. Row Segment DNIS does not appear for a Chat contact. Note DNIS Channel Type The media type of the contact. Row Segment Count of Contact Session ID Number of Represents number of contacts. Contacts Contact Reason This report represents the contact reason for a customer to contact the call center. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameters Description Formula Interval Time period Last 7 days The name of a queue, which is holding place for calls while Queue Name they await handling by an agent. Calls move from an entry point into a queue and then gets distributed to agents. Queue Name Contact Reason identifier. Contact Reason Reason Count of ContactSession ID (Channel Type = telephony) Voice The media type of the telephony contact. Customer Journey Analyzer User Guide 37 Visualization Contact by DNIS Parameters Description Formula Count of ContactSession ID (Channel Type = chat) Chat The media type of the chat contact. Count of ContactSession ID (Channel Type = email) Email The media type of the email contact. Contact Reason - Chart This report represents the Contact Volume for each entry point and channel type. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Voice The media type of the telephony contact. Count of ContactSession ID (Channel Type = telephony) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = chat) Email The media type of the email contact. Count of Contact Session ID (Channel Type = email) Contact Volume This report represents the number of contacts handled based on the DNIS value. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Definition Formula The DNISdigits delivered with the call. DNIS, or Dialed Number Identification Service, is a service provided by the phone company that delivers a digitstring indicating the number the caller dialed along with the call. DNIS does not appear for a Chat contact. Note Used As: Row Segment DNIS The name of an entry point. Used As: Row Segment Entry point Name Interval Time period Last 7 Days Customer Journey Analyzer User Guide 38 Visualization Contact Reason - Chart Parameter Definition Formula The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type Contacts Contact identifier. Count of Contact Session ID Contact Volume - Chart This report represents the number of contacts handled based on the DNIS value for a channel type. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Voice The media type of the telephony contact. Count of ContactSession ID (Channel Type = telephony) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = chat) Email The media type of the email contact. Count of Contact Session ID (Channel Type = email) CSR-Yesterday This report represents Contact Session Record (CSR) for yesterday. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula The ANI digits delivered with a call. ANI, or Automatic Value of ANI Number Identification, is a service provided by the phone company that deliversthe caller’s phone number along with the call. ANI The DNIS digits delivered with the call. DNIS, or Value of DNIS Dialed Number Identification Service, is a service provided by the phone company that delivers a digit string indicating the number the caller dialed along with the call. DNIS The name of a queue, which is holding place for calls Value of Final queue name while they await handling by an agent. Calls are moved from an entry point into a queue and are subsequently distributed to agents. Queue Site The call center location to which a call was distributed. Value of Site name A group of agents at a specific site who handle a Value of Team name particular type of call. Team The name of an agent, that is, a person who answers Value of Agent name customer calls/chats/emails Agent Customer Journey Analyzer User Guide 39 Visualization Contact Volume - Chart Parameter Description Formula Value of Contact start timestamp Call start time Timestamp when the contact started. Call end time Timestamp when the contact ended. Value of Contact end timestamp Value of Call end time – call start time Call Duration The connected duration of a call from. The amount of time during which a call was in IVR Value of Value of IVR duration state. IVR time Queue Time The amount of time a contact spent in queue waiting. Value of Queue duration The duration of connected (talking) state within this Value of Connected duration interaction. Connected time The amount of time during which a call was put on Value of Hold duration hold. Hold time The cumulative amount of time agents spent in the Value of Wrap up duration wrap-up state after handling the interactions. Wrap up time The total amount of time an agent handles the call Wrap up time + connected time including wrap-up time. Handle time The amount of time an agent spent consulting with Value of Consult duration another agent while handling a call. Consult time The amount of time an agent spent in conference with Value of Conference duration a caller and another agent. Conference time Total duration spent on consult-to queue within an Value of CTQ duration interaction. CTQ request time The number of times an agent put an inbound caller on Value of Hold count hold. Hold count The number of times agents initiated a consult with Value of Consult count another agent or someone at an external number while handling a call. Consult count The number of times an agent established a conference Value of Conference count call with the caller and another agent. Conference count The number of times an agent transferred without Value of Blind transfer count consulting first. Blind transfer count This is the count of consult-to-queue within an Value of CTQ count interaction. CTQ request count Number of The number of times a call wastransferred by an agent. Value of Transfer count transfers Transfer errors Value of Transfer error count Handle type how the call was handled, short, abandoned, normal. Value of Handle type Termination type A text string specifying how a call was terminated. Value of Termination type Customer Journey Analyzer User Guide 40 Visualization CSR-Yesterday Parameter Description Formula Record flag Flag that indicates whether the contact was recorded. Value of Is recorded The wrap-up code that the agent gave for the Value of Wrap up code name interaction. Wrap up Session ID A unique string that identifies the contact session. Value of Contact session ID Entry Point Contact Volume - CAR This report represents entrypoint through which the customer was routed to an agent from the IVR. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula The name of an entry point. Used As: Row Segment Entrypoint Name Interval Time period Last 7 days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Record Unique ID (Previous State = ivr-connected, Current State = ivr-connected) The number of calls that entered this queue after being classified into the queue from an entry point by the IVR call control script. From Entry Point Count of Record Unique ID(Previous State = Connected, Current State = ivr-connected) The number of calls that entered this queue after having been transferred into the queue by an agent who clicked the Queue button, selected a queue from the drop-down list, and clicked Transfer. Transferred In Count of Record Unique ID(Current State = ended, Previous State = ivr-connected) IVR Ended Exit Point of IVR/AA. Entry Point Contact Volume - Chart This report displays the contact entry point. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Voice The media type of the telephony contact. Count of ContactSession ID (Channel Type = telephony) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = chat) Email The media type of the email contact. Count of Contact Session ID (Channel Type = email) Customer Journey Analyzer User Guide 41 Visualization Entry Point Contact Volume - CAR Incoming, Short Contacts - Entry point This report represents the number of calls that were terminated without being connected to an agent. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula The name of an entry point. Used As: Profile Segment Entrypoint Name Interval Time period Last 7 days The media type of the contact, such as telephony, email, or chat. Used As: Profile Segment Channel Type Incoming Number of incoming contact types. Count of Contact Session ID Count of Contact Session ID(Termination Type = short_call) The number of callsthat were terminated within theShort Call threshold provisioned for the enterprise without being connected to an agent. Short IVR Time The duration of the call in the IVR. Sum of IVR Duration Queue Abandoned Chart This report represents the number of abandoned customer for each Queue. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Channel Type = telephony, Termination Type = abandoned) The media type of the telephony contact. Voice Count of Contact Session ID (Channel Type = chat, Termination Type = abandoned) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = email, Termination Type = abandoned) Email The media type of the email contact. Queue Abandoned This report represents the number of calls that were in the system but terminated before being distributed to an agent or other resource. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Customer Journey Analyzer User Guide 42 Visualization Incoming, Short Contacts - Entry point Parameter Description Formula Filter: Final Queue ID = Is not in 0 The name of a queue. Used As: Row Segment Queue Name Interval Time period Last 7 days Filter: Final Queue ID = Is not in 0 The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Termination Type = normal) + Count of Contact Session ID (Handle type = Abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls are not. Completed Count of ContactSession ID (Handle type = Abandoned) / Sum of Contact Count %Abandoned The percentage of calls that were abandoned Count of ContactSession ID (Handle type = Abandoned) The number of callsthat were abandoned during the report interval. An abandoned call is a call that was terminated without being distributed to a destination site, but that was in the system for longer than the time specified by the Short Call threshold provisioned for the enterprise. Abandoned Sum of Queue Duration / Sum of Queue Count The cumulative amount of time calls were in queue, waiting to be sent to an agent or other resource. Because queued time is calculated after the call leaves the queue, the queued time for a call that is still in the queue is not reflected in the report. Avg Queued Time Sum of Queue Duration (Is Contact Handled = 1) / Count of contact session ID (Termination Type = abandoned) The cumulative amount of time calls were in the system for longer than the time specified by the Short Call threshold, but terminated before being distributed to an agent or other resource. Avg Abandoned Time Queue Contact Volume - Chart This chart report represents number of channel types that entered the queue for a particular channel type Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Channel Type=telephony, Termination Type=abandoned) + Count of Contact Session ID(Channel Type=telephony, Termination Type=normal) + Sum of Contact Count (Channel Type=telephony, Termination Type=quick_disconnect) The media type of the telephony contact. Voice Customer Journey Analyzer User Guide 43 Visualization Queue Contact Volume - Chart Parameter Description Formula Count of Contact Session ID (Channel Type=chat, Termination Type=abandoned) + Count of Contact Session ID (Channel Type=chat, Termination Type=normal) + Sum of Contact Count (Channel Type=chat, Termination Type=quick_disconnect) The media type of the chat contact. Chat Count of Contact Session ID (Channel Type=email, Termination Type=abandoned) + Count of Contact Session ID (Channel Type=email, Termination Type=normal) + Sum of Contact Count (Channel Type=email, Termination Type=quick_disconnect) The media type of the email contact. Email Queued Contact Volume This report represents number of channel types that entered the queue. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula Name of queue Used As: Row Segment Queue Name Interval Time period Last 7 days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Sum of Contact Count Total Total number of contacts. Queued The number of calls that entered the queue during this interval. Sum of queue count Queue Service Level This report represents the service level for a queue. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula Name of queue Used As: Row Segment Queue Name Interval Time period Last 7 days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Customer Journey Analyzer User Guide 44 Visualization Queued Contact Volume Parameter Description Formula Service Level % = Sum of Is Within Service Level / Total. The number of calls that were answered within the Service Level threshold provisioned for the queue or skill Service Level % Total Total number of contacts Sum of Contact Count Count of Contact Session ID (Termination Type = normal) + Count of Contact Session ID (Termination Type = abandoned) + Sum of Contact count (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls are not. Completed Count of ContactSession ID (Handle Type = abandoned) The number of calls that were abandoned during the report interval. An abandoned call is a call that was terminated without being distributed to a destination site, but that was in the system for longer than the time specified by the Short Call threshold provisioned for the enterprise. Abandoned Count of Contact Session ID (Connected Duration > 0) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered The number of times agents initiated a conference Sum of Conference Count call to an agent or external number. ConferenceCount Hold Count The number of times a caller was put on hold. Sum of Hold Count Sum of Queue Duration (Is Contact Handled != 1) / Count of Contact Session ID (Termination Type = Abandoned) The cumulative amount of time calls were in the system for longer than the time specified by the Short Call threshold, but terminated before being distributed to an agent or other resource. Avg Abandoned Time Sum of Queue Duration (Is Contact Handled = 1) / Count of Contact Session ID (Connected Duration > 0) The total answered time divided by the total number of answered calls. Avg Speed of Answer Site Contact Volume - Chart This report represents the number of contact types for each site. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Channel Type=telephony, Termination Type=abandoned) + Count of Contact Session ID (Channel Type=telephony, Termination Type=normal) + Sum of Contact Count (Channel Type=telephony, Termination Type=quick_disconnect) The media type of the telephony contact. Voice Customer Journey Analyzer User Guide 45 Visualization Site Contact Volume - Chart Parameter Description Formula Count of Contact Session ID (Channel Type=chat, Termination Type=abandoned) + Count of Contact Session ID (Channel Type=chat, Termination Type=normal) + Sum of Contact Count (Channel Type=chat, Termination Type=quick_disconnect) The media type of the chat contact. Chat Count of Contact Session ID (Channel Type=email, Termination Type=abandoned) + Count of Contact Session ID (Channel Type=email, Termination Type=normal) + Sum of Contact Count (Channel Type=email, Termination Type=quick_disconnect) The media type of the email contact. Email Sites Contact Details This report represents the details of all agents in a team for a site. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula Filter: Site ID is not in 0 The name of a site. Used As: Row Segment Site Name Filter: Site ID is not in 0 The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Interval Time period Last 7 days Count of Contact Session ID (Termination Type = normal) + Count of Contact Session ID (Termination Type = abandoned) + Sum of Contact Count (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls are not. Completed Sum of Contact Count (Termination Type = quick_disconnect) The number of calls that were answered (that is, connected to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within theSudden Disconnect threshold provisioned for the enterprise. Sudden DisconnectCount Count of Contact Session ID (Termination Type = normal) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered Conference Sum of Conference Count Count Count of Contact Session ID (Termination Type = Abandoned) / Sum of Contact Count %Abandoned The percentage of calls that were abandoned. Customer Journey Analyzer User Guide 46 Visualization Sites Contact Details Parameter Description Formula Hold Count The number of times a caller was put on hold. Sum of Hold Count Sum of Queue Duration(Is Contact Handled = 1) The cumulative amount of time between when calls entered the queue and when they were answered (connected to an agent or other resource) during the report interval. Because answered time is calculated after the call is answered, answered time for callsthat are waiting to be answered is not reflected in the report. Answered Time Sum of Hold Duration + Sum of Connected Duration The time interval between when calls were answered by an agent or other resource and when they were terminated. Because connected time is not calculated until the call is terminated, the connected time for a call that is still in progress is not reflected in the report. Connected Time Teams Contact Details This report represents the number of contact types for a team. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula The name of a team. Used As: Row Segment Team Name Interval Time period Last 7 days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Termination Type = normal) + Count of Contact Session ID (Termination Type = abandoned) + Sum of Contact Count (Termination Type = sudden_disconnect) The number of callsthat ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls are not. Completed Sum of Contact Count (Termination Type = sudden_disconnect) The number of calls that were answered (that is, connected to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden DisconnectCount Customer Journey Analyzer User Guide 47 Visualization Teams Contact Details Parameter Description Formula Count of Contact Session ID (Termination Type = normal) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered The number of times agents initiated a conference call Sum of Conference Count to an agent or external number. Conference Count Hold Count The number of times a caller was put on hold. Sum of Hold Count Sum of Queue Duration (Is Contact Handled = 1) The cumulative amount of time between when calls entered the queue and when they were answered (connected to an agent or other resource) during the report interval. Because answered time is calculated after the call is answered, answered time for calls that are waiting to be answered is not reflected in the report. Answered Time Sum of Hold Duration + Sum of Connected Duration The time interval between when calls were answered by an agent or other resource and when they were terminated. Because connected time is not calculated until the call is terminated, the connected time for a call that is still in progress is not reflected in the report. Connected Time Volume Report This report represents the number of channel types for a team. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Table Parameter Description Formula Interval Time period Last 7 days The media type of the contact, such as Channel Type telephony, email, or chat. Channel Type Offered The total number of contacts offered. Sum of Is Offered Count of Contact Session ID (Termination Type = normal) Handled The total number of interactions handled. (Sum of Connected Duration + Sum of Hold Duration + Sum of Wrapup Duration) /Count of Contact Session ID (Termination Type = normal) The average length of time spent handling a call. Avg Handle Time Volume Report - Chart This report represents the number of contacts offered or handled for a particular channel type. Report Path: Stock Reports > Historical Reports > Multimedia Reports Output Type: Bar Chart Customer Journey Analyzer User Guide 48 Visualization Volume Report Parameter Description Formula The total number of contacts Sum of Is Offered offered. Offered Count of Contact Session ID (Termination Type = normal) The total number of interactions handled. Handled My Team & Queue Stats Average Handle Time Card This report displays the average time of total contacts (voice, email, and chat) that got handled. Report Path: Stock Reports > Historical Reports > My Team & Queue Stats Output Type: Card Average Wrapup Time Card This report displays the average wrapup time for each individual channel and for overall channels. Report Path: Stock Reports > Historical Reports > My Team & Queue Stats Output Type: Table My Team Stats This report displays the team statistics. Report Path: Stock Reports > Historical Reports > My Team & Queue Stats Output Type: Table Parameter Description Formula Interval Time Period Last 7 Days Team Name Name of the team. Agent Name Name of the agent. # Contacts Handled Number of contacts handled. Sum of Connected Count Average time spent per inbound Number of Contacts Handled contact. Average Handle Time Average time spent on wrapup for Sum of Wrapup Count inbound contacts. Average Wrapup Time Total Handled Card This report displays in total contacts handled and broken down by channel type. Report Path: Stock Reports > Historical Reports > My Team & Queue Stats Output Type: Card Customer Journey Analyzer User Guide 49 Visualization My Team & Queue Stats Real-time Reports Note These reports are not available for Cloud Connect users. Agent Reports Real-time Agent interval reports display cumulative and derived values at the site, team, or agent level. Interval Report-Agent Agent Interval Realtime This report represents a cumulative and derived value when an agent is connected to a channel type. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name Interval Time Period Realtime - 30 mins The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Sum of Logout Timestamp - Sum of Login Timestamp The total amount of time the agents were logged in. Staff Hours (Sum of Outdial Wrapup Duration + Sum of Wrapup Duration ) + (Sum of Outdial Connected Duration + Sum of connected duration) / (Sum of Available Duration + Sum of Idle Duration + Sum of Not Responding Duration) + (Sum of Connected Duration + Sum of Wrapup Duration + Sum of Outdial Connected Duration + Sum of Outdial Wrapup Duration) The measure of time agents spent on calls compared to available and idle time. Occupancy Sum of Outdial Connected Count + Sum of connected Count The total number of callsfrom all origination types. Total Calls The total amount of time the agents spent in Sum of Idle Duration the Idle state. Idle Time The total amount of time the agents spent in Sum of Available Duration the Available state. Available Time Customer Journey Analyzer User Guide 50 Visualization Real-time Reports Parameter Description Formula The total amount of time the agents spent in Sum of Ringing Duration the Reserved state (time duration once the call starts ringing and before the call is answered). Inbound Reserved Time The total amount of time an agent wastalking Sum of Connected Duration with a caller. Inbound Connected Time Sum Of Connected Duration + Sum Of Hold Duration Total connected duration of a call agent is attending including hold time. Inbound Contact Time The number of times an agent put an inbound Sum of Hold Duration caller on hold. Inbound Hold Time The total amount of Sum of Connected Duration time an agent was talking with a caller. Inbound Connected Time The total amount of time the agents spent in Sum of Wrapup Duration the Wrap-up state after an inbound call. Inbound Wrapup Time (Sum of Connected Duration + Sum of Hold Duration) /Sum of Connected Count Inbound Average The average inbound connected time. Connected Time (Sum of Connected Duration + Sum of Wrapup Duration) / (Sum of Connected Count) The average length of time agents were in the Wrap-up state after an inbound call. Inbound Average Handle Time The total amount of time the agents spent in Sum of Not Responding Duration the Not Responding state. Not Responding Time The number of times an agent was in the Sum of Outdial Count Outdial Reserved state (time duration once the call starts ringing and before the call is answered). Outdial Attempted Count The number of outdial calls that got Sum of Outdial Connected Count connected to an agent. Outdial Connected Count The total amount of time the agents were in Sum of Outdial Ringing Duration the Outdial Reserved state. Outdial Reserved Time The total amount of time the outdial calls Sum of Outdial Hold Duration were on hold. Outdial Hold Time The amount of time the agents got connected Sum of Outdial Connected Duration to outdial calls. Outdial Connected Time The total amount of time agents spent in the Sum of Outdial Wrapup Duration Wrap-up state after an outdial call. Outdial Wrapup Time Sum of Outdial Connected Duration / Sum of Outdial Connected Count Outdial Average The average outbound connected time. Connected Time Customer Journey Analyzer User Guide 51 Visualization Agent Interval Realtime Parameter Description Formula (Sum of Outdial Connected Duration+Sum of Outdial Wrapup Duration) / (Sum of Outdial Count +Sum of Outdial Connected Count) The average length of time spent handling an outdial call (Total Outdial Connected Time plus Total Outdial Wrap Up Time, divided by Outdial Connected Count). Outdial Average Handle Time Maximum Logout Timestamp - Minimum Login Timestamp The sum of time during which the agent was engaged in the activity. Login Duration Agent Interval Realtime - Chart This report represents the time an agent is connected to a content type. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Bar Chart Paramter Description Formula The number of emails, chats, and Sum of Connected Count telephony calls that were distributed and accepted. Connected Count Agent Outdial Statistics Realtime This report represents the number of outdial calls made by an agent in real time. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type The date and time the agent logged Minimum Login Timestamp in. Login Time The number of outbound calls Sum of Outdial Connected Count handled. Outdial Contact Handled Customer Journey Analyzer User Guide 52 Visualization Agent Interval Realtime - Chart Parameter Description Formula (Outdial Connected Time + Outdial Wrapup Time) / Outdial Calls Outdial Connected Time = Sum of Outdial Connected Duration. Outdial Wrapup Time = Sum of Outdial Wrapup Duration. Outdial Calls = Outdial Attempted Count + Outdial Contact Handled Outdial Attempted Count = Sum of Outdial Count. The average handle time for outbound calls. Outdial Average Handle Time The total amount of time an agent Sum of Outdial Connected Duration was talking with a party on an outdial call. Outdial Connected Time Outdial Connected Time / Outdial Contact Handled The average of outdial connected time. Outdial Average Connected Time Outdial Connected Time + Outdial Hold Duration Outdial Hold Duration = Sum Of Outdial Hold Duration The total amount of time an agent was talking with a party on an outdial call. Outdial Talk Time Queue Statistics Realtime This report represents Queue details in real time. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Parameter Description Formula The name of a queue, which is holding place for calls while they await handling by an agent. Calls move from an entry point into a queue and then distributed to agents. Used As: Row Segment Queue Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Service Level % = Sum of Within Service Level / Sum Of Contact Count The number of callsthat were answered within theService Level threshold provisioned for queue or skill (in a skills interval by queue report), divided by total calls that includes abandoned calls. Service Level % In Queue The number of queues contact entered. Count Of Queue Count Customer Journey Analyzer User Guide 53 Visualization Queue Statistics Realtime Parameter Description Formula The longest amount of time a contact has been in each MaximumQueue Duration queue covered in the report. Longest Time In Queue Site Interval Realtime This report represents the details for a site. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Parameter Description Formula Site Name Name of site. Row Segment The media type of the contact, such as Row Segment telephony, email, or chat. Channel Type (Sum of Logout Timestamp - Sum of Login Timestamp) The total amount of time the agents were logged in. Staff Hours ((Sum of Outdial Wrap up Duration + Sum of Wrap-up Duration) + (Sum of Outdial Connected Duration + Sum Of Connected Duration)) / Staff Hours The measure of time agents spent on calls compared to available and idle time. Occupancy Sum of Outdial Connected Count + Sum of Connected Count Total Contacts Total number of calls The total amount of time the agents spent Sum of Idle Duration in the Idle state. Idle Time The total amount of time the agents spent Sum of Available Duration in the Available state. Available Time The number of times an agent went into the Sum of Ringing Duration Inbound Reserved state. Inbound Reserved Time The total amount of time the agents spent Sum of Connected Duration in the Reserved state (time duration once the call starts ringing and before the call gets answered). Inbound Connected Time The number of times an agent put an Sum of Hold Duration inbound caller on hold. Inbound Hold Time Sum of Connected Duration + Sum of Hold Duration The number of inbound calls that got connected to an agent. Inbound Contact Time The number of times agents went into the Sum of Wrap-up Duration Wrap-up state after an inbound call. Inbound Wrap up Time Customer Journey Analyzer User Guide 54 Visualization Site Interval Realtime Parameter Description Formula (Sum of Connected Duration + Sum of Hold Duration) /Sum of Connected Count The number of agents currently connected to an inbound call. Inbound Average Connected Time (Sum of Connected Duration + Sum of Wrap-up Duration) / (Sum of Connected Count) The average length of time spent handling an inbound call. Inbound Average Handle Time The total amount of time the agents spent Sum of Not Responding Duration in the Not Responding state. Not Responding Time The number of times an agent attempted to Sum of Outdial Count make an outdial call. Outdial AttemptedCount The number of outdial calls that got Sum of Outdial Connected Count connected to an agent. Outdial Connected Count The total amount of time the agents were Sum of Outdial Ringing Duration in the Outdial Reserved state Outdial Reserved Time The number of times an agent put an outdial Sum of Outdial Hold Duration call on hold. Outdial Hold Time The number of outdial calls that got Sum of Outdial Connected Duration connected to an agent. Outdial Connected Time The number of times agents went into the Sum of Outdial Wrap up Duration Wrap-up state after an outdial call. Outdial Wrap up Time Sum of Outdial Connected Duration / Sum of Outdial Connected Count Outdial Average The average outdial connected time. Connected Time (Sum of Outdial Connected Duration+Sum of Outdial Wrap up Duration) / (Sum of Outdial Count +Sum of Outdial Connected Count) The average length of time spent handling an outdial call. Outdial Average Handle Time Site Interval Realtime - Chart This report represents the number of answered contact types for a site. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Connected Count Number of answered contact types. Sum of Connected Count Team Interval Realtime This report represents s detailed view at a team and site level. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Customer Journey Analyzer User Guide 55 Visualization Site Interval Realtime - Chart Parameter Description Formula Name of the team Used As: Row Segment Team Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type (Sum of Logout Timestamp - Sum of Login Timestamp) The total amount of time the agents were logged in. Staff Hours (Sum of Total Outdial Wrap-up Time + Sum of Total Wrap-up Time + Sum of Total Outdial Connected Time + Sum of Total Available Time + Sum of Total Hold Time) / Staff Hours The measure of time the agents spent on calls compared to available and idle time. Occupancy Sum of Outdial Connected Count + Sum of Available Count Total Calls Total number of calls The total amount of time the agents spent Sum of Idle Duration in the Idle state. Idle Time The total amount of time the agents spent Sum of Available Duration in the Available state. Available Time The total amount of time the agents spent Sum of Ringing Duration in the Reserved state (time duration once the callstartsringing and before the call gets answered). Inbound Reserved Time Inbound Contact Time Time the call landed at the agent's station. Sum of Total Available Time The number of times an agent put an Sum of Total Hold Time inbound caller on hold. Inbound Hold Time Sum of Total Available Time + Sum of Total Hold Time The total amount of time the agents spent in the Connected state. Inbound Connected Time The number of times the agents went into Sum of Total Wrap-up Time the Wrap-up state after an inbound call. Inbound Wrapup Time (Sum of Total Available Time + Sum of Total Hold Time) / Sum of Connected Count The average time agents got connected to inbound calls. Inbound Average Connected Time (Sum of Total Available Time + Sum of Total Hold Time+ Sum of Total Wrap-up Time) / (Sum of Connected Count + Sum of Available Count) The average time agents spent handling calls. Inbound Average Handle Time The total amount of time the agents spent Sum of Not Responding Duration in the Not Responding state. Not Responding Time Customer Journey Analyzer User Guide 56 Visualization Team Interval Realtime Parameter Description Formula The number of times an agent attempted to Sum of Outdial Count make an outdial call. Outdial Attempted Count The number of outdial calls that got Sum of Outdial Connected Count connected to an agent. Outdial Connected Count The number of agents currently in the Sum of Total Outdial Ringing Time Reserved state (time duration once the call starts ringing and before the call gets answered). Outdial Reserved Time The number of agentsin the Connected state Sum of Total Outdial Hold Time who have placed the caller on hold. Outdial Hold Time The number of outdial calls that got Sum of Total Outdial Connected Time connected to an agent. Outdial Connected Time The total amount of time the agents spent Sum of Total Outdial Wrap-up Time in the Wrap-up state after an outbound call. Outdial Wrapup Time Sum of Total Outdial Connected Time / Sum of Outdial Connected Count The average amount of time the agents were in the Outdial Reserved state. Outdial Average Connected Time (Sum of Total Outdial Connected Time + Sum of Total Outdial Wrap-up Time) / (Sum of Outdial Count + Sum of Outdial Connected Count) Outdial Average Handle The average outdial handle time. Time Team Interval Realtime Report-Chart This report represents the number of contact types answered for a team. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Connected Number of answered contact types. Sum of Connected Count Count Team Statistics Realtime This report represents team statistics in a detailed format in real time. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Interval Reports Output Type: Table Parameter Description Formula A group of agents at a specific site who handle a particular type of call. Used As: Row Segment Team Name Customer Journey Analyzer User Guide 57 Visualization Team Interval Realtime Report-Chart Parameter Description Formula The name of an agent, that is, a person who answers customer calls. Used As: Row Segment Agent Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Total Logged In The number of agents currently logged in. Count of Session ID Count of Agent Session ID (Activity State: Idle) The number of times an agent went into the Idle state. Idle Count Count Of Agent Session ID (Activity State: Available) The number of times an agent went into the Available state. Available Count Count Of Agent Session ID (Activity State: Connected) The number of calls currently connected to an agent. Connected Count Count Of Agent Session ID (Activity State: AvailableConsulting, ConnectedConsulting, IdleConsulting, WrapUpConsulting) The number of agents currently consulting with another agent. Consulting Count Count Of Agent Session ID (Activity State: WrapUp) The number of times agents went into the Wrap-up state. Wrapup Count Count Of Agent Session ID (Activity State: NotResponding) The number of times an agent was in the Not Responding state. Not Responded Count Count Of AgentSession ID (Is Outdial >= 1, Activity State: Connected) Outdial Count The number of outdial calls made. Snapshot Report-Agent Agent Realtime This report represents a detailed summary of the agent statistics. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Snapshot Reports Output Type: Table Parameter Description Formula Agent Name Name of the agent Row Segment The media type of the contact, such as Row Segment telephony, email, or chat. Channel Type Total Logged In The total number of times agent logged in. Count of Agent Session ID Customer Journey Analyzer User Guide 58 Visualization Snapshot Report-Agent Parameter Description Formula Count of Agent Session ID (Activity State = Idle) The number of times an agent went into the Idle state. Idle Count Count of Agent Session ID (Activity State = Available) The number of agents currently in the Available state. Available Count Count of Agent Session ID (Activity State = Ringing) The number of times agent currently in the Reserved state (where the incoming call isn’t yet answered). Reserved Count Count of Agent Session ID (Activity State = Connected) The number of calls currently connected to an agent. Connected Count Count of Agent Session ID (Activity State = ConnectedConsulting) The number of times an agent was in the Consulting state. Consulting Count The number of times an agent initiated a Sum of Conference Count conference call. Conferencing Count Count of Agent Session ID (Activity State =WrapUp) The number of times an agent was in the Wrap Up state. Wrap Up Count Count of Agent Session ID (Activity State =NotResponding) The number of times an agent was in the Not Responding state. Not Responding Count Count of Is Outdial (Is Outdial >=1) The number of agents who are connected to or are wrapping up an outdial call. In Outdial Count Agent State - Site Realtime This report represents the agent state team-wise real time. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Snapshot Reports Output Type: Table Parameter Description Formula Name of the site. Used As: Row Segment Site Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Total Logged In The number of agents currently logged in. Count of Agent Session Id Customer Journey Analyzer User Guide 59 Visualization Agent State - Site Realtime Parameter Description Formula Count of Agent Session Id (Activity State = Idle) The number of times an agent went into the Idle state. Idle Count Count of Agent Session Id (Activity State = Available) The number of agents currently in the Available state. Available Count Count of Agent Session Id (Activity State = Ringing) The number of agents currently in the Reserved state (time duration once the call starts ringing and before the call gets answered). Reserved Count Count of Agent Session Id (Activity State = Connected) The number of calls currently connected to an agent. Connected Count Count of Agent Session Id (Activity State = ConnectedConsulting) The number of times an agent was in the Consulting state. Consulting Count The number of times an agent initiated a Sum of Conference Count conference call. Conferencing Count Count of Agent Session Id (Activity State = WrapUp) The number of times an agent was in the Wrap Up state. Wrap Up Count Count of Agent Session Id (Activity State = NotResponding) The number of times an agent was in the Not Responding state. Not Responding Count The number of agents who are connected to or Count of Is Outdial (Is Outdial >=1) are wrapping up an outdial call. In Outdial Count Agent State - Team Realtime This report represents the agent state in real time. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Snapshot Reports Output Type: Table Parameter Description Formula Name of the team. Used As: Row Segment Team Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Total Logged In The number of agents currently logged in. Count of Agent Session Id Count of Agent Session Id (Activity State = Idle) The number of times an agent went into the Idle state. Idle Count Count of Agent Session Id (Activity State = Available) The number of times an agent went into the Available state. Available Count Customer Journey Analyzer User Guide 60 Visualization Agent State - Team Realtime Parameter Description Formula Count of Agent Session Id (Activity State = Ringing) The number of times an agent went into the Inbound Reserved state. Reserved Count Count of Agent Session Id (Activity State = Connected) The number of inbound calls that got connected to an agent. Connected Count Count of Agent Session Id (Activity State = AvailableConsulting, ConnectedConsulting, IdleConsulting, WrapUpConsulting) The total amount of time the agents spent consulting other agents. Consulting Count The number of times an agent initiated a Sum of Conference Count conference call. Conferencing Count Count of Agent Session Id (Activity State =WrapUp) The number of agents currently in the Wrap-up state. Wrap Up Count Count of Agent Session Id (Activity State =NotResponding) The number of agents currently in the Not Responding state. Not Responding Count The number of agents who are connected to Count of Is Outdial (Is Outdial >=1) or are wrapping up an outdial call. In Outdial Count Agent Statistics Realtime This report represents the agents statistics in real time. It captures agent details like the login time, channel type, and so on. Report Path: Stock Reports > Real-Time Reports > Agent Reports > Snapshot Reports Output Type: Table Parameter Description Formula The name of an agent, that is, a Value of Agent Name person who answers customer calls. Agent Name The date and time the agent logged Value of Login Timestamp in. Initial Login Time The media type of the contact, such Value of Channel Type as telephony, email, or chat. Channel Type Channel ID Value of Channel ID The current state of the contact. This Value of Current State field is available only in the CSR and only for real-time visualizations. Current State Current Timestamp - Value of Realtime Update Timestamp The total amount of time the agents spent in any state. Time in State Value of Outdial Connected Count + Value of Connected Count The total number of interactions handled. Calls Handled Customer Journey Analyzer User Guide 61 Visualization Agent Statistics Realtime Parameter Description Formula Value of Outdial Connected Count(Channel Type: chat) + Value of Connected Count(Channel Type: chat) The total number of chat interactions handled. Chats Handled Value of Outdial Connected Count(Channel Type: email) + Value of Connected Count(Channel Type: email) The total number of email interactions handled. Emails Handled Contact Center Overview-Real-Time Average Service Level Card Real-Time This gauge chart shows the percentage of contacts that were handled within configured service level for the queue. Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Chart Contact Details in Queue Real-Time This report provides contact details for contacts broken down by queue. Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Table Parameter Description Formula The media type of the contact,such as telephony, email, or chat. Used As: Row Segment Channel Type Queue Name The Queue that was handled. The total number of agents that Count of Contact Session ID were logged in. # Contacts # Contacts Handled Number of contacts handled. Count of Contact Session ID Number of contacts waiting in Count of Contact Session ID queue. # Contacts Waiting in Queue Average queue wait time of Average of Queue Duration contacts that were in queue Avg Queue Wait Time Longest Contact in Queue Longest queue wait time. Maximum Queue Duration # Abandoned Contacts Number of abandoned contacts. Count of Contact Session ID Longest Contact in Queue Card - Real-Time This report provides the queue name and duration of the contact with the longest queue wait time. Customer Journey Analyzer User Guide 62 Visualization Contact Center Overview-Real-Time Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Report Team Details Real-Time This report provides team details in real-time. Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Table Parameter Description Formula Team Name Name of the team. Agent Name Name of the agent. The total amount of contacts that Count of Agent Session ID were logged in. Total Log In Count Initial Login Time First login time. Minimum Login Timestamp Final Logout Time Last logout time. Maximum Logout Timestamp Staff Hours Total time the agent were logged. Sum of Login Time Idle Counts Total count of idle state. Sum of Idle Count # Contacts Handled Number of contacts handled. Sum of Connected Count # Calls Handled Number of calls that were handled. Voice Connected Count # Chats Handled Number of chatsthat were handled. Chat Outdial Connected Count Number of emails that were Email Connected Count handled. # Emails Handled Total Abandoned Contacts Card Real-Time The report provides the total number of contacts that are Abandoned in real-time. Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Card Multimedia Reports Real-time Interval Report Abandoned - Chart This report represents all abandoned calls that got terminated in real time before reaching a destination site. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Bar Chart Customer Journey Analyzer User Guide 63 Visualization Team Details Real-Time Parameter Description Formula Count of Contact Session ID (Termination Type = abandoned) The number of calls that got abandoned during the report interval. An abandoned call is a call that got terminated before reaching a destination site, but that wasin the system for longer than the time specified by the Short Call threshold provisioned for the enterprise. Abandoned Abandoned Realtime This report represents the number of calls that were in the system before they got abandoned. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Table Parameter Description Formula Interval Time Period Last 7 Days The name of a queue. Used As: Row Segment Queue Name The ID of a queue. Used As: Row Segment Queue ID The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Termination Type = abandoned) / Sum of Contact Count % Abandoned The percentage of calls that were abandoned. Count of Contact Session ID(Termination Type = normal) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls aren’t. Completed Count of Contact Session ID (Termination Type = abandoned) The number of calls that got abandoned during the report interval. An abandoned call is a call that was terminated without being distributed to a destination site, but that wasin the system for longer than the time specified by the Short Call threshold provisioned for the enterprise. Abandoned Sum of Interactions Within Service Level (Termination Type: abandoned) The number of callsthat got terminated while in queue within theService Level threshold provisioned for the queue or skill Abandoned with SL Total The total number of calls from all origination types. Sum of Contact Count Customer Journey Analyzer User Guide 64 Visualization Abandoned Realtime Parameter Description Formula The cumulative amount of time the calls were in Sum of Queue Duration queue, waiting to be sent to an agent or other resource. Because queued time is calculated after the call leaves the queue, the queued time for a call that is still in the queue isn’t reflected in the report. Queued Time Sum of Queue Duration (Is Contact Handled! = 1) The cumulative amount of time between when calls entered the queue and when they got answered (connected to an agent or other resource) during the report interval. Because answered time is calculated after the call is answered, answered time for calls that are waiting to be answered isn’t reflected in the report. Abandoned Time Sum of Queue Duration/ Sum of Queue Count The total amount of time that calls were in queue divided by the total number of calls that were queued. Average Queued Time Sum of Queue Duration(Is Contact Handled! = 1) / Count of Contact Session ID (Termination Type = abandoned) The total amount of time that calls were in the system before they got abandoned divided by the total number of calls that got abandoned. Avg Abandoned Time Entry Point Interval Realtime - Chart This report represent the number of incoming calls. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Count of Contact Session ID Incoming Number of incoming contact types. Incoming, Short, IVR RealTime - Entry point This report represents the number of channel types that were in the IVR. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Table Parameter Description Formula Interval Time Period Last 7 Days Name of entry point. Used As: Row Segment Entry point Name The media type of the contact,such astelephony, email, or chat. Used As: Row Segment Channel Type Incoming Represents an incoming call. Count of Contact Session ID Customer Journey Analyzer User Guide 65 Visualization Entry Point Interval Realtime - Chart Parameter Description Formula Count of Contact Session ID(Termination Type = short_call) The number of calls that were terminated within the Short Call threshold provisioned for the enterprise without being connected to an agent. Short IVR Time The number of calls in the IVR system. Sum of IVR Duration Queue Service Level Realtime This report represents the number of channel types available real time in the queues. A detailed report comprising of abandoned, service level, completed, and other parameters. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Table Parameter Description Formula The name of a queue. Used As: Row Segment Queue Name Interval Time Period Last 7 Days The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type The number of calls that got answered within the (In Service Level) / Total Service Level threshold provisioned for the queue or skill (in a skills interval by queue report), divided by total calls (including abandoned calls). In Service Level % Count of Contact Session ID (Connected Duration > 0) / Count of ContactSession ID (Termination Type = abandoned) + Count of Contact Session ID (Connected Duration > 0) The number of answered calls divided by the number of callsthat entered the queue minusshort calls. % Answered The total number of calls from all origination Sum of Contact Count types. Total Count of Contact Session ID(Termination Type = abandoned) + Count of Contact Session ID (Connected Duration > 0)+Count of ContactSession ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls are not. Completed Count of Contact Session ID (Termination Type = abandoned) The number of callsthat got abandoned during the report interval. An abandoned call is a call that was terminated without being distributed to a destination site, but that was in the system for longer than the time specified by the Short Call threshold provisioned for the enterprise. Abandoned Customer Journey Analyzer User Guide 66 Visualization Queue Service Level Realtime Parameter Description Formula Count of Contact Session ID (Connected Duration > 0) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered The number of times agents initiated a conference Sum of Conference Count call to an agent or external number. Conference Count Hold Count The number of times a caller was put on hold. Sum of Hold Count Sum of Queue Duration (Is Contact Handled ! = 1) / Count of Contact Session ID (Termination Type = abandoned) The total amount of time that calls were in the system before they were abandoned divided by the total number of calls that were abandoned. Avg Abandoned Time Sum of Queue Duration(Connected Duration > 0) / Count of Contact Session ID (Connected Duration > 0) The total answered time divided by the total number of answered calls. Avg Speed of Answer Queue Service Level Realtime - Chart This report represents the number of calls completed in real time. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Connected Duration > 0) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. The count includes answered, abandoned, and disconnected calls. Transferred and short calls aren’t counted. Completed Sites Contact Details Realtime This report represents the number of contacts available in all queues for a site. Output Type: Table Parameter Description Formula Interval Time Period Realtime - 30 mins The name of a queue. Used As: Row Segment Queue Name The name of a site. Used As: Row Segment Site Name The media type of the contact,such astelephony, email, or chat. Used As: Row Segment Channel Type Customer Journey Analyzer User Guide 67 Visualization Queue Service Level Realtime - Chart Parameter Description Formula Count of Contact Session ID (Connected Duration > 0) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = sudden_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls aren’t. Completed Count of Contact Session ID (Termination Type = sudden_disconnect) The number of calls that were answered (that is, connected to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden Disconnect Count Count of Contact Session ID (Connected Duration > 0) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered The number of times agents initiated a conference call Sum of Conference Count to an agent or external number. ConferenceCount Hold Count The number of times a caller was put on hold. Sum of Hold Count Sum of Queue Duration (Connected Duration > 0) The cumulative amount of time between when calls entered the queue and when they were answered (connected to an agent or other resource) during the report interval. Because answered time is calculated after the call is answered, answered time for calls that are waiting to be answered isn’t reflected in the report. Answered Time Sum of Hold Duration + Sum of Connected Duration The time interval between when calls were answered by an agent or other resource and when they were terminated. Because connected time isn’t calculated until the call is terminated, the connected time for a call that is still in progress isn’t reflected in the report. Connected Time Sites Contact Details Realtime - Chart This report represents the site details. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Connected Duration > 0) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. The count includes answered, abandoned, and disconnected calls. Transferred and short calls aren’t included. Completed Team Contact Details Realtime This report represents the agent activities associated with queues, sites, and teams. Customer Journey Analyzer User Guide 68 Visualization Sites Contact Details Realtime - Chart Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Table Parameter Description Formula Interval Time Period Realtime - 30 mins The name of a queue. Used As: Row Segment Queue Name The name of the site. Used As: Row Segment Site Name The name of the team. Used As: Row Segment Team Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Connected Duration > 0) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. Answered, abandoned, and disconnected calls are included in this count. Transferred and short calls aren’t. Completed Count of Contact Session ID (Termination Type = quick_disconnect) The number of callsthat got answered (that is, connected to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Sudden Disconnect Count Count of Contact Session ID (Connected Duration > 0) The number of calls that were routed from the queue to an agent or available resource and were answered by the agent or resource. Answered Hold Count The number of times a caller was put on hold. Sum of Hold Count The number of times agents initiated a conference call Sum of Conference Count to an agent or external number. Conference Count Sum of Queue Duration (Connected Duration > 0) The cumulative amount of time between when calls entered the queue and when they were answered (connected to an agent or other resource) during the report interval. Because answered time is calculated after the call is answered, answered time for calls that are waiting to be answered isn’t reflected in the report. Answered Time Customer Journey Analyzer User Guide 69 Visualization Team Contact Details Realtime Parameter Description Formula Sum of Hold Duration + Sum of Connected Duration The time interval between when calls were answered by an agent or other resource and when they were terminated. Because connected time isn’t calculated until the call is terminated, the connected time for an active call isn’t reflected in the report. Connected Time Team Contact Details Realtime - Chart This report represents the number of calls that got completed at a team level in real time. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Interval Reports Output Type: Bar Chart Parameter Description Formula Count of ContactSession ID (Connected Duration > 0) + Count of Contact Session ID (Termination Type = abandoned) + Count of Contact Session ID (Termination Type = quick_disconnect) The number of calls that ended during the report interval. The count includes answered, abandoned, and disconnected calls. Transferred and short calls aren’t included. Completed Snapshot Entry Point Incoming Realtime - Chart This report represents a snapshot of the number of calls that were terminated without being connected to an agent. Output Type: Bar Chart Parameter Description Formula Incoming Number of incoming contact types. Count of Contact Session ID Snapshot Report Snapshot Entry Point IVR Realtime - Chart This report represents the number of calls currently available in the IVR. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Snapshot Reports Output Type: Bar Chart Parameter Description Formula Count of Contact Session ID (Current State = ivr-connected) The number of callsthat are currently in the IVR system. In IVR Snapshot Entry Point Realtime This report represents snapshot details of calls in an entry point or in a queue. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Snapshot Reports Output Type: Table Customer Journey Analyzer User Guide 70 Visualization Team Contact Details Realtime - Chart Parameter Description Formula The name of the entry point, which is the landing place for customer calls on the Webex Contact Center system. Used As: Row Segment Entry point Name The media type of the contact, such as telephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Current State = ivr-connected) In IVR The number of callsthat are currently in the IVR system. Count of Contact Session ID (Current State = parked) The number of calls currently in the queues that are in the report. In the case of entry-point reports, this number is the number of calls that are currently in queues fed by the entry point. In Queue Count of Contact Session ID (Current State = Connected) Connected The number of calls currently connected to an agent. Snapshot Entry Point Realtime - Chart This report represents a snapshot of the contact type. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Snapshot Reports Output Type: Bar Chart Parameter Description Formula Count of Contact Session ID (Channel Type = telephony and Current State = connected) The media type of the telephony contact. Voice Count of Contact Session ID (Channel Type = chat and Current State = connected) Chat The media type of the chat contact. Count of Contact Session ID (Channel Type = email and Current State = connected Email The media type of the email contact. Snapshot Queue Realtime - Chart This report represents a snapshot of the service-level. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Snapshot Reports Output Type: Bar Chart Parameter Description Formula Count of Contact Session ID (Current State = parked) The number of calls currently in the queues that are in the report. In the case of entry-point reports, this number is the number of calls that are currently in queues fed by the entry point. In Queue Count of Contact Session ID (Current State = connected) Connected The number of calls currently connected to an agent. Customer Journey Analyzer User Guide 71 Visualization Snapshot Entry Point Realtime - Chart Snapshot Queue Service Level Realtime This report represents the service-level at a team, queue, and a site level. Report Path: Stock Reports > Real-Time Reports > Multimedia Reports > Snapshot Reports Output Type: Table Parameter Description Formula Name of the queue. Used As: Row Segment Queue Name Name of the site. Used As: Row Segment Site Name Name of the team. Used As: Row Segment Team Name The media type of the contact,such astelephony, email, or chat. Used As: Row Segment Channel Type Count of Contact Session ID (Current State = parked) The number of calls currently in the queues that are in the report. In the case of entry-point reports, this number is the number of calls that are currently in queues fed by the entry point. In Queue Count of Contact Session ID (Current State = Connected) Connected The number of calls currently connected to an agent. CurrentService Level % = In service level / Total Total= Count of Contact Session ID The percentage of calls in queue that haven’t yet reached theService Level threshold provisioned for the queue Current Service Level % The number of agents who are currently logged in to Count of Agent ID this team or to all teams at this site. At the queue level, this number is the number of agents logged in to all teams at the sites serving this queue. Logged In Agents My Team and Queue Stats - Real-Time Average Handle Time Card Real-Time This report displays the average handled time of each individual channel and for all the channels in real-time. Report Path: Stock Reports > Real-Time Reports > My Team & Queue Stats Output Type: Card My Team Stats Real-Time This report displays the team statistics in real-time. Customer Journey Analyzer User Guide 72 Visualization Snapshot Queue Service Level Realtime Report Path: Stock Reports > Real-Time Reports > My Team & Queue Stats Output Type: Table Parameter Description Formula Team Name Name of the team. Agent Name Name of the agent. Shows the state of the agent such as available, idle, or not responding. Current State # Contacts Handled Number of contacts handled. Count of Contact Session ID Average time taken to handle a Number of Contacts Handled contact. Average Handle Time Average time taken to wrapup a Sum of Wrapup Count contact. Average Wrapup Time Team State Chart Real-Time This pie chart breaks down the number of logged-in agents by current state. Report Path: Stock Reports > Real-Time Reports > Contact Center Overview Output Type: Chart Total Handled Card Real-Time This report displays the total number of contacts that are handled in real-time. Report Path: Stock Reports > Real-Time Reports > My Team & Queue Stats Output Type: Card Drill Down to a Portion of the Visualization After you run a visualization in table format, you can drill down into a specific visualization component to see all the records that were involved in the computation of that portion of the visualization and perform further analytics on the data set. To drill down on a visualization: Procedure Step 1 Click on a table cell and then click icon. • The Drill Down panel displays the records involved in the computation of the visualization. • If you drill down on a session ID (whether it is a contact or agentsession ID), it drills down to the activities composing that session. This is a second drill down applicable only from CSR to CAR and ASR to AAR. Customer Journey Analyzer User Guide 73 Visualization Team State Chart Real-Time Step 2 To add a field or a profile variable, click an entry from the Fields or Measures drop-down list to append a new column. If you select a Field or a Measure that already exists in the table, then it will not append the field again. Note Step 3 To export the data as a Microsoft Excel or CSV file, click Export. Step 4 To view the Drill Down panel in a separate window, click the icon. Modify Visualization Attributes After running a visualization, you can modify its attributes and rerun it: Procedure Step 1 Click Settings. Step 2 To hide or show row and column summaries, select or clear the Hide Summary check box. Note that a visualization typically takes less time to run when Hide Summary is selected. Step 3 If you want the visualization to be updated immediately, choose Redraw instantly. Otherwise, the visualization will be updated only when you click the Apply button. Changes are always rendered immediately when you filter a segment and when you show or hide a profile variable. Note Step 4 To show or hide a profile variable, click the eye icon. Step 5 To hide a segment, drag it to the Hidden Segments box. This capability is not available for compound visualizations. Step 6 To reposition a segment, drag it to a different location either within its current Segments box or to a different Segments box. This capability is not available for compound visualizations. Step 7 To filter a segment: • Select the is in or is not in , and specify the values to include or exclude. For more information, see Filter Using a Field, on page 84 • Select the regular expression to enter an expression to include or exclude. Step 8 If the visualization is a chart, select to modify the visualization. Customer Journey Analyzer User Guide 74 Visualization Modify Visualization Attributes Change the Visualization Output Format Procedure Step 1 Click Settings. Step 2 Select a format from the drop-down list. The possible formats are: Format Description Table Displays data in rows and columns. Displays the cell values within a table in different shades of red. The cells in white and the darkest shade of red identify the outliers. Heat Map Displays the cell values within each row in a table in different shades of red, with the darkest shade identifying the highest values within a row. Row Heat Map Displays the cell values within each column in a table in different shades of red, with the darkest shade identifying the highest values within a column. Column Heat Map Line Chart Compares values as points connected by lines. Bar Chart Compares values displayed as horizontal columns. Area Chart Compares values displayed as shaded areas. Pie Chart Compares values displayed as slices of a circular graph Compares values over time displayed as animated bubbles, lines, or bars. Requires Adobe Flash Player. Motion charts are not available for realtime visualizations Motion Chart Table-based rendering of variations of data displayed in a highly condensed way as miniature charts in table cells, enabling you to spot trends. Sparkline Chart Visualization Creation Overview This chapter describes how to create visualizations using an intuitive drag-and-drop interface. Creating a visualization involves the following steps: Procedure Step 1 Specify the visualization type: • Customer Session Record Customer Journey Analyzer User Guide 75 Visualization Change the Visualization Output Format • Customer Activity Record • Agent Activity Record • Agent Session Record Step 2 Choose a Date Range. Specify the time period that you want the visualization to cover. This constrains the number of records that will be considered during execution of the visualization. Step 3 Define the Compute Interval. The compute interval for a historical report can be either time based or sample based. • For a time-based visualization, select a time interval. • For a sample-based visualization, specify the total number of records to be considered, the frequency (that is, the number of records to be considered in each interval) and the band (that is, the number of records to be considered in each calculation), and whether or not the calculations will be cumulative. Step 4 Define the Segmentation. Specify what you are trying to compare as part of the visualization. It could be comparing the performance of the different agents or entry points. The Analyzer allows segmentation only by fields and not by measures. For example, segmentation by Termination Type or Agent Name is allowed, while segmentation by Call Count is not allowed. Step 5 Define theProfiling Variables. Define the metrics you want to see in the visualization to compare the different segments. Profiling variables are always numeric values and can be created from either fields, measures, or other profiling variables. • Field. Fields can be used to create counts of records that meet specified conditions. For example, you can create a profiling variable that will give the count of records with a Termination Type equal to normal. • Measure. Measures can be used to create summations, averages, or counts. Summations and averages require no additional input. Counts work the same as fields, and thus require conditions to be specified. For example, using Revenue asthe basisfor a profiling variable allows you to create a sum of the Revenue, an average of the Revenue, or a count of records that have a Revenue greater than, less than, or equal to a given amount. • Existing Profile Variable. Profiling variables can be created from other profiling variables using arithmetic formulas. For example, if you already have a profiling variable named Average Revenue containing the average of Revenue and another profiling variable named Handled Calls containing the count of records where Termination Type equals normal, then you can create a profiling variable containing the average revenue per call using Average Revenue divided by Handled Calls. Step 6 Define theFilter. Thisstep further limitsthe population set to include only the recordsthat meet the conditions you specify. Step 7 Define the Output Format. A visualization can be displayed as a table or chart. The chart types currently supported are Bar, Pie, Line, Area, and Motion. Additionally, you can specify display options such as titles, colors, and border widths and styles. Step 8 Define execution schedule or recurrence. Visualizations can be executed on demand,scheduled for a one-time execution, or scheduled to run periodically. Scheduled executions post their results to the specified email recipients using either a web link or CSV file attachment. • Execute now: Use Run from the view page. • Execute once and email: Use Scheduler and define time and email information. Customer Journey Analyzer User Guide 76 Visualization Visualization Creation Overview • Recurrence: Use Scheduler and define recurrence, such as daily at 9:00 AM. Create a Visualization To create a visualization: Procedure Step 1 Select Visualization > Create New > Visualization. The visualization creation page appears. The Modules tab displays two panels that you can expand or collapse by clicking a panel title. Step 2 Select an option from the Type drop-down list. The possible values are: CustomerSession Record, Customer Activity Record, Agent Activity Record, or Agent Session Record. You can add variables and segments to the reports. For more information, see Type of Records Available in Each Repository, on page 95. Step 3 Specify the visualization time period by selecting an option from theStart Time drop-down list in the Modules tab. a) To create a realtime visualization, select Realtime. b) To create a historical visualization, select a predefined date range. c) To specify custom start and end dates, select Custom. • If you selected Realtime, go to Step 7, on page 78. • If you selected Custom, select values from the Start Date and End Date drop-down lists. • If you selected Exact Date, enter a date in the field that appears, or click in the field and then select a date from the calendar controls. • If you selected one of the other options: Day of the Year, Day of the Month, 7 Days, Day of the Week, or Most Recent Day, use the controls that appear to select the options you want. If you specify a lengthy date range, the visualization could take a long time to run. In this case, it might be preferable to schedule the visualization rather than running it in real-time. If the pre-defined date range you want to select is not available in the drop-down list, increase the compute interval. Small compute intervals (such as Hourly) with large date ranges (such as Last Month) result in more data than can be displayed; thus such selections are not allowed. Note Step 4 You can filter the date range by selecting an option from the Including drop-down list. The possible values are: Days of a Week, Days of the Month, Weeks of the Month, or Months of the Year, and then selecting the weekdays, days of the month, weeks, or months you want the visualization to include. Step 5 If you are creating a time-based visualization, select a time interval from the Interval drop-down list in the Compute panel. The possible values are: None, 15 Minutes, 30 Minutes, Hourly, Daily, Weekly, or Monthly. Customer Journey Analyzer User Guide 77 Visualization Create a Visualization The available options vary depending on the length of the date range. Small compute intervals (such as 15 Minutes, 30 Minutes, or Hourly) are not available if the specified date range is lengthy (such as Last Month). Step 6 If you are creating a sample-based visualization, select First or Last from the Records drop-down list in the Compute panel, and in the text box, enter the total number of records to be considered in the visualization. You can also define the following: a) Frequency-The number of records to be considered per interval. b) Band-The number of records to be considered per calculation. c) Cumulative-To calculate the number of records. For more information, see Settings for a Sample-Based Visualization Step 7 If you selected Realtime as the visualization time period, select values from the drop-down lists that become available in the Compute panel. Select None for a snapshot of the current contact center activity. - OR - Select a specific time interval (of 5, 10, 15, or 30 minutes) for a view that looks back from the current moment to the most recent 5, 10, 15, or 30 minutes. - OR - Select Start of Day for a view of everything that happened since midnight. - OR - Select Custom for a view that looks back from the current moment to up to fourteen days in the past. Duration Select a value to specify how often the data in the visualization will be refreshed: minutes for duration of Start of Day and Custom; otherwise, seconds. Refresh Rate IfStart of Day or Custom isspecified asthe Duration, the Interval drop-down list appears, enabling you to select a time interval (None, 15 Minutes, 30 Minutes, or Hourly). Interval If Custom isspecified asthe Duration, the Look Back settings appear. Enter the number of days, hours, and minutes from the current moment you want the visualization to look back to. You can specify up to 14 days. Look Back (D-H-M) Step 8 To specify either Row Segments or Column Segments, click the Add Row Segments or Column Segments icon. Drag and drop a field or an enhanced field listed in the canvas area. Repeat this step for each segment you want to add. For information about enhanced fields, see Create and Share an Enhanced Field. Fields can be added as either Row Segments or Column Segments. For charts, only the first segment is used. Note Customer Journey Analyzer User Guide 78 Visualization Create a Visualization Step 9 To combine multiple values of the segmentation variable into one group, you can create an enhanced field: a) Right-click a value and select Create Enhanced Field. b) Specify the settings for one or more groups in the dialog box that appears. For example, you could create three groups of entry points where each group represents a different product line or a different business unit. For more information, seeCreate and Share an Enhanced Field. Step 10 To create a profile variable: a) Click the Add Profile Variable icon. Drag and drop a field, measure, or formula listed in the New Profile Variable dialog box and do one of the following: • Type a name for the profile variable in the Name text box or leave the default text. This name will be displayed in the column header and axis labels. • If you used a field to create the profile variable, you can specify the records you want included in the count by dragging an item from the Fields list to the Filters area of the New Profile Variable dialog box and selecting the records to include or exclude. For more information, see Filter Using a Field, on page 84If you used a measure to create the profile variable, select the computation you want to perform from the Formula drop-down list. For more information, see Select a Formula for a Measure, on page 83. You can specify a condition for including records by dragging an item from the Fields or Measures list to the Filters area of the dialog box. For more information, see Filter Using a Measure, on page 84. Note You can also create a new formula based on a profile variable that exists in the visualization. Step 11 To specify the format for the profile variable, right-click the profile variable and select a Number Format option from the context menu. For more information, see Format a Profile Variable, on page 87. For example, if you created a Conversion Rate profile variable, you could select Percentage as the format. Step 12 Continue creating as many profile variables as you want. In the following example, three profile variables have been created and the data is segmented under Queue ID and Agent Name header rows. Note If you are creating a motion chart, you must include at least three profile variables. a) To change the order of a profile variable or segment, drag its label to a different position. b) To pivot across column and row segments, drag a segment label from the Column Segments box to the Row or Series Segments box, or vice versa. c) To remove a profile variable or segment, click delete. Note You cannot remove a profile variable used in another profile variable. Step 13 To find out approximately how large the visualization will be when it is run, save the visualization and click More and select Info. Step 14 You can create a filter to limit the number of records the visualization considers by default. To create a filter: a) Click Add Filter in the Modules tab. Select a field or measure from the displayed lists and click Save. - OR - Right-click a segment in the visualization and select Create Filter. b) When the new filter appears in the Modules tab, specify which values to include or exclude or, in the case of a measure, set a condition the data must satisfy. Step 15 Specify a visualization output format. For more information, see Change the Visualization Output Format, on page 75 Customer Journey Analyzer User Guide 79 Visualization Create a Visualization Step 16 If you are creating a compound visualization, add at least one additional module before you save the visualization. Step 17 To save the visualization, click the Save button, and in the dialog box that appears: a) Select the folder. To create a new folder, click New Folder, and enter a name for the folder. b) Enter a name for the visualization and click OK. Step 18 Click Preview to view the visualization. Create a Compound Visualization A compound visualization includes two or more modules that are displayed side by side. All modules within a visualization must have identical row or series segments, column segments, and profile variables, but can have differing date ranges, intervals, and filters. When you create a visualization, you can make it a compound visualization by adding at least one additional module before you save the visualization. After a visualization issaved with only one module, the visualization cannot be edited to have an additional module. However, if you save a visualization with more than one module, you can later delete all but one module, save the visualization, and add more modules later. Compound visualizations cannot be scheduled or exported and do not have pivoting capability in execution mode. Procedure Step 1 To add a module to a visualization: a) At any time during the creation of a visualization, click the button at the top of the Modules tab and in the dialog box that appears, enter a name for the module and click OK. Click the button again for each additional module you want to add. After adding a module, the middle of the visualization creation page displays the constituent visualizations side by side. You can select different date ranges, intervals, and filters for each module. Step 2 To display the settings that can be individualized for each module: a) Select a module from the drop-down list at the top of the Modules tab. Step 3 To change the label at the top of a module: a) Select the label text and type a new label. The drop-down list in the Modules tab reflects the label changes. Customer Journey Analyzer User Guide 80 Visualization Create a Compound Visualization Create a Visualization Displaying Actual Values To display the actual values in the database without aggregation, the visualization cannot include a time interval or segmentation, and all profile variables must be configured with Value of as the formula. Note The Value of option is not available in a visualization that already includes a time interval or segmentation. To create a visualization displaying actual database values without aggregation: 1. Click Visualization > Create New > Visualization. 2. Select a Type. The possible values are: Customer Session Record, Customer Activity Record, Agent Activity Record, or Agent Session Record. 3. Specify the visualization time period. 4. To add a profile variable: • Click the Add Profile Variables , and drag and drop a field or measure in the New Profile Variable dialog box. • In the Formula drop-down list, select the Value. Repeat for each additional profile variable you want to add and then click Save to save the visualization. Then you can click Preview. Create and Share an Enhanced Field While creating or editing a visualization, users can create one or more enhanced fields to combine multiple values of a segmentation variable into one or more groups. When the visualization is run, the values of all the segmentation variables in a group are combined into one row and the profiling variables for that visualization are computed for those segmentation values.For example, you could create groups of entry pointsrepresenting different products lines or geographical regions. After you create an enhanced field, you can make it available in the New Segment dialog box for selection by yourself and other visualization designers. Create an Enhanced Field To create an enhanced field: 1. Right-click a segment in the visualization and select Create Enhanced Field. 2. Specify the settings for the group as described in the following table: Setting Description Click this check box if you want matching to be based on a regular expression as opposed to a straight string match. Regular Expression Customer Journey Analyzer User Guide 81 Visualization Create a Visualization Displaying Actual Values Setting Description Enter a name (for example, Other Entry Points) for the group that will include all the variables not included in the defined groups. Default Group To define a group, enter a name and in the Provide Values: • Select values from the drop-down list. • Type a value and then press Enter. • If the Regular Expression check box is selected, type a regular expression. To define another group, click the Add button. Groups 3. Click Save. Share an Enhanced Field To make an enhanced field available for future use: 1. Click the enhanced field segment that has been added to the visualization and selectSave from the context menu. 2. Enter a name for the enhanced field and click OK. The saved enhanced field will now be listed in the New Segment dialog box for selection when you and other visualization designers create or edit a visualization. Delete a Shared Enhanced Field To delete a shared enhanced field: 1. Click the Add Column Segments or Row or Series Segments box to display the New Segment dialog box. 2. Select the enhanced field you want to delete and click If the enhanced field is not currently in use, it is deleted. Settings for a Sample-Based Visualization When you create a sample-based visualization, you specify the total number of records to be considered as well as the following settings: • Frequency: The number of records to be considered in each interval. • Band: The number of records to be considered in each calculation. Customer Journey Analyzer User Guide 82 Visualization Share an Enhanced Field • Cumulative: Whether or not the calculations are cumulative. For example, suppose the total number of records to be considered is 600, the frequency is 100, and the band is 300. In this case: • If Cumulative is not selected, the first calculation will be for records 1 to 300, the second for records 101 to 400, the third for records 201 to 500, the fourth for records 301 to 600. • If Cumulative is selected, the first calculation will be for records 1 to 300, the second for records 1 to 400, the third for records 1 to 500, and the fourth for records 1 to 600. Select a Formula for a Measure The following table describes the formulas available when you use a measure to create a profile variable. Formula Calculates Average The average value. Sum The total value. The number of values. When you select thisformula, the dialog box displays settings for specifying a condition for including records in the count. For more information, see Filter Using a Measure, on page 84. Count Minimum The smallest value. Maximum The largest value. Value of The actual value in the database without aggregation. The nth root (where n is the count of numeric values within the specified range) of the product of the values. Geometric Mean of The measure of whether the data are peaked or flat relative to a normal distribution. Kurtosis of Median The middle value. Population Variance of Variance of the set of unique values. Skewness of How far the median is from the mean. Standard Deviation of The square root of the variance. Sum of Squares The sum of the squares of the values. The average of the squared differences between each value and the mean value. Variance of Customer Journey Analyzer User Guide 83 Visualization Select a Formula for a Measure Define Filters Filter Using a Field When you run a visualization, the settings panel displays controls for specifying which records to include or exclude from the visualization. These controls are also displayed when you do the following while creating or editing a visualization: • Drag a field into the Filters area of the dialog box that appears when you create or edit a profile variable. • Click the Add Filter button and select a listed field in the dialog box that appears. • Right-click a segment in the visualization and select Create Filter. 1. To specify which field values to include or exclude, do one of the following: • Select the regular expression button, and then enter a regular expression in the text box that appears to specify which values to include or exclude. • Select the is in or is not, then select the values in the list that you want to include or exclude and press Enter, or you can type a name of a value in the text box and press Enter. 2. To filter the list of available values, type one or more characters in the text box. As you type, the values that match your text appear in the list for your selection. You can use * as a wildcard to represent one or more characters. 3. To specify an empty (blank) value, click the button. 4. To remove a specified value, select it and click the button. Filter Using a Measure The Analyzer displays controls for specifying which records to include in or exclude from the visualization based on the value of a measure when you do the following: • Drag a field into the Filters area of the dialog box that appears when you create or edit a profile variable. • Click the Add Filter button in the Modules panel (or, if you are editing a single-module visualization, the Details panel) and select a listed measure in the dialog box that appears. 1. To set a condition for a measure, do one of the following: • To restrict the data to values between a minimum and maximum value, select Between from the Comparator drop-down list, and then enter a minimum and maximum value in the Min and Max text boxes. < less than <= less than or equal to = equal to Customer Journey Analyzer User Guide 84 Visualization Define Filters != not equal to >= greater than or equal to > greater than Note The minimum value is inclusive, but the maximum value is non-inclusive. • To restrict the data based on a single-sided comparison, select an operator from the Comparator drop-down list and enter a value in the Value text box. In the following example, a condition (greater than 0) is applied to a Total Revenue measure to create a Converted profile variable. Create a Formula Based on a Profile Variable You can create a new formula by applying a mathematical formula to an existing profile variable. To create a formula based on an existing profile variable: 1. Right-click a profile variable in the visualization and select New Formula from the context menu. 2. In the New Formula dialog box that appears, enter a name for the profile variable in the Name text box. 3. Select a mathematical symbol: +, –, × or ÷. 4. Do one of the following in the text box to the right of the mathematical symbol: • Type a numeric value. • Select the name of an existing profile variable from the drop-down list. Creating and Using Shared Formulas After you create a profile variable, you can make itsformula available in theFormulas panel for use by yourself and other visualization designers. Create a Shared Formula To create a shared formula: 1. Create a Profile Variable. For more information, see Create a Visualization, on page 77. 2. Right-click the profile variable and select Save. 3. Enter a name for the formula and click OK. The formula is saved in the Formulas panel. Customer Journey Analyzer User Guide 85 Visualization Create a Formula Based on a Profile Variable Edit a Shared Formula To edit a shared formula: 1. Click Add Profile Variables and then double-click the name of a formula listed in the Formulas panel. 2. You can edit the values or add additional Fields and Measures. 3. Click Save. Delete a Shared Formula To delete a shared formula: 1. Click the in the Profile Variables box, and then double-click the name of a formula listed in the Formulas panel. 2. Click delete. If the formula is not currently in use, it is deleted. Create and Format a Visualization Title To create and format a visualization title while creating or editing a visualization: 1. Click the text Click to add title in the visualization canvas and enter a new title. • To edit the title, select it and enter a new title. • In Formatting, select Title from drop-down and enter the title text. 2. To customize the format of the title, select Title from the drop-down list in the Formatting tab to display the formatting options that you can customize, such as border size, style, and color; text alignment and color; margins; padding; and font size, family, style and weight. Format a Table To customize the format of a table: 1. Select Formatting, and then select Table from the drop-down list. 2. Change any of the following options to customize the table format: Option Description Select the background color from the colorselector or enter the HTML (hexadecimal) code for a color. Back Color BorderSize Enter a value in pixels to change the border width. Customer Journey Analyzer User Guide 86 Visualization Edit a Shared Formula Option Description Select a value from the drop-down list to specify the style of the border around the table or select None if you do not want a border around the table. Border Style Border Select the border color from the color selector or enter the HTML code for a color. Color Format a Profile Variable To change a profile variable’s text alignment, number format, or caption: 1. Do one of the following: • Right-click a profile variable to display the context menu. • Select a profile variable from the drop-down list in Formatting to display the number format and caption options in the tab. 2. Change any of the options described in the following table: Option Description To change the caption, click the caption text displayed in the Formatting tab to select it and then enter a different caption. This setting is available only in the Formatting tab. Caption Right-click to specify whether you want the data to be formatted as Integer, Number, Currency, Percentage, Date Time, or Duration, and within that category, specify how you want the data displayed. For example, when you select Percentage, you can select one of the following format options: • ##.##% (12.34%) • ##% (12%) Number Format To change the alignment of the column text, select a value from the drop-down list: Left, Center, or Right. Thissetting is available only from the context menu. Text Align Format a Chart To customize the format of a chart: Customer Journey Analyzer User Guide 87 Visualization Format a Profile Variable 1. Select Formatting > Chart. 2. Change any of the following options to customize the chart format: Option Description Select the background color from the color selector or enter the HTML code for a color. Back Color Enter a value in pixels to change the width of the border around the chart. Border Size Select a value from the drop-down list to specify the style of the border around the chart or select None if you do not want a border. Border Style Select the border color from the color selector or enter the HTML code for a color. Border Color To add a shade pattern to the lines, areas, or bars in a line, area, or bar chart, select the direction of the color gradient from the drop-down list. Gradient Fill To display data values stacked on top of each other in a line, area, or bar chart, select Normal to stack by the data values or Percent to stack by percentages. Stacking Select a value from the drop-down list to specify whether to show or hide axis labels. Axis Labels Select either True or False from the drop-down list to specify whether or not to invert the axes. Invert Axes Select a value from the drop-down list to specify whether to show or hide data labels. Data Labels Select a value from the drop-down list to specify the data label rotation angle: None, 45o, 90o, or -90o. Data Labels Rotation Edit the Visualization Name To edit the visualization name, do one of the following: 1. Click Visualization > > Edit from the context menu. 2. Click Edit Visualization Name and in the Formatting tab, select Visualization from the drop-down list to edit fields. Customer Journey Analyzer User Guide 88 Visualization Edit the Visualization Name CHAPTER 3 Dashboard Dashboard is a combination of reports that is used to visualize on a single screen. You can perform the following tasks in the Dashboard: • Run a Dashboard, on page 89 • View Stock Report Dashboard, on page 90 • Design Dashboards, on page 91 Run a Dashboard To run a dashboard: Ensure the dashboards have at least one visualization.For more information, see Design Dashboards, on page 91. Note 1. Click the Dashboard icon on the navigation bar. 2. Navigate to the dashboard you want to run and click the button and select Run from the context menu. Note You can search for a dashboard by name. 3. To view the visualization, click launch. After the visualization is rendered, click the Setting button to view the Profile Variables and Segments used in the visualization data. Customer Journey Analyzer User Guide 89 View Stock Report Dashboard Business Metrics Abandoned Contacts The Abandoned Contacts Dashboard displays the number of contacts that were Abandoned during a specific period. You can filter the data in the Dashboard according to Interval and Duration as mentioned here: • Deployment Name—Shows all deployment names that are configured on the Webex Control Hub. Note Only applicable for Cloud Connect users. • Interval—Shows intervals, such as 10 Minutes, 30 Minutes, Hourly, Daily, Weekly, and Monthly. • Duration—Shows durations, such as Today, Yesterday, This Week, Last Week, Last 7 days, This Month, Last Month, and This Year. Parameter Description The total number of contactsthat are Abandoned. The number of contacts Abandoned for different channels (Chat & Voice) is also displayed. Contacts can get abandoned in the following scenarios: 1. When in IVR. 2. When in Queue Waiting Time (QWT). 3. When in sequential QWT. 4. When in parallel QWT. Applicable only for UCCX. 5. When an agent does not receive the call. Total Abandoned Contacts The percentage of total contacts that got abandoned in Queue Waiting Time (QWT). For example, in a day total contacts are 1000 and in that 100 contacts were Abandoned, the QWT for these 100 contacts that were Abandoned can fall in the following categories: • 10 calls in less than 1 minute. • 25 calls in the range of 1–5 minutes. • 50 calls in the range of 5–10 minutes. • 15 calls more than 10 minutes. For the above example, the Leading Abandonment Reason shows 65% (looking at maximum period calls that got abandoned) and QWT as more than 5 minutes. Note Leading Abandonment Reason Customer Journey Analyzer User Guide 90 Dashboard View Stock Report Dashboard Parameter Description Total percentage of customers who have contacted back either through voice calls or chat. Call Back / Renewed Chat Rate TheSankey diagram shows at which stage the contact was abandoned. This diagram shows a vertical bar for the different Entry Points, Queues, Wait Time, and Agents. The view depends on the selected Channel Type. Hovering over the stages shows more information, like the number of abandoned contacts and number of contacts that are handled by each agent. Customer Journey The Area chart shows the Trend of contacts that are handled and abandoned for each channel type for the selected duration. Contacts Trend Abandoned Contacts The Donut diagram shows in which stage the contacts got abandoned. By Stage The tabular view displays the details of each abandoned contact for the selected duration. ANI This indicates the caller's phone number that is associated with the caller if it is voice calls and email address if it is chat. DNIS This indicates the agent's phone number that is associated with the agent. First Contact Time This indicates the time when the contact came into the contact center. Abandonment Stage This indicates at which stage the contact got abandoned for example: IVR, in Queue, or at Agent during ringing. Transfers This indicates the number of times a contact has been transferred. Total Wait Time This indicates the time that the contact was in wait before it got abandoned. This includes the IVR / self-service time and the QWT. Repeat Call Time This indicates when a caller returned the call (repeat call) within a specified duration (currently it is one hour). Abandoned Contact Details Design Dashboards Procedure Step 1 Click Dashboard > Create New Dashboard. Customer Journey Analyzer User Guide 91 Dashboard Design Dashboards Step 2 Drag and drop a visualization on to the canvas area. You can add as many visualizations as you want the dashboard to display. Step 3 To reposition a visualization, drag it to a new position. To format a visualization, select the Formatting panel and then select visualization from the drop-down list to modify. • Step 4 To resize a visualization: • Drag the edge or corner to decrease or increase the size. • Select Formatting,select the visualization name from the drop-down list and edit the Widthand Height. Step 5 To remove a visualization from the dashboard, select X. Step 6 To enter a name for your visualization, click Click to add title. To edit the title, enter a new title and click checkmark symbol. Step 7 To format the visualization title, select Formatting and choose the title from the drop-down list in the tab to display the format options you can customize, such as border style, text alignment, and font size, color, and weight. Step 8 To save the dashboard, click Save, and select a folder. To create a new folder, click the New Folder, enter a name for the folder. Enter a name for the dashboard and then click OK Step 9 You can preview the dashboard, click Preview. Step 10 To edit the dashboard name, click the Edit Dashboard Name to select the existing text; then enter a new name and click the Apply button. Customer Journey Analyzer User Guide 92 Dashboard Design Dashboards CHAPTER 4 Variables • Create, Edit, View, and Delete Variables, on page 93 Create, Edit, View, and Delete Variables You can create a variable that consists of an array of values. For example, if you have x number of agents, then you would have to create x copies of a report (one for each agent) with the required data. Instead, you can use variables to create a single report with the required data. You can use these variables while creating profile variables and row segments. To create a new variable: Procedure Step 1 In the navigation bar, click Variables > Create New. Step 2 Enter a name for the variable. Step 3 Select a value from the Associated Column drop-down list. Step 4 Define Values and add a Description. Step 5 Define the Scope of the variable. The scope can be: • User-Variable is defined and used only by the user. • Global-Variable can be used across users. Select Is Value Shared? to share the value of the variable across users. Step 6 Click Save. You can also do the following: • Click the to view, edit, copy, or delete the variable. You can sort the variables on a column and also search for variables. Note Customer Journey Analyzer User Guide 93 Customer Journey Analyzer User Guide 94 Variables Create, Edit, View, and Delete Variables APPENDIX A Type of Records Available in Each Repository The following table describes the type of records aggregated in each customer and agent activity and session repository. Record Type Description Examples • Customer in IVR or queue, talking to agent, on hold • Customer on home page, product page, checkout page Represents an atomic step in the customer workflow Customer Activity Record • Customer call to a call center • Customer visit to a Web site • Customer visits Web site and chats with agent • Customer sends email and agent responds Representsthe customer workflow, consisting of a sequence of customer activities Customer Session Record • Agent idle, available, talking, wrapping up • Agent offline, dialing, talking, entering notes • Agent idle, available, chatting, wrapping up • Agent offline, reading email, responding, wrapping up Represents an atomic step in the agent workflow Agent Activity Record Customer Journey Analyzer User Guide 95 Record Type Description Examples • Agent handles a service call and logs an incident • Agent places an outbound call and sets up a meeting • Agent chats with a customer and answers a question • Agent reads and responds to a customer email Represents the agent workflow, consisting of a sequence of agent activities Agent Session Record • Standard ASR and AAR Fields and Measures, on page 96 • Standard CSR and CAR Fields and Measures, on page 102 Standard ASR and AAR Fields and Measures Agent Session Repository (ASR) The standard fields aggregated in the ASR are described in the following table: Data Type Field or Measure Column Name Description Indicatesif it is an active session or not.Supported values: Measure Integer 0 and 1. 1 indicates active. Is Current Session The amount of time in secondsthat the agent was engaged Measure Long in the activity during the specified compute interval. Activity Span The endpoint (number/e-mail/chat handle) on which the Field String agent receives calls/chats/emails. Agent Endpoint (DN) Agent ID A string that identifies an agent. Field Sting Agent Login Login name with which agent logs into agent desktop. Field String Name of an agent, that is, a person who answers customer Field String calls/chats/emails. Agent Name Agent Session ID A string that identifies an agent’s login session. Field String Agent System ID A string that identifies an agent. Field String Logout Timestamp The timestamp when the agent logged out. Measure Long Login Timestamp The timestamp when the agent logged in. Measure Long The media type of the contact, such as telephony, email, Field String or chat. Channel Type Customer Journey Analyzer User Guide 96 Type of Records Available in Each Repository Standard ASR and AAR Fields and Measures Data Type Field or Measure Column Name Description Session Count Represents number of sessions. Measure Integer Current State The current state of the agent. Field String Historical Update Timestamp Timestamp when the historical process updated record. Measure Long Realtime Update Timestamp Timestamp when the realtime process updated record. Measure Long Reason This field shows the reason for agent logout. Field String The ID assigned to the media channel agent is logged Field String into. Agent Channel ID Site ID The ID assigned to a call center location. Field String Site Name The call center location to which a call was distributed. Field String Site System ID The ID assigned to a call center location. Field String Team ID The ID assigned to a team. Field String A group of agents at a specific site who handle a particular Field String type of call. Team Name Team System ID The ID assigned to a team. Field String How many times was the agent in ringing state in this Measure Integer session (inbound only). Ringing Count Time agent spent in ringing state during entire session Measure Integer (inbound only). Ringing Duration The number of times an agent wasin the Outdial Reserved Measure Integer state, a state indicating that the agent has initiated an outdial call, but the call isn’t connected yet. Outdial Ringing Count The duration an agent was in the Outdial Reserved state, Measure Integer a state indicating that the agent has initiated an outdial call, but the call isn’t connected yet. Outdial Ringing Duration Idle Count The number of times an agent went into an Idle state. Measure Integer Idle Duration The time spent by an agent in an Idle state. Measure Integer Available Count The number of times an agent went into Available state. Measure Integer Available Duration The amount of time an agent spent in an Available state. Measure Integer The number of times an agent was in a Connected state, Measure Integer that is talking to the customer, during this session (inbound only). Connected Count Customer Journey Analyzer User Guide 97 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description The amount of time and agent spent in a Connected state, Measure Long i.e. talking to the customer, during this session (inbound only). Connected Duration The number of times an agent was in a Connected state Measure Integer while in an outdial call. Outdial Connected Count The amount of time and agent spent in a Connected state Measure Long while in an outdial call. Outdial Connected Duration The number of times an agent established a conference Measure Integer call with the caller and another agent (inbound only). Conference Count The amount of time an agent spent in conference with a Measure Integer caller and another agent (inbound only). Conference Duration Number of times an agent established a conference call Measure Integer with the caller and another agent while in an outdial call. Outdial Conference Count The amount of time an agent spent in conference with a Measure Long caller and another agent while in an outdial call. Outdial Conference Duration The number of times agent answered a consult request Measure Integer (inbound calls). Consult Answer Count The total amount of time agentspent answering to consult Measure Long requests (for inbound calls). Consult Answer Duration The number of times agent answered a consult request Measure Integer (outdial calls). Outdial Consult Answer Count The total amount of time agentspent answering to consult Measure Integer requests (outdial calls). Outdial Consult Answer Duration The number of times agent initiated a consult request Measure Integer (inbound calls). Consult Request Count The total amount of time agent spent making consult Measure Integer requests (for inbound calls). Consult Request Duration The number of times agent initiated a consult request Measure Integer (outdial calls). Outdial Consult Request Count The total amount of time agent spent making consult Measure Long requests (outdial calls). Outdial Consult Request Duration The number of times an agent consulted with another Measure Integer agent (inbound only). Consult Count The amount of time an agentspent consulting with another Measure Integer agent while handling a call (inbound only). Consult Duration The number of times an agent consulted with another Measure Integer agent (outdial only). Outdial Consult Count Customer Journey Analyzer User Guide 98 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description The amount of time an agentspent consulting with another Measure Long agent while handling a call (outial only). Outdial Consult Duration The number of times agent answered a consult-to-queue Measure Integer request (inbound calls). CTQ Answer Count The total amount of time agent spent answering Measure Long consult-to-queue requests from an agent (for inbound calls). CTQ Answer Duration The number of times agent answered a consult-to-queue Measure Integer request while handling an outdial call. Outdial CTQ Answer Count Total time agent spent answering consult-to-queue Measure Long requests from an agent while handling an outdial call. Outdial CTQ Answer Duration The number of times agent initiated a consult-to-queue Measure Integer request (inbound). CTQ Request Count The total amount of time agent spent making Measure Long consult-to-queue requests from an agent (for inbound calls). CTQ Request Duration The number of times agent initiated a consult-to-queue Measure Integer request while handling an outdial call. Outdial CTQ Request Count The total amount of time agent spent making Measure Long consult-to-queue requests from an agent while handling an outdial call. Outdial CTQ Request Duration CTQ Count The number of consult-to-queue in a session. Measure Integer The time spent by an agent in a session on Measure Integer consult-to-queue. CTQ Duration Hold Count The number of times calls were put on hold (inbound). Measure Integer Hold Duration The amount of time spent on hold (inbound). Measure Integer Outdial Hold Count The number of times call were put on hold (outdial). Measure Integer Outdial Hold Duration The amount of time during spent on hold (outdial). Measure Integer Number of times agent failed to respond to an incoming Measure Integer request (i.e. the contact couldn’t be connected to the agent). Not Responded Count The amount of time agent spent in a Not responding state Measure Long (inbound). Not Responded Duration Number of times contact couldn’t be connected to the Measure Integer agent while making an outdial request. Outdial Not Responded Count The amount of time agent spent in a Not responding state Measure Long (outdial). Outdial Not Responded Duration Customer Journey Analyzer User Guide 99 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description Wrapup Count The number of agents in the Wrap-up state after a call. Measure Integer The average length of time agents were in the Wrap-up Measure Integer state after a call. Wrapup Duration The number of times agents went into the Wrap-up state Measure Integer after an outdial call. Outdial Wrapup Count The total amount of time agents spent in the Wrap-up Measure Long state after an outdial call. Outdial Wrapup Duration The number of callsthat were answered (that is, connected Measure Integer to an agent or distributed to and accepted by a destination site), but that were then immediately disconnected within the Sudden Disconnect threshold provisioned for the enterprise. Disconnected Count Number of times an agent transferred to another agent Measure Integer (inbound only). Agent To Agent Transfer Count Number of times an agent transferred to another agent Measure Integer (outdial only). Outdial Agent To Agent Transfer Count Number of times an agent requested transfer to queue Measure Integer (inbound only). Agent Transfer To Queue Request Count Number of times an agent requested transfer to queue Measure Integer (outdial only). Outdial Agent Transfer To Queue Request Count The number of times an agent transferred without Measure Integer consulting first. Blind Transfer Count Number of times an agent transferred an outbound call Measure Integer without consulting. Outdial Blind Transfer Count Represents the number of calls agent made (dialed out) Measure Integer during this session. Outdial Count Represents the number of outdial calls agent transferred Measure Integer during this session. Outdial Transfer Count Number of calls that got disconnected while on hold Measure Integer during this agent session. Disconnected Hold Calls Count Agent Activity Repository (AAR) The standard fields aggregated in the AAR are described in the following table: Data Type Field or Measure Column Name Description Flag that indicates whether this is a current activity Measure Integer or not (i.e. activity hasn’t ended). Is Current Activity Customer Journey Analyzer User Guide 100 Type of Records Available in Each Repository Agent Activity Repository (AAR) Data Type Field or Measure Column Name Description The amount of time in seconds that the agent was Measure Long engaged in the activity during the specified compute interval. Activity Span The endpoint (number/e-mail/chat handle) on which Field String the agent receives calls/chats/emails. Agent Endpoint (DN) Agent ID A string that identifies an agent. Field String Login name with which agent logs into agent Field String desktop. Agent Login The name of an agent, that is, a person who answers Field String customer calls/chats/emails. Agent Name Agent Session ID A string that identifies an agent’s login session. Field String Agent System ID A string that identifies an agent. Field String Activity End Timestamp The timestamp when the activity ended. Measure Long A string that identifies the contact session, if Field String engaged in one. Contact Session ID Activity Start Timestamp The timestamp when the activity started. Measure Long The ID assigned to the media channel agent is Field String logged into. Agent Channel ID The media type of the contact, such as telephony, Field String email, or chat. Channel Type Activity Count Represents number of activities. Measure Integer Activity State Represents state of an activity. Field String The amount of time between when the activity Measure Integer started and when the activity ended. Activity Duration Timestamp when the historical process updated Measure Long record. Historical Update Timestamp Idle Code Name The name of the idle code. Field String Idle Code System ID A string that identifies an idle code. Field String Idle Code ID A string that identifies an idle code. Field String Flag that indicates whether this activity was the Measure Integer login activity. Is Login Activity Flag that indicates whether this activity was the Measure Integer logout activity. Possible value: 0 or 1. Is Logout Activity Customer Journey Analyzer User Guide 101 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description Flag that indicates whether this activity occurred Measure Integer while making an outdial call. Is Outdial Queue ID A string that identifies a queue. Field Sting Queue Name A string that identifies the name of a queue. Field Sting Queue System ID A string that identifies a queue. Field Sting Timestamp when the realtime process updated Measure Long record. Realtime Update Timestamp Record Unique ID Unique string that identifies this activity record. Field String Site ID A string that identifies a call center location. Field String The call center location to which a call was Field String distributed. Site Name Site System ID A string that identifies a call center location. Field String Team ID A string that identifies a team. Field String A group of agents at a specific site who handle a Field String particular type of call. Team Name Team System ID A string that identifies a team. Field String Wrapup Code ID A string that identifies a wrap-up code. Field String The wrap-up code that the agent gave for the Field String interaction. Wrapup Code Name Wrapup Code System ID A string that identifies a wrap-up code. Field String Standard CSR and CAR Fields and Measures Customer Session Repository (CSR) The standard fields and measures aggregated in the CSR are described in the following sections: Data Type Field or Measure Column Name Description Flag that indicates whether this is a current session Measure Integer or not (i.e. session hasn’t ended). Is Current Session The amount of time in seconds that the agent was Measure Long engaged in the activity during the specified compute interval. Activity Span Customer Journey Analyzer User Guide 102 Type of Records Available in Each Repository Standard CSR and CAR Fields and Measures Data Type Field or Measure Column Name Description The endpoint (number/e-mail/chat handle) on Field String which the agent receives calls/chats/emails. Agent Endpoint (DN) Agent ID A string that identifies an agent. Field String String identifier for blob that containsrecording of Field String the agent side of the call. Agent Leg Blob ID Login name with which agent logs into agent Field String desktop. Agent Login The name of an agent, that is, a person who answers Field String customer calls/chats/emails. Agent Name Agent Session ID A string that identifies an agent’s login session. Field String Agent System ID A string that identifies an agent. Field String The ANI digits delivered with a call. ANI, or Field String Automatic Number Identification, is a service provided by the phone company that delivers the caller’s phone number along with the call. ANI The number of times a call transferred by the agent Measure Integer to another agent or an external DN without the first agent consulting or conferencing with the party to whom the call was transferred. Blind Transfer Count Contact End Timestamp Timestamp when the contact ended. Measure Long In case of outdial call, thisfield representsthe CPD Field String value returned from telephony. Call Progress Detection Contact Start Timestamp Timestamp when the contact started. Measure Long String identifier for blob that containsrecording of Field String the caller side of the call. Caller Leg Blob ID The number of media channelsto which agents are Field String currently logged in. Channel Type The number of times an agent established a Measure Integer conference call with the caller and another agent. Conference Count The amount of time an agent spent in conference Measure Integer with a caller and another agent. Conference Duration The number of times agentsinitiated a consult with Measure Integer another agent or someone at an external number while handling a call. Consult Count The amount of time an agent spent consulting with Measure Integer another agent while handling a call. Consult Duration Contact Reason Reason the customer is contacting in case of chats. Field String Customer Journey Analyzer User Guide 103 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description Contact Count Represents number of contacts. Measure Integer This is the count of consult-to-queue within an Measure Integer interaction. CTQ Count Total duration spent on consult-to queue within an Measure Integer interaction. CTQ Duration Current State The current state of the contact. Field String Customer Email Address Email address of the customer. Field String Customer Name Name of the customer. Field String Customer Phone Number Phone number of the customer. Field String Recording Deleted The timestamp when the recording was deleted. Measure Long Timestamp Flag that indicates whether the recording has been Measure Integer deleted. Is Recording Deleted The DNIS digits delivered with the call. DNIS, or Field String Dialed Number Identification Service, is a service provided by the phone company that delivers a digit string indicating the number the caller dialed along with the call. DNIS Entrypoint ID The ID assigned to an entry point. Field String The name of the entry point, which is the landing Field String place for customer calls on the Webex Contact Center system. One or more toll-free or dial numbers can be associated with a given entry point. IVR call treatment is performed while a call is in the entry point. Calls are moved from the entry point into a queue and are then distributed to agents. Entrypoint Name Entrypoint System ID The ID assigned to an entry point. Field String Chat Exit Reason Reason to leave the customer chat. Measure String External ID Thisis a reference to the call in an externalsystem. Field String Shows how the call was handled,short, abandoned, Field String normal. Handle Type Flag that indicates whether the contact was handled Measure Integer by an agent. Possible value: 0 or 1. Is Contact Handled Customer Journey Analyzer User Guide 104 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description Timestamp when the historical process updated Measure Long record. Historical Update Timestamp The number of times an agent put an inbound caller Measure Integer on hold. Hold Count Hold Duration The amount of time during which a call on hold. Measure Integer Inbound Transcript Entire chat transcript or inbound e-mail transcript. Field String Flag that indicates whether the call occurred within Measure Integer defined Service Level Threshold. Possible value: 0 or 1. Is Within Service Level IVR Count Number of times the contact was in IVR state. Measure Integer The amount of time during which a call wasin IVR Measure Integer state. IVR Duration LCM Contact LCM Contact details. Field String Chat Note Summarizes customer conversation with an agent. Field String Outbound Transcript Outbound e-mail transcript. Field String Flag that indicates whether this was an outdial Measure Integer contact or not. Possible value: 0 or 1. Is Outdial Previous Agent ID A string that identifies an agent. Field String The name of an agent, that is, a person who answers Field String customer calls. Previous Agent Name The ID of the queue associated with the Field String interactions. Previous Queue ID The name of the queue associated with the Field String interactions. Previous Queue Name Chat Priority Priority for chat. Field String The number of queues contact entered in its Measure Integer entirety. Queue Count The amount of time a contact spent in queue Measure Integer waiting. Queue Duration Queue ID A string that identifies a queue. Field String Customer Journey Analyzer User Guide 105 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description The name of a queue, which is holding place for Field String calls while they await handling by an agent. Calls are moved from an entry point into a queue and are then distributed to agents. Queue Name Queue System ID A string that identifies a queue. Field String Timestamp when the realtime process updated Measure Long record. Realtime Update Timestamp Recording File ID Unique id of the recording file. Field String Recording File Size Represents the size of the recorded file. Measure Long Flag that indicates whether the contact was Field Integer recorded. Is Recorded Contact Session ID A unique string that identifies the contact session. Field String Site ID The ID assigned to a call center location. Field String The call center location to which a call was Field String distributed. Site Name Site System ID The ID assigned to a call center location. Field String String identifier for blob that containsrecording of Field String the call in stereo. Stereo Blob ID The number of times the contact was in connected Measure Integer state (i.e. talking). Connected Count The duration of connected (talking) state within Measure Long this interaction. Connected Duration Team ID The ID assigned to a team. Field String A group of agents at a specific site who handle a Field String particular type of call. Team Name Team System ID The ID assigned to a team. Field String Terminating End Indicates which party terminated the interaction. Field String Termination Type A textstring specifying how a call wasterminated. Field String The number of times a call was transferred by an Measure Integer agent. Transfer Count VQ Far MOS Con Voice Quality Mean Opinion Score at the far end. Measure Double VQ Far Receive Delay Voice Quality Receive Delay at the far end. Measure Integer VQ Far Round Trip Delay Voice Quality Round Trip Delay at the far end. Measure Integer Customer Journey Analyzer User Guide 106 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description VQ Far Total Packet Loss Voice Quality Total Packet Loss at the far end. Measure Double VQ Far Voice Quality Voice Quality Assessment at the far end. Field String Assessment VQ Near MOS Con Voice Quality Mean OpinionScore at the near end. Measure Double VQ Near Receive Delay Voice Quality Receive Delay at the near end. Measure Integer VQ Near Round Trip Delay Voice Quality Round Trip Delay at the near end. Measure Integer VQ Near Total Packet Loss Voice Quality Total Packet Loss at the near end. Measure Double VQ Near Voice Quality Voice Quality Assessment at the near end. Field String Assessment Wrapup Code ID A string that identifies a wrap-up code. Field String The wrap-up code that the agent gave for the Field String interaction. Wrapup Code Name Wrapup Code System ID A string that identifies a wrap-up code. Field String The cumulative amount of time agents spent in the Measure Integer wrap-up state after handling the interactions. Wrapup Duration CSAT Score Represents customer satisfaction score. Measure Integer Chat Reason Reason for contact Field String Chat Question Customer query Field String Bot ID The ID of the bot Field String Bot Name The name of the bot Field String Is Transcript Requested Chat transcript requested by customer Field String Abandonment Reason Reason for abandonment Field String Is Barged In If the call has been monitored. Field Integer Feedback Comment Customer feedback Field String IVR Summary Summary of the number of contacts in the IVR Field String Is Offered Number of contacts Measure Integer Chained In To Entrypoint Calls transferred from one EP to another. Measure Integer Count Transfer In To Entrypoint Calls transferred by agents to EP. Measure Integer Count Customer Journey Analyzer User Guide 107 Type of Records Available in Each Repository Type of Records Available in Each Repository Data Type Field or Measure Column Name Description The number of times call was transferred from an Measure Integer entrypoint to an entrypoint. Entrypoint To Entrypoint Transfer Count The number of times call was transferred from a Measure Integer queue to an entrypoint. Queue To Entrypoint Transfer Count The number of times call was transferred from an Measure Integer agent to an entrypoint. Agent To Entrypoint Transfer Count Chained In To Queue Count Calls moved from EP to Queue. Measure Integer The number of times call was transferred from a Measure Integer queue into another queue. Queue To Queue Transfer Count The number of times call was transferred from an Measure Integer agent into a queue. Agent To Queue Transfer Count Is Monitored Flag indicates whether the call is being monitored. Measure Integer Total Monitoring Count Total number of times this contact was monitored. Measure Integer Number of times the contact was silently Measure Integer monitored. Silent Monitoring Count Full Monitoring Count Entire call monitored. Measure Integer Midcall Monitoring Count Monitoring started midcall. Measure Integer Customer Activity Repository (CAR) The standard fields and measures aggregated in the CAR are described in the following sections: Column Name Description Field or Measure Data Type Flag that indicates Measure Integer whether this is a current activity or not (that is, an activity that hasn’t ended). Is Current Activity The amount of time in Measure Long secondsthat the agent was engaged in the activity during the specified compute interval. Activity Span The endpoint Field String (number/e-mail/chat handle) on which the agent receives calls/chats/emails. Agent Endpoint (DN) Customer Journey Analyzer User Guide 108 Type of Records Available in Each Repository Customer Activity Repository (CAR) Column Name Description Field or Measure Data Type A string that identifies an Field String agent. Agent ID Login name with which Field String agent logs into agent desktop. Agent Login The name of an agent, that Field String is, a person who answers customer calls/chats/emails. Agent Name A string that uniquely Field String identifies an agent’s login session. Agent Session ID A string that identifies an Field String agent. Agent System ID The ANI digits delivered Field String with a call. ANI, or Automatic Number Identification, is a service provided by the phone company that delivers the caller’s phone number along with the call. ANI The timestamp when the Measure Long activity was terminated. Activity End Timestamp A unique string that Field String identifies the contact session. Contact Session ID The timestamp when the Measure Long activity started. Activity Start Timestamp The type of media Field String assigned to a media channel. Channel Type Represents number of Measure Integer activities. Activity Count Represents state of an Field String activity. Activity State The email address of the Field String customer. Customer Email Address Customer Name The name of the customer. Field String Customer Journey Analyzer User Guide 109 Type of Records Available in Each Repository Type of Records Available in Each Repository Column Name Description Field or Measure Data Type The DNISdigits delivered Field String with the call. DNIS, or Dialed Number Identification Service, is a service provided by the phone company that delivers a digit string indicating the number the caller dialed along with the call. DNIS The amount of time Measure Integer between when the activity started and when it was terminated. Activity Duration The ID assigned to an Field String entry point. Entrypoint ID The name of the entry Field String point, which isthe landing place for customer calls on the Webex Contact Center system. One or more toll-free or dial numbers can be associated with a given entry point. IVR call treatment is performed while a call is in the entry point. Calls are moved from the entry point into a queue and are then distributed to agents. Entrypoint Name The ID assigned to an Field String entry point. Entrypoint System ID Timestamp when the Measure Long historical process updated record. Historical Update Timestamp If this isn’t a current Field String activity, this field shows the state of the following activity. Next State Flag that indicates Measure Integer whether this activity occurred while making an outdial call. Possible value: 0 or 1. Is Outdial Customer Journey Analyzer User Guide 110 Type of Records Available in Each Repository Type of Records Available in Each Repository Column Name Description Field or Measure Data Type This is the count of Measure Integer consult-to-queue within an outdial interaction. Outdial CTQ Count This field shows the state Field String of the previous activity. Previous State The ID assigned to a Field String queue. Queue ID The name of a queue, Field String which is holding place for calls while they await handling by an agent. Calls are moved from an entry point into a queue and are then distributed to agents. Queue Name The ID assigned to a Field String queue. Queue System ID Timestamp when the Measure Long realtime process updated record. Realtime Update Timestamp This field is the endpoint Field String of the second agent, for instance in case of transfers. Second Agent Endpoint (DN) This field is the id of the Field String second agent, for instance in case of transfers. Second Agent ID This field is the name of Field String the second agent, for instance in case of transfers. Second Agent Name This is the agent session Field String id of the second agent, for instance in case of transfers. Second Agent Session ID This field is the channel Field String id of the second agent, for instance in case of transfers. Second Channel ID This field shows the Field String second team name. Second Team ID Customer Journey Analyzer User Guide 111 Type of Records Available in Each Repository Type of Records Available in Each Repository Column Name Description Field or Measure Data Type This field shows the Field String second team id. Second Team Name Unique string that Field String identifies this activity record. Record Unique ID The ID assigned to a call Field String center location. Site ID The call center location to Field String which a call was distributed. Site Name The ID assigned to a call Field String center location. Site System ID The ID assigned to a Field String team. Team ID A group of agents at a Field String specific site who handle a particular type of call. Team Name The ID assigned to a Field String team. Team System ID Total duration spent on Measure Integer consult-to queue within an outdial interaction. Total Outdial CTQ Time A string that identifies a Field String wrap-up code. Wrapup Code ID The wrap-up code that the Field String agent gave for the interaction. Wrapup Code Name A string that identifies a Field String wrap-up code. Wrapup Code System ID Customer Journey Analyzer User Guide 112 Type of Records Available in Each Repository Type of Records Available in Each Repository Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) Première publication: 27 Janvier 2020 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. 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. All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version. Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliatesin the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com go trademarks. Third-party trademarks mentioned 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. (1721R) © 2010–2020 Cisco Systems, Inc. Tous droits réservés. T ABLE DES M A TIÈRES PRÉF ACE Préface vii : Historique des modifications vii À propos de ce guide viii Public visé viii Documents connexes viii Communications, services, et informations supplémentaires viii Avis de sécurité exceptionnels ix Remarques concernant la documentation ix Conventions x CHAPITRE 1 Interface du bureau Cisco Finesse 1 Bureau d'agent Finesse 1 Bureau du superviseur Finesse 4 Minuteurs des appels et d'état 6 Comportement du bureau Finesse 7 Basculement du bureau Finesse 7 Un bureau Finesse ou une session Finesse IPPA par agent 8 Prise en charge multiligne 9 Accessibilité 9 CHAPITRE 2 Tâches courantes 17 Paramètres du navigateur pour le poste de travail des agents et superviseurs 18 Se connecter au bureau Cisco Finesse 18 Se connecter au bureau Cisco Finesse en mode Single Sign-On (Authentification unique) 19 Connexion au bureau Finesse en mode Hybride 20 Connexion via IPv6 21 Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) iii Verrouillage du compte après cinq tentatives de connexion infructueuses 21 Connexion en tant qu'agent mobile 22 Accepter les certificats de sécurité 23 Accepter les certificats du gadget Données en direct 26 Déconnexion du bureau Finesse 28 Modifier votre état 28 Modifier votre état pour les canaux vocaux 28 Modifier votre état pour tous les canaux numériques 29 Modifier votre état pour des canaux numériques individuels 29 Afficher une fenêtre contextuelle de notifications des canaux numériques 30 Passer un appel 30 Répondre à un appel 31 Répondre à un appel de prévisualisation d'option d'appel sortant 31 Répondre à un appel sortant de prévisualisation directe 32 Reclasser un appel sortant de prévisualisation directe 32 Planifier un rappel 33 Répondre à un appel de rappel personnel d'option d'appel sortant 33 Lancer un appel de consultation 34 Transférer un appel (transfert en une seule étape) 35 Envoyer DTMF 35 Conversation de bureau 36 Se connecter à une conversation de bureau 37 Ajouter un contact 37 Modification d'un contact 38 Déplacer un contact 38 Supprimer un contact 39 Modification d'un groupe 39 Suppression d'un groupe 39 Fenêtre de conversation 40 Modifier votre état de conversation du bureau 41 Se déconnecter d'une conversation de bureau 42 Appliquer un motif de traitement post-appel 42 Modifier des variables d'appel 43 Forcer le travail post-appel 44 Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) iv Table des matières Afficher Mon historique 44 Affichage de plusieurs vues de rapport de données en temps réel 45 Afficher un message de l'équipe 45 Envoyer le rapport d'erreur 45 Faire glisser-déplacer ou redimensionner un gadget et un composant 46 Faire glisser et déplacer un gadget ou un composant 47 Redimensionner un gadget ou un composant 47 Réinitialiser la mise en page 48 Accéder aux Raccourcis clavier 48 Raccourcis clavier de l'agent 49 CHAPITRE 3 Tâches des superviseurs 53 Afficher les performances de l'équipe 53 Afficher les détails de l'appel actif 54 Afficher l'historique des appels récents 55 Afficher l'historique des états récents 55 Modifier l'état d'un agent 56 Surveiller un appel 57 Intervention sur un appel 57 Intercepter un appel 58 Envoyer des messages d'équipe 58 Raccourcis clavier du superviseur 59 CHAPITRE 4 Tâches de IP Phone Agent 61 Finesse IP Phone Agent 61 Connexion à Finesse sur le téléphone IP 62 Modifier l'état sur le téléphone IP 63 Appliquer un motif Post-appel sur le téléphone IP Phone 64 Déconnexion de Finesse sur le téléphone IP 65 Restauration du service Finesse IP Phone Agent après une panne 65 Configuration du service Finesse et des informations de connexion à l'aide du portail d'aide en libre-service 66 Comportement de Finesse IPPA 67 Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) v Table des matières Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) vi Table des matières Préface • Historique des modifications, à la page vii • À propos de ce guide, à la page viii • Public visé, à la page viii • Documents connexes, à la page viii • Communications, services, et informations supplémentaires, à la page viii • Avis de sécurité exceptionnels, à la page ix • Remarques concernant la documentation, à la page ix • Conventions, à la page x Historique des modifications Ce tableau répertorie les modifications apportées à ce guide. Les modificationsles plusrécentessont affichées en haut du tableau. Modification Voir Date Version initiale du document pour la version 12.5 (1) Ajout d'un message de nouvelle tentative de Se connecter au bureau Cisco Finesse Janvier 2020 connexion Ajout de la modification des variables d'appel Modifier des variables d'appel Faire glisser et déplacer un gadget ou un composant Ajout de Faire glisser et déplacer un gadget ou un composant Redimensionner un gadget ou un composant Ajout de Redimensionner un gadget ou un composant Ajout d'accès à la réinitialisation de la Réinitialiser la mise en page disposition Ajout de l'accès aux Raccourcis clavier Accéder aux Raccourcis clavier Ajout de la liste des raccourcis clavier de Raccourcis clavier de l'agent l'agent Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) vii Modification Voir Date Ajout de l'option de recherche des Afficher les performances de l'équipe performances de l'équipe Ajout de la liste des raccourcis clavier du Raccourcis clavier du superviseur superviseur Toutes les références à http://Nom de domaine complet du serveur Finesse/ sont remplacées par https://Nom de domaine complet du serveur Finesse/ Prise en charge du protocole HTTPS À propos de ce guide Cisco Finesse a fait l'objet d'une actualisation de l'expérience utilisateur dans la version 12.0 (1). Ce guide décrit le nouvel environnement visuel de la présentation du bureau de l'agent et du superviseur, ainsi que les fonctions spécifiques à la version. Le guide de l'utilisateur du bureau Cisco Finesse pour Unified Contact Center Enterprise explique comment utiliser le bureau d'agent et de superviseur. Public visé Ce guide est destiné pour Unified Contact Center Enterprise Unified CCE, aux agents etsuperviseursPackaged Contact Center Enterprise et Hosted Collaboration Solution (HCS) qui utilisent le bureau Finesse. Documents connexes Document ou ressource Lien https://www.cisco.com/en/US/partner/products/ps11324/products_ documentation_roadmaps_list.html Guide de la documentation Cisco Finesse https://www.cisco.com/c/en/us/support/docs/contact-center/finesse/ 214387-configure-snmp-trap-in-cisco-finesse.html Configurer une interruption SNMP dans Cisco Finesse https://www.cisco.com/en/US/partner/products/ps11324/tsd_products_ support_series_home.html Site Cisco.com pour la documentation Finesse Communications, services, et informations supplémentaires • Pour recevoir desinformations pertinentes en temps utile de Cisco, inscrivez-vous à l’adresse Gestionnaire de profil Cisco. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) viii Préface À propos de ce guide • Pour obtenir l’impactsur l’activité que vousrecherchez lestechnologiesimportantes, visitez le site Cisco Services. • Pour soumettre une demande de service, visitez le site d'assistance de Cisco. • Afin d’identifier et parcourir les applications, les produits et solutions et services d’entreprise sécurisés, validés, visitez le site Cisco Marketplace. • Pour obtenir des titres de publications générales de réseautage, de formation et de certification, visitez le site Cisco Press. • Pour rechercher des informations sur la garantie pour un produit spécifique ou la famille de produits, accéder à Cisco Warranty Finder. Outil de recherche de bogues Cisco L'outil de recherche de bogue Cisco (Bug Search Tool, BST) est un outil Web qui sert de passerelle vers le système de suivi des bogues Cisco qui tient à jour une liste complète des défauts et des vulnérabilités des produits et logiciels Cisco. BST vous fournit des informations détaillées sur les défectuosités de vos produits et logiciels. Avis de sécurité exceptionnels Cisco publie des avis de sécurité exceptionnels pour informer les clients et les partenaires des problèmes importants rencontrés dans les produits Cisco qui nécessitent généralement une mise à niveau, une solution de contournement ou toute autre action de l'utilisateur. Pour plus d'informations, voir le résumé des avis de sécurité exceptionnels de produit à l'adresse https://www.cisco.com/c/en/us/support/web/ tsd-products-field-notice-summary.html. Vous pouvez créer des abonnements personnalisés pour les produits Cisco, les séries de produit ou les logiciels pour recevoir des alertes par e-mail ou pour utiliser des flux RSS lorsque de nouvelles annonces sont publiées pour les notes suivantes : • Avis de sécurité Cisco • Avis de sécurité exceptionnels • Fin de vente ou d'assistance • Mises à jour logicielles • Mises à jour des bogues connus Pour plus d'informations sur la création d'abonnements personnalisés, consultez mes notifications à l'adresse https://cway.cisco.com/mynotifications. Remarques concernant la documentation Pour fournir des remarques concernant cette documentation, envoyez un message électronique à l'adresse suivante : contactcenterproducts_docfeedback@cisco.com. Nous apprécions vos commentaires. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) ix Préface Avis de sécurité exceptionnels Conventions Le présent document a recours aux conventions suivantes : Convention Explication Le gras est utilisé pour signaler les commandes, notamment les saisies utilisateur, les touches, les boutons, ainsi que les noms de dossiers et de sous-menus. Par exemple : • Choisissez Édition > Rechercher. • Cliquez sur Terminer. police en gras L'italique est utilisé dans les cas suivants : • Pour signaler un nouveau terme. Exemple : un groupe de compétences est un ensemble d'agents partageant des compétences similaires. • Pour signaler une syntaxe que l’utilisateur doit modifier. Exemple : SI (condition, valeur vraie, valeur fausse) • Pour désigner un titre de manuel. Exemple : consultez le Guide d'installation et de mise à niveau pour Cisco Unified Contact Center Enterprise (UCCE)Guide d'installation et de mise à niveau pour Cisco Unified Contact Center Enterprise (UCCE)Guide d'installation et de mise à niveau pour Cisco Unified Contact Center Enterprise (UCCE). police en italique Les polices Windows, comme Courier, sont utilisées dans les cas suivants : • Texte tel qu’il apparaît dans le code ou dans une fenêtre. Exemple : Cisco Systems, Inc. Police Windows Les crochets obliques sont utilisés dans les cas suivants : • Poursignaler les arguments dont le contexte n'autorise pasl'usage de l'italique, par exemple le format ASCII. • Pour une chaîne de caractères que l’utilisateur saisit mais qui n’apparaît pas dans la fenêtre, par exemple un mot de passe. < > Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) x Préface Conventions CHAPITRE 1 Interface du bureau Cisco Finesse Lorsque vous vous connectez à Cisco Finesse, l'apparence du bureau dépend du fait que votre rôle est celui d'un agent ou d'un superviseur. Les superviseurs ont des fonctionnalités supplémentaires qui apparaissent sur leurs bureaux. La résolution prise en charge du bureau Finesse est de 1366 x 768 ou supérieure. Ce chapitre décrit l'interface du bureau Finesse pour les agents et les superviseurs. Le bureau Finesse est personnalisable. Votre administrateur peut ajouter des gadgets personnalisés sur le bureau ou en modifier l'apparence. Ce guide aborde le bureau Finesse tel qu'il apparaît immédiatement après installation. Remarque Si CiscoFinesse Tomcat est en panne, le bureauFinesse affiche 502 : message d'erreur de passerelle incorrecte. • Bureau d'agent Finesse, à la page 1 • Bureau du superviseur Finesse, à la page 4 • Minuteurs des appels et d'état, à la page 6 • Comportement du bureau Finesse, à la page 7 • Basculement du bureau Finesse, à la page 7 • Un bureau Finesse ou une session Finesse IPPA par agent, à la page 8 • Prise en charge multiligne, à la page 9 • Accessibilité, à la page 9 Bureau d'agent Finesse La figure suivante affiche le bureau d'agent Cisco Finesse tel qu'il apparaît lorsque vous vous connectez pour la première fois. Votre état initial est Non prêt. Illustration 1 : Bureau d'agent Cisco Finesse Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 1 Remarque Cisco Finesse a fait l'objet d'une actualisation de l'expérience utilisateur dans la version 12.0 (1). Après vous être connecté, vous pouvez modifier votre statut en Prêt pour vous rendre disponible pour les appels. Les boutons de la zone de contrôle des appels évoluent en fonction de la situation. Par exemple, les boutons suivants sont disponibles dans les situations décrites : Situation Boutons disponibles Consultation, transfert Direct, attente, pavé numérique et terminer Lorsque vous êtes en communication Quand il y a un appel en attente et que vous êtes sur Conférence, Transfert, Récupération et Terminer un appel de consultation Attente, Consultation, Transfert direct, Clavier et Terminer Lorsque vous êtes en conférence téléphonique Le bureau d'agent Finesse offre les fonctionnalités immédiates suivantes : • Contrôle de base des appels : répondre à des appels, les mettre en attente, les récupérer, les terminer et passer des appels. • Les Notifications d'alerte : notification qui vous informe de tous les appels vocaux lorsque la fenêtre du bureau Finesse ou l'onglet est inactif. • Notifications de bureau : • Pour les appels vocaux entrants : une fenêtre contextuelle avec les détails du client configurés s'affiche avec le bouton de la réponse. • Pour les appels sortants initiés par une campagne : une fenêtre contextuelle avec les détails du client configurés s'affiche avec les boutons Accepter ou Refuser • Contrôle avancé des appels : réaliser un appel de consultation et le transférer ou le transformer en conférence téléphonique après la consultation. • Minuteurs d'état de l'agent et d'appels : le minuteur d'état de l'agent indique la durée à l'état Prêt ou Non prêt. Le minuteur d'appels indique la durée totale des appels, la durée en attente et post-appel. • Transfert en une seule étape : transférer un appel sans devoir d'abord lancer un appel de consultation. • Prévisualisation des appelssortants: prévisualiser l'information client de l'appel avant de choisir d'accepter, de rejeter ou de clore le contact. • Planification d'un rappel : planifier un rappel pour un composeur d'appelssortants pour rappeler un client à un moment plus opportun. • Prévisualisation des appels de rappel sortants personnels : après avoir prévisualisé un appel de rappel personnel, vous pouvez choisir d'accepter ou de rejeter le contact. • Appels sortants de prévisualisation directe : prévisualiser l'information client de l'appel avant de choisir d'accepter, de rejeter ou de clore le contact. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 2 Interface du bureau Cisco Finesse Bureau d'agent Finesse • Reclassement d'un appel sortant de prévisualisation directe : si vous ne parvenez pas à joindre le client, vous pouvez reclasser l'appel en tant que Répondeur, Fax/Modem, Occupé ou Numéro non valide. • Envoi de caractères DTMF : envoie des caractères DTMF pour interagir avec un système IVR. • Codes raison Non prêt et Déconnexion : raisons pour lesquelles vous modifiez votre état en Non prêt ou Déconnexion (votre administrateur définit ces raisons). • MotifsPost-appel : motif du traitementPost-appel de chaque appel (votre administrateur définit les motifs post-appel). • Répertoires téléphoniques : liste des contacts à partir de laquelle vous pouvez sélectionner un appel (votre administrateur définit quels contacts apparaissent dans votre répertoire téléphonique). • Flux de travail : votre administrateur peut définir desflux de travail quisont déclenchés par des événements d'appel et de canaux numériques (par exemple, votre administrateur peut créer un flux de travail qui provoque l'ouverture d'une fenêtre de navigateur sur votre bureau lorsque vous recevez un appel). • Prise en charge de la langue : si votre administrateur a installé des packs de langue Finesse, lorsque vous vous connectez à Finesse, vous pouvez choisir la langue du bureau parmi une liste de langues prises en charge. • Codes de raison système : en raison d'événements générés par le système, votre état peut changer à l'état Non prêt ou Déconnexion utilisant des codes de raison générés par le système. Dans ce cas, l'état de l'agent s'affiche en jaune. • Conversation de bureau : vous pouvez discuter avec d'autres agents,superviseurs, ou avec d'autres experts techniques de l'entreprise. • Passer un appel : vous pouvez passer un appel à partir du clavier de numérotation, en saisissant le numéro ou à l'aide de l'option en un seul clic du répertoire téléphonique. • Message de l'équipe : les équipes peuvent afficher les messages envoyés par leurs superviseurs respectifs et agir en conséquence. La fonctionnalité effectivement disponible dépend de ce que votre administrateur a configuré. Par exemple, si votre administrateur n'a pas défini de motifs Post-appel, vous ne pouvez pas choisir de motif Post-appel. utilise un codage ASCII (8 bits), tandis que Finesse utilise un codage UTF-8 (32 bits), le champ Prénom dans la fenêtre de contrôle des appels est tronqué à seulement 16 caractères. Remarque Gadget des statistiques de file d'attente Finesse Le bureau d'agent Finesse offre également un gadget Statistiques de file d'attente. Le gadget Statistiques de file d'attente affiche des informations sur les files d'attente auxquelles vous êtes affecté. Vous pouvez cliquer sur les en-têtes de colonne pour trier les informations par ordre croissant ou décroissant. Le gadgetStatistiques de file d'attente fournit des informations sur les points suivants : • Nom de la file d'attente : nom de la file d'attente. • Nombre d'appels : nombre d'appels en attente dans la file d'attente. • Durée maximale : durée passée par l'appel le plus ancien dans la file d'attente. • Prêt : nombre d'agents affectés à la file d'attente qui sont à l'état Prêt. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 3 Interface du bureau Cisco Finesse Bureau d'agent Finesse • Non prêt : nombre d'agents affectés à la file d'attente qui sont à l'état Non prêt. • Actif • Entrant : nombre d'agents affectés à la file d'attente qui traitent des appels entrants. • Sortant : nombre d'agents affectés à la file d'attente qui traitent des appels sortants. • Autre : nombre d'agents affectés à la file d'attente qui traitent des appels de consultation interne. • Post-appel • Prêt (En attente) : nombre d'agents affectés à la file d'attente qui passeront à l'état Prêt lorsque le traitement Post-appel sera terminé. • Non prêt (En attente) : nombre d'agents affectés à la file d'attente qui passeront à l'état Non prêt lorsque le traitement Post-appel sera terminé. Pour plus d'informations sur la façon dont le gadget Statistiques de file d'attente collecte et affiche les statistiques, consultez la description du gadget fournie dans Bureau du superviseur Finesse, à la page 4. Bureau du superviseur Finesse La figure suivante affiche le bureau Cisco Finesse du superviseur. Illustration 2 : Bureau du superviseur Finesse Remarque Cisco Finesse a fait l'objet d'une actualisation de l'expérience utilisateur dans la version 12.0 (1). Le bureau du superviseur Finesse fournit des fonctionnalités de contrôle d'appel et les éléments suivants : • Gadget des performances de l'équipe • Gadget des statistiques de file d'attente • Message de l'équipe Pour vous assurer que toutes les fonctions du bureau du superviseur Finesse fonctionnent correctement, vous devez désactiver les bloqueurs de fenêtres contextuelles. Remarque Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 4 Interface du bureau Cisco Finesse Bureau du superviseur Finesse Gadget des performances de l'équipe Sur le Gadget des performances de l'équipe, vous pouvez sélectionner une équipe à partir d'une liste des équipes qui vous sont assignées. Vous pouvez afficher les agents de cette équipe, leur état actuel, la durée dans l'état, leur l'historique des appels récents et historique des états, et leur poste. Cliquez sur les en-têtes de colonne pour trier l'information par Nom d'agent, État, Durée dans l'état, ou Poste. Le champ Durée dans l'état est actualisé toutes les 10 secondes. Lorsque l'état d'un agent change, le serveur Finesse envoie une notification d'état d'agent et le minuteur repasse à 0. Un changement d'état d'agent inclut le passage de Non prêt avec un code raison à Non prêt avec un nouveau code raison. Pour l'agent déconnecté, le champ Duréedansl'état indique la durée totale depuis que l'agent a été déconnecté. Pour l'heure dans l'état déconnecté à afficher, l'agent doit être connecté ou modifié l'état au moins une fois via le bureau Finesse ou via d'autres applications valider le redémarrage du serveur Finesse. Si ce n'est pas le cas, ce champ affiche une valeur vierge. Remarque Le Gadget des performances de l'équipe fournit également les fonctionnalités suivantes : • Surveillance silencieuse : surveiller en silence un appel de l'agent. • Forcer un changement d'état : forcer un agent à l'état Prêt ou Non prêt, ou déconnecter un agent. Lorsque vous surveillez en silence un agent, un bouton Intervention apparaît dans la zone de contrôle des appels. Cliquez sur ce bouton pour intervenir dans un appel entre l'agent et le client. Après être intervenu, vous pouvez choisir d'intercepter l'appel en interrompant l'agent. Comme utilise un codage ASCII (8 bits), tandis que Finesse utilise un codage UTF-8 (32 bits), le champ Prénom dans la fenêtre de performances de l'équipe est tronqué à seulement 16 caractères. Remarque Gadget des statistiques de file d'attente Finesse Le gadget Statistiques de file d'attente affiche une liste des files d'attente dont vous êtes responsable. Cliquez sur les en-têtes de colonne pour trier les informations par ordre croissant ou décroissant. Le gadget Statistiques de file d'attente fournit les colonnes suivantes : • Nom de la file d'attente : nom de la file d'attente. • Nombre d'appels : nombre d'appels en attente dans la file d'attente. • Durée maximale : durée passée par l'appel le plus ancien dans la file d'attente. • Prêt : nombre d'agents affectés à la file d'attente qui sont à l'état Prêt. • Non prêt : nombre d'agents affectés à la file d'attente qui sont à l'état Non prêt. • Actif • Entrant : nombre d'agents affectés à la file d'attente qui traitent des appels entrants. • Sortant : nombre d'agents affectés à la file d'attente qui traitent des appels sortants. • Autre : nombre d'agents affectés à la file d'attente qui traitent des appels de consultation interne. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 5 Interface du bureau Cisco Finesse Bureau du superviseur Finesse • Post-appel • Prêt (En attente) : nombre d'agents affectés à la file d'attente qui passeront à l'état Prêt lorsque le traitement Post-appel sera terminé. • Non prêt (En attente) : nombre d'agents affectés à la file d'attente qui passeront à l'état Non prêt lorsque le traitement Post-appel sera terminé. Les remarques suivantes fournissent des informations supplémentaires sur la façon dont le gadgetStatistiques de file d'attente collecte et affiche les statistiques : • Finesse ne calcule pas les statistiques de file d'attente, mais reçoit à la place les statistiques de file d'attente de . • Finesse n'affiche paslesstatistiques de file d'attente pour la file d'attente par défaut (groupe de compétences par défaut sur ). • La statistique Appels sortants actifs comprend les agents en conversation sur des appels sortants passés par ces agents. Elle inclut également les appels non acheminés passés à des périphériques externes qui ne sont pas surveillés par Unified CM et à des périphériques dans un autre cluster Unified CM. Elle ne comprend pas les agents sur des appels d'options sortants. • Si un agent passe un appel direct au poste d'un autre agent, incrémente la statistique Appelssortants actifs pour la file d'attente par défaut (groupe de compétences). Toutefois,Finesse n'affichant paslesstatistiques de file d'attente pour la file d'attente par défaut, les statistiques Appels sortants actifs ne changent pas pour les files d'attente Finesse auxquelles l'agent est affecté. Message de l'équipe Les superviseurs peuvent diffuser des messages à leurs équipes. Les équipes peuvent afficher les messages envoyés par leurs superviseurs respectifs et prendre les mesures nécessaires. Il s'agit d'une communication unidirectionnelle des superviseurs vers leurs équipes. Minuteurs des appels et d'état Le minuteur d'état de l'agent apparaît à côté de la liste déroulante État de l'agent lorsque vous êtes en état Non prêt ou Prêt et est mis à jour toutes les secondes. Ce compteur est mis à jour toutes les secondes et le format est mn:s. Si vous êtes dans un état depuis plus d'une heure, le format passe à hh:mm:ss (par exemple, 05:25 ou 01:10:25). Lorsque vous changez d'état (par exemple, de Non prêt à Prêt ou changez le code raison à Non prêt), le minuteur est réinitialisé à 00:00. Le bureau Finesse fournit des minuteurs d'appel au moyen du gadget Contrôle des appels (au format mm:ss). Les minuteurs d'appels fournissent les informations suivantes : • Durée totale de l'appel : indique la durée de l'appel en cours. • Temps d'attente : Indique le total des appels sur le temps d'attente. Lorsque vous placez un appel en attente, ce minuteur affiche le temps d'attente, suivi de la durée totale de l'appel entre parenthèses. • Durée post-appel : indique la durée que vous avez passée en état de traitement Post-appel. Si vous devez effectuer un traitement post-appel, vous passez à l'état Post-appel lorsque l'appel est terminé. Selon la Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 6 Interface du bureau Cisco Finesse Minuteurs des appels et d'état configuration effectuée par l'administrateur, le minuteur peut soit compter à rebours, soit compter la durée. Si l'appel dépasse une heure, le minuteur continue à afficher en minutes et secondes. Par exemple, pour 1 heure et 15 secondes, le compteur affiche 60:15. Si le serveur Finesse ne peut pas calculer avec précision la durée de l'état ou la durée d'appel (dans certaines conditions de basculement par exemple), le minuteur affiche « - -:- - ». Remarque Comportement du bureau Finesse Si le bureauFinesse n'est pasla fenêtre active et que l'une des conditionssuivantesse produit, le bureauFinesse devient la fenêtre active ou clignote dans la barre des tâches. • Vous recevez un appel entrant sur le bureau. • Vous êtes déconnecté en raison d'un basculement ou de l'inactivité. • Votre superviseur vous déconnecte. Le comportement du bureau Finesse varie en fonction du navigateur utilisé et du nombre d'onglets ouverts. Ce comportement concerne uniquement les contacts vocaux (appels) et n'est pas applicable aux contacts de conversation ou de messagerie. Remarque Notification d'alerte Si un appel entrant et que la fenêtre ou l'onglet du bureau Finesse est inactif, Finesse affiche une notification contenant les informations sur l'appel. Pour restaurer le bureau Finesse, cliquez sur la notification. Le système d'exploitation contrôle la position de la notification et peut afficher celle-ci dans l'un des quatre angles de l'écran de l'ordinateur. Remarque Microsoft Internet Explorer ne prend pas en charge les notifications d'alerte. Basculement du bureau Finesse Dans un déploiement de centre de contact, Cisco Finesse est installé sur deux nœuds. Si le serveur Finesse sur lequel vous êtes actuellement connecté devient hors-service, une bannière apparaît en haut de l'écran qui vous informe que le bureau a perdu la connexion au serveur. Le bureauFinesse vérifie si l'état du serveur actuelFinesse est restauré, etsi le serveurFinesse de remplacement est disponible. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 7 Interface du bureau Cisco Finesse Comportement du bureau Finesse Si le serveur actuel Finesse est restauré, le bureau est reconnecté. Si le serveur actuel Finesse ne peut être restauré, mais que le serveur de remplacement est disponible, votre bureau est redirigé vers le serveur de remplacement et vous êtes reconnecté automatiquement. Lorsque le bureau bascule ou se reconnecte, si le dernier état sélectionné avant le basculement était Prêt, Finesse tente de conserver cet état. LorsqueFinesse est restauré, le bureau tente d'envoyer une requête destinée à vous remettre à l'état Prêt. Le bureau Finesse ne peut conserver qu'une sélection d'état Prêt qui a été effectuée sur le même bureau. Les exceptions suivantes s'appliquent : • Si vous êtes à l'état Post-appel lorsque le bureau est restauré, Finesse n'envoie pas de requête car cela mettrait fin automatiquement à votre session Post-appel. Après l'expiration de la minuterie Post-appel, votre état est déterminé par Unified Communications Manager et peut dépendre du type de basculement qui s'est produit. • Si vous avez été mis à l'état Non prêt,soit par votre superviseur,soit par le système (par exemple,Sonnerie sans réponse), la sélection d'état Prêt ne sera pas conservée. • Si vous êtes configuré dans le système pour passer automatiquement à l'état Post-appel après chaque appel et achevez un appel alors que le bureau est toujours indisponible, votre sélection d'état Prêt ne pourra pas être conservée. Ils'agit de s'assurer que vous avez le temps de terminer votre sessionPost-appel après la restauration deFinesse suite au basculement. Cela s'applique également si vous avez sélectionné un état d'attente Prêt comme état d'attente qui ne s'applique qu'après la fin du Post-appel. • Les modifications d'état non souhaitées ne sont pas prises en compte. Par exemple, si un superviseur modifie votre état en Prêt (et que vous n'avez pas sélectionné Prêt), votre état Prêt peut ne pas être conservé. Si votre dernière sélection était Prêt et que le système tente de modifier votre état en Non prêt (comme dans le cas de Sonnerie sans réponse), la sélection de Prêt est conservée. Remarque Un bureau Finesse ou une session Finesse IPPA par agent Finesse comporte les limitations suivantes en matière de comportement de session d'agent : • Finesse ne prend pas en charge les agents se connectant au bureau Finesse et Finesse IPPA en même temps. Les agents doivent se connecter au bureau Finesse ou Finesse IPPA. • Finesse peut prendre en charge une combinaison d'agents dans laquelle certains utilisent Finesse IPPA, tandis que d'autres utilisent le bureau Finesse (s'ils disposent de la licence adéquate). • Lorsque des agents sont connectés au bureau Finesse ou à Finesse IPPA, ils peuvent également se connecter simultanément à une application tierce à l'aide de l'API Finesse. (Cette configuration est considérée comme un développement personnalisé. Comme pour d'autres personnalisations Finesse, le client ou le partenaire est responsable du développement et du test corrects de cette configuration personnalisée.) Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 8 Interface du bureau Cisco Finesse Un bureau Finesse ou une session Finesse IPPA par agent Prise en charge multiligne Si le multiligne est configuré, vous pouvez avoir une ou plusieurs lignes secondaires sur votre téléphone. Cependant, Finesse ne publie pas d'informations sur les lignes secondaires sur le bureau Finesse. Accessibilité Le bureau Finesse prend en charge des fonctionnalités améliorant l'accessibilité des utilisateurs malvoyants ou à l'acuité visuelle réduite. Le tableau suivant montre comment naviguer dans le bureau Finesse à l'aide des fonctions d'accessibilité. Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Se déplacer entre la barre d'adresse et les F6 cadres (dans Internet Explorer uniquement) Barre d'adresse Page de connexion Tabulation et Maj.+Tabulation à partir du champ ID Menu déroulant du Accéder au menu déroulant sélecteur de langue Ouvrir le menu déroulant Alt+Flèche vers le bas ou Entrée Faire défiler le menu déroulant Flèches vers le haut et vers le bas Sélectionner une langue Entrée Masquer le menu déroulant Échap Infobulles de l'aide sur Accéder à une infobulle et l'afficher Tabulation et Maj.+Tabulation l'agent mobile Masquer une infobulle Échap Acceptation du Basculer entre les liens de certificat Tabulation et Maj.+Tabulation certificat Ouvrir le lien de certificats pour accepter Entrée le certificat Gadget de contrôle des appels Fenêtre contextuelle Acceptez l'appel entrant Entrée d'appel entrant Accéder au gadget de contrôle des appels, Tabulation et Maj.+Tabulation au répertoire téléphonique et au clavier Navigation dans le gadget de contrôle des appels Ouvrir et fermer le gadget de contrôle des Entrée appels Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 9 Interface du bureau Cisco Finesse Prise en charge multiligne Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Naviguer dans les contacts du répertoire Touches fléchées téléphonique Répertoire téléphonique Sélectionner le contact pour passer un Entrée appel Sélectionner le contact afin de copier le Entrée numéro dans le numéroteur. Basculer entre l'annuaire téléphonique et Onglet, MAJ - onglet, puis entrez le clavier Clavier Touches fléchées, onglet et MAJ - onglet Naviguer entre les boutons du pavé numérique Appuyez sur Entrée dans le champ d'affichage du numéro OU Accédez au bouton Appel et appuyez sur Entrée Passer un nouvel appel, transférer un appel ou effectuer un appel de consultation Menu déroulant Motif Accéder au menu déroulant Tabulation et Maj.+Tabulation de post-appel Ouvrir le menu déroulant Entrée Faire défiler la liste des motifs de Flèches vers le haut et vers le bas post-appel Sélectionner un motif Post-appel Barre d'espace Appliquer un motif de traitement Entrée post-appel Fermer le menu déroulant Échap Boîtes de dialogue Accéder aux boutons Rappel et Reclasser Tabulation et Maj.+Tabulation Rappel et Reclasser (appels sortants) Ouvrir les boîtes de dialogue Rappel et Entrée (sur les boutons respectifs) Reclasser Appuyez sur Échap OU Quitter les boîtes de dialogue à l'aide de la touche de tabulation ou de Maj.+Tabulation Fermer les boîtes de dialogue Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 10 Interface du bureau Cisco Finesse Accessibilité Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Tabulation, Maj.+Tabulation, flèches vers le haut et vers le bas Boîte de dialogue Naviguer dans les éléments Reclasser Sélectionner une option Entrée Fermer la boîte de dialogue Reclasser Échap Calendrier des dates et Accéder au calendrier et le quitter Tabulation et Maj.+Tabulation heures de rappel Naviguer dans le calendrier Flèches Sélectionner une date du calendrier Entrée Accéder aux premiers ou derniers jours Début et Fin d'un mois Fermer le menu contextuel Échap Commandes de date et Naviguer dans les éléments Tabulation et Maj.+Tabulation d'heure de rappel Augmenter et diminuer les valeurs d'heure Flèches vers le haut et vers le bas et de minute Activer/désactiver le bouton AM/PM Entrée Fermer le menu contextuel Échap Conversation de bureau Acceptation du Basculer entre les liens de certificat Tabulation et Maj.+Tabulation certificat Ouvrir le lien de certificats pour accepter Entrée le certificat Ouvrir la liste déroulante pour modifier Entrée l'état Changer d’état Touches fléchées, Tabulation et MAJ-Tabulation Basculer entre les états Appliquer l'état Entrée Rechercherdes contacts Bascule entre les résultats de la recherche Tabulation et Maj.+Tabulation Fermer la liste déroulante de résultats de Échap recherche Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 11 Interface du bureau Cisco Finesse Accessibilité Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Touches fléchées, Tabulation et MAJ-Tabulation Liste des contacts Basculer entre les contacts et les groupes Sélectionner plusieurs contacts Ctrl + flèches Haut et Bas Après avoirsélectionné plusieurs contacts, Tabulation et Maj.+Tabulation accédez aux options Déplacer ou Supprimer Sélectionnez l'option Déplacer ou Entrée Supprimer Nous contacter Accéder aux options d'en-tête de contact Tabulation Options de contact ouvrir un en-tête Entrée Touches fléchées, Tabulation et MAJ-Tabulation Accéder aux options d'en-tête de contact Naviguer parmi les fenêtres Ajouter, Tabulation et Maj.+Tabulation Modifier et Supprimer des contacts Sélectionner une option Entrée Groupe Accéder aux options d'en-tête de groupe Tabulation Ouvrez les options d'en-tête de groupe Entrée Touches fléchées, Tabulation et MAJ-Tabulation Accéder aux options d'en-tête de groupe Naviguer dans les fenêtres Modifier et Tabulation et Maj.+Tabulation Supprimer le groupe Sélectionner une option Entrée Passage d'un onglet de conversation à Tabulation et Maj.+Tabulation l'autre Fenêtrede conversation Sélectionnez l'onglet de conversations Entrée Fermer l'onglet de conversation Entrée Fermer la fenêtre de conversation Entrée Redimensionner la fenêtre de conversation Entrée Réduire ou restaurer la fenêtre de Entrée conversation Message de l'équipe Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 12 Interface du bureau Cisco Finesse Accessibilité Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Tabulation, Maj.+Tabulation, flèches vers le haut et vers le bas Message de l'équipe Naviguer dans les éléments Sélectionner une option Entrée Fermer la boîte de dialogue. Échap Afficher les messages récents Maj+Tab Revenir et supprimer Tab+ Entrée Gadget des statistiques de file d'attente Accédez au gadget des statistiques de file Tabulation et Maj.+Tabulation d'attente Gadget des statistiques de file d'attente Parcourir l'en-tête du tableau Statistiques Tabulation et Maj.+Tabulation de file d'attente Parcourir les cellules du tableau Tabulation et Maj.+Tabulation statistiques de file d'attente Bureau Envoyer le rapport Accéder à une infobulle et l'afficher Tabulation et Maj.+Tabulation d'erreur Masquer une infobulle Échap Pour envoyer le rapport d'erreur Entrée Déconnexion Pour se déconnecter du bureau Finesse Entrée Gadget tiers Accéder à l'icône Maximiser la taille du Tabulation et Maj.+Tabulation gadget Icône Maximiser la taille du gadget Agrandir et restaurer un gadget tiers Entrée Les canaux numériques Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 13 Interface du bureau Cisco Finesse Accessibilité Élément du bureau Pour effectuer les actions suivantes Utilisez les touches suivantes Accéder au gadget de l'état de l'agent canal Tabulation et Maj.+Tabulation numérique État de l'agent Ouvrir et fermer le menu déroulant des Entrée options du gadget. Ouvrir et fermer le menu déroulant des Échap options du gadget. Navigation dans les options de liste Flèches vers le haut et vers le bas déroulante. Sélectionner une option dans la liste Entrée déroulante. Prise en charge d'un lecteur d'écran Cisco Finesse prend également en charge le logiciel de lecture d'écran JAWS pour les éléments suivants : Pour plus d'informationssur la version de JAWSprise en charge, consultez le rapport des modèles d'accessibilité pour les produits volontaires (VPAT) pour le centre de contact à l'adresse https://www.cisco.com/c/en/us/ about/accessibility/voluntary-product-accessibility-templates.html. Page ou gadget Élément Remarques Icône d'aide sur l'agent Le lecteur d'écran lit un texte décrivant l'icône d'aide. mobile Page de connexion Lorsqu'une erreur de connexion se produitsuite à la saisie d'un mot de passe ou d'un nom d'utilisateur non valide, le lecteur d'écran lit l'erreur. Dans Internet Explorer, le message est lu de une à trois fois. Remarque Erreur de connexion non valide Le lecteur d'écran lit le titre du gadget (Statistiques de file d'attente). Gadget des Titre statistiques de file d'attente Le lecteur d'écran lit chaque en-tête de tableau et chaque cellule du tableau. Les valeurs d'une cellule peuvent ne pas être à jour. Pour que le lecteur d'écran puisse lire la valeur la plus récente, passez à une autre cellule, puis revenez à l'ancienne cellule. Remarque Tableau Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 14 Interface du bureau Cisco Finesse Accessibilité Page ou gadget Élément Remarques Le lecteur d'écran lit le contenu du répertoire téléphonique. Remarque • Le lecteur d'écran ne peut pas lire le résumé de ce tableau à l'aide de la combinaison de touches CTRL+INSER+T. Vous pouvez utiliser à la place la touche d'en-tête. • Le répertoire téléphonique ne prend pas en charge l'utilisation de la combinaison de touches CTRL+ALT+Touches de déplacement vers LA DROITE/GAUCHE/LE HAUT/LE BAS pour se déplacer entre les cellules du tableau. • Le lecteur d'écran ne lit pas l'en-tête de chaque colonne dans Internet Explorer 11. Gadgetde contrôledes Répertoire téléphonique appels Le lecteur d'écran lit le nombre du pavé numérique et les lettres qui lui sont associées (ABC, DEF, etc.). Remarque • Dans le résumé du tableau, si vous sélectionnez le tableau, le lecteur d'écran lit le résumé du tableau, qui est Pavé numérique. • Si vous appuyez sur Entrée sur un bouton du pavé numérique lorsque JAWS est activé, les chiffres ne sont pas saisis ou affichés dans la boîte d'édition au dessus du pavé numérique. • Si vous utilisez la combinaison de touches Ctrl+Alt+Touches de déplacement vers la droite, la gauche, le haut et le bas pour vous déplacer entre les cellules, des boutonssupplémentaires sont lus sur le pavé numérique. Clavier Le lecteur d'écran lit les messages d'erreur de ligne d'appel. Erreurs de ligne d'appel Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 15 Interface du bureau Cisco Finesse Accessibilité Page ou gadget Élément Remarques Le lecteur d'écran lit tousles en-têtessur le bureau d'agent (éléments HTML

à ). Bureau d'agent En-têtes Lors du basculement, le lecteur d'écran lit l'instruction située dans la bannière rouge. Une fois le basculement terminé, le lecteur d'écran lit l'instruction située dans la bannière verte. Bannière de basculement Lorsque l'état de l'agent change, le lecteur d'écran lit le nouvel état. Texte de changement d'état Icône d'aide sur l'envoi Le lecteur d'écran lit un texte décrivant l'icône d'aide. de journaux aux clients Bureau Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 16 Interface du bureau Cisco Finesse Accessibilité CHAPITRE 2 Tâches courantes Ce chapitre décrit les tâches courantes que les agents et les superviseurs effectuent. Ces tâches comprennent la connexion au bureau et la déconnexion, la modification de l'état, la sélection des codes raison et des motifs du traitement Post-appel, et les tâches de contrôle des appels. • Paramètres du navigateur pour le poste de travail des agents et superviseurs, à la page 18 • Se connecter au bureau Cisco Finesse, à la page 18 • Connexion en tant qu'agent mobile, à la page 22 • Accepter les certificats de sécurité, à la page 23 • Accepter les certificats du gadget Données en direct, à la page 26 • Déconnexion du bureau Finesse, à la page 28 • Modifier votre état, à la page 28 • Afficher une fenêtre contextuelle de notifications des canaux numériques, à la page 30 • Passer un appel, à la page 30 • Répondre à un appel, à la page 31 • Répondre à un appel de prévisualisation d'option d'appel sortant, à la page 31 • Répondre à un appel sortant de prévisualisation directe, à la page 32 • Reclasser un appel sortant de prévisualisation directe, à la page 32 • Planifier un rappel, à la page 33 • Répondre à un appel de rappel personnel d'option d'appel sortant, à la page 33 • Lancer un appel de consultation, à la page 34 • Transférer un appel (transfert en une seule étape), à la page 35 • Envoyer DTMF, à la page 35 • Conversation de bureau, à la page 36 • Appliquer un motif de traitement post-appel, à la page 42 • Modifier des variables d'appel, à la page 43 • Forcer le travail post-appel, à la page 44 • Afficher Mon historique, à la page 44 • Affichage de plusieurs vues de rapport de données en temps réel, à la page 45 • Afficher un message de l'équipe, à la page 45 • Envoyer le rapport d'erreur, à la page 45 • Faire glisser-déplacer ou redimensionner un gadget et un composant, à la page 46 • Accéder aux Raccourcis clavier, à la page 48 Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 17 Paramètres du navigateur pour le poste de travail des agents et superviseurs Pour vous assurer que toutes les fonctions du poste de travail de l'agent et du superviseur Cisco Finesse fonctionnent correctement, vous devez désactiver les bloqueurs de fenêtres contextuelles des navigateurs pris en charge suivants : • Chrome (version 60 ou ultérieure) Veillez à désactiver la fonctionnalité de rejet automatique des onglets en chrome (version 74 et versions antérieures) pour éviter de quitter l'onglet du poste de travail Cisco Finesse lorsque la mémoire système est faible. Remarque • Firefox (version 52 et versions ultérieures ESR) • Bord (41.16299.15.0 ou ultérieure) • Internet Explorer 11.0 (en mode natif) Outre la désactivation des bloqueurs de fenêtres publicitairesintempestives, pour configurer les paramètres de confidentialité et avancés dans Internet Explorer accédez à Outils > Options Internet > Confidentialité.Saisissez le nom de domaine desserveursFinesse côté A et B, puis cliquez sur Autoriser. Se connecter au bureau Cisco Finesse Procédure Étape 1 Dans la barre d'adresse de votre navigateur, saisissez https://FQDN du serveur Finesse:8445/desktop. où FQDN du serveur Finesse est le nom de domaine complet du serveur Cisco Finesse. Étape 2 Si votre centre de contact a installé un pack linguistique pour Cisco Finesse, un sélecteur de langue apparaît sur le bureau. Dans la liste déroulante du sélecteur de langue, choisissez la langue que vous souhaitez voir apparaître sur le bureau. Cliquez sur Suivant. Vous pouvez également sélectionner une langue en faisant figurer les paramètres régionaux dans le cadre de l'URL (par exemple, https://FQDN du serveur Finesse/desktop?locale=fr_FR)) ou en modifiant les préférences linguistiques de votre navigateur. La langue par défaut est l’anglais (en_US). Si votre centre de contact n'a pas installé de pack linguistique pour Cisco Finesse, la langue locale du bureau est l'anglais uniquement. Remarque Étape 3 Dans le champ Nom d'utilisateur, saisissez votre nom d'utilisateur ou ID d'agent. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 18 Tâches courantes Paramètres du navigateur pour le poste de travail des agents et superviseurs • Les noms d'utilisateur d'agent Cisco Finesse ne peuvent contenir que des caractères ASCII sur 7 bitsimprimables(l'un des 94 caractères numérotés de 33 à 126). Les caractères pris en charge sont : A-Z et 0 à 9,,,-, ! , ~,',$,^,&,(,),",', {,},@,.Les caractères suivants ne sont pas pris en charge, /, \, [,],:,;,|, =,,,+, ,?, <, >. • La page Nom d'utilisateur (connexion au bureau) du déploiement renvoie à AgentID (numéro de périphérique). Pour plus d'informations sur la récupération du numéro de périphérique d'un agent à partir de NomConnexion, reportez-vous au Guide du développeur des services Web Cisco Finesse, à l'adresse https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide. Remarque Étape 4 Saisissez votre mot de passe dans le champ Mot de passe. Étape 5 Dans le champ Numéro de poste, saisissez votre numéro de poste téléphonique. Étape 6 Cliquez sur Connexion. • Le bouton Connexion est activé lorsque vous renseignez les champs de nom d'utilisateur, mot de passe et numéro de poste. Si un champ est incomplet, le bouton Connexion demeure désactivé. • Si la connexion échoue à cause d'erreurs de périphérique, le poste de travail tente automatiquement de se reconnecter. Une alerte s'affiche pour indiquer le nombre de nouvelles tentatives restantes et le temps restant pour la tentative suivante. Remarque Étape 7 Pour modifier la langue quis'affiche sur votre bureau, utilisez le lien Modifier la langue pour revenir à l'écran Sélecteur de langue et choisissez la langue. Vous êtes connecté au bureau Cisco Finesse et votre état est défini à Non prêt. En cliquant sur les options de l'utilisateur dansle coin supérieur droit, votre rôle (agent ou superviseur), nom de l'agent, ID de l'agent, numéro de poste et de téléphone portable s'affichent dans la liste déroulante. Lorsque vous vous connectez au bureau Finesse pour la première fois, vous êtes invité à définir vos préférences pour les notifications. Choisissez de toujours recevoir ou autoriser les notifications d'alerte. Notez que les notifications d'alerte ne s'affichent pas si votre navigateur est défini en mode privé, par exemple avec Nouvelle fenêtre incognito dans Chrome ou Nouvelle fenêtreprivée dans Firefox. Remarque Se connecter au bureau Cisco Finesse en mode Single Sign-On (Authentification unique) Procédure Étape 1 Dans la barre d'adresse de votre navigateur, saisissez https://FQDN du serveur Finesse:8445/desktop. où FQDN du serveur Finesse est le nom de domaine complet du serveur Cisco Finesse. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 19 Tâches courantes Se connecter au bureau Cisco Finesse en mode Single Sign-On (Authentification unique) Étape 2 Si votre centre de contact a installé un pack linguistique pour Cisco Finesse, un sélecteur de langue apparaît sur le bureau. Dans la liste déroulante du sélecteur de langue, choisissez la langue que vous souhaitez voir apparaître sur le bureau. Cliquez sur Suivant. Vous pouvez également sélectionner une langue en faisant figurer les paramètres régionaux dans le cadre de l'URL (par exemple, https://FQDN du serveur Finesse/desktop?locale=fr_FR)) ou en modifiant les préférences linguistiques de votre navigateur. La langue par défaut est l’anglais (en_US). Si votre centre de contact n'a pas installé de pack linguistique pour Cisco Finesse, la langue locale du bureau est l'anglais uniquement. Remarque Étape 3 Sur a page suivante, saisissez vos nom d'utilisateur et mot de passe, puis cliquez sur Connexion. Si la connexion échoue à cause d'erreurs de périphérique, le poste de travail tente automatiquement de se reconnecter. Une alerte s'affiche pour indiquer le nombre de nouvelles tentatives restantes et le temps restant pour la tentative suivante. Remarque Étape 4 Dans le champ Poste, saisissez votre poste et cliquez sur Envoyer. Étape 5 Pour modifier la langue qui s'affiche sur votre bureau, cliquez sur le lien Modifier la langue pour revenir à l'écran Sélecteur de langue et choisissez la langue. Vous êtes connecté au bureau Cisco Finesse et votre état est défini à Non prêt. En cliquant sur les options de l'utilisateur dansle coin supérieur droit, votre rôle (agent ou superviseur), nom de l'agent, ID de l'agent, numéro de poste et de téléphone portable s'affichent dans la liste déroulante. Lorsque vous vous connectez pour la première fois, vous êtes invité à définir votre préférence concernant les notifications. Sur la page de connexion, le champ Nom d'utilisateur est automatiquement rempli et désactivé. Choisissez de toujours recevoir ou autoriser les notifications d'alerte. Notez que les notifications d'alerte ne s'affichent pas si votre navigateur est défini en mode privé, par exemple avec Nouvelle fenêtre incognito dans Chrome ou Nouvelle fenêtreprivée dans Firefox. Remarque Connexion au bureau Finesse en mode Hybride Procédure Étape 1 Dans la barre d'adresse de votre navigateur, entrez https://nom de domaine complet du serveur Finesse:8445/finext-desktop. où FQDN du serveur Finesse est le nom de domaine complet du serveur Finesse. Étape 2 Si votre centre de contact a installé un pack linguistique pourFinesse, un écran de sélecteurde langue apparaît sur le bureau. Dans la liste déroulante du sélecteur de langue, choisissez la langue que vous souhaitez voir apparaître sur le bureau et cliquez sur Suivant. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 20 Tâches courantes Connexion au bureau Finesse en mode Hybride Vous pouvez également sélectionner une langue en faisant figurer les paramètres régionaux dans le cadre de l'URL (par exemple, https://Nom de domaine complet du serveur Finesse/desktop?locale=fr_FR)) ou en modifiant les préférences linguistiques de votre navigateur. La langue par défaut est l’anglais (en_US). Si votre centre de contact n'a pas installé de pack linguistique pour Finesse, la langue locale du bureau est l'anglais uniquement. Remarque Étape 3 Sur la page de connexion, entrez votre Nom d'utilisateur et cliquez sur Suivant. Étape 4 Si l'agent est en mode SSO, la page de connexion Finesse s'affiche. Entrez votre Numéro de poste et cliquez sur Envoyer. Si l'agent est en Mode Non SSO, saisissez votre Mot de passe et Numéro de poste. Cliquez sur Connexion. Si la connexion échoue à cause d'erreurs de périphérique, le poste de travail tente automatiquement de se reconnecter. Une alerte s'affiche pour indiquer le nombre de nouvelles tentatives restantes et le temps restant pour la tentative suivante. Remarque Étape 5 Pour modifier la langue qui s'affiche sur votre bureau, cliquez sur le lien Modifier la langue pour revenir à l'écran Sélecteur de langue et choisissez la langue. Vous êtes connecté au bureau Cisco Finesse et votre état est défini à Non prêt. En cliquant sur les options de l'utilisateur dansle coin supérieur droit, votre rôle (agent ou superviseur), nom de l'agent, ID de l'agent, numéro de poste et de téléphone portable s'affichent dans la liste déroulante. Les utilisateurs en mode Hybride qui n'ont pas de connexion unique (SSO) activée peuvent se connecter avec un nom d'utilisateur différent en cliquant sur le lien Se connecter avec un nom d'utilisateur différent. Une page de connexion s'ouvre alors, qui vous permet d'entrer vos informations de connexion. Remarque Lorsque vous vous connectez pour la première fois, vous êtes invité à définir votre préférence concernant les notifications. Choisissez de toujours recevoir ou autoriser les notifications d'alerte. Notez que les notifications ne s'affichent passi votre navigateur est défini en mode privé, par exemple avec Nouvelle fenêtre incognito dans Chrome ou Nouvelle fenêtre privée dans Firefox. Remarque Connexion via IPv6 Si l'administrateur vous le demande, vous pouvez vous connecter àFinesse à l'aide d'un client IPv6 seul. Dans ce cas, incluez le port approprié dans l'URL de connexion à l'étape 1 de la procédure précédente. • Pour un accès sécurisé à l'aide de HTTPS, entrez : https://:8445/desktop Les étapes restantes de la procédure de connexion demeurent identiques pour IPv6. Verrouillage du compte après cinq tentatives de connexion infructueuses Si vous tentez de vous connecter à Finesse cinq fois de suite avec un mot de passe erroné, Finesse bloque l'accès à votre compte pendant cinq minutes. Pour des raisons de sécurité, si vous tentez de vous connecter à Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 21 Tâches courantes Connexion via IPv6 nouveau pendant ce délai, Finesse ne vous informe pas que votre compte est verrouillé. Vous devez patienter cinq minutes avant de réessayer. N'essayez pas de vous reconnecter lorsque votre compte est verrouillé, sous peine de remettre à zéro le minuteur de verrouillage et de devoir à nouveau patienter cinq minutes supplémentaires. Cette restriction s'applique quel que soit le mode de connexion, sur le bureau, en tant qu'agent mobile ou à l'aide de Finesse IP Phone Agent (IPPA). Connexion en tant qu'agent mobile Lorsque vous vous connectez en tant qu'agent mobile, vous pouvez utiliser n'importe quel téléphone (téléphone fixe ou téléphone mobile) accessible du système téléphonique du centre de contact pour recevoir des appels. Pour obtenir plus d'informations sur l'utilisation de la fonction d'agent mobile, consultez le Guide des fonctionnalités Unified Contact Center Enterprise . Procédure Étape 1 Dans la barre d'adresse de votre navigateur, saisissez https://FQDN du serveur Finesse/. où FQDN du serveur Finesse est le nom de domaine complet du serveur Finesse. Étape 2 Dans les champs ID, Mot de passe, et Poste, saisissez votre nom d'utilisateur ou ID de l'agent, mot de passe et numéro de poste. Dans le cas d'un agent mobile, le poste représente votre poste virtuel, également connu sous le nom de port CTI local (LPC). Étape 3 Cochez la case Se connecter en tant qu'agent mobile. Étape 4 Les champs Mode et Numéro d'appel apparaissent. Dans la liste déroulante Mode, choisissez le mode que vous souhaitez utiliser. Exemple : En mode Appel par appel, votre numéro de téléphone est composé pour chaque appel entrant et déconnecté lorsque l'appel se termine. En mode de Connexion dédiée votre téléphone est appelé lorsque vous vous connectez et la ligne reste connectée tout au long des différents appels des clients. Étape 5 Dans le champ Numéro d'appel, saisissez votre numéro de téléphone et cliquez sur Connexion. Si la connexion échoue à cause d'erreurs de périphérique, le poste de travail tente automatiquement de se reconnecter. Une alerte s'affiche pour indiquer le nombre de nouvelles tentatives restantes et le temps restant pour la tentative suivante. Remarque En mode de connexion dédiée, le bureau doit recevoir et répondre à un appel de configuration avant que la connexion ne soit complète. Vous êtes connecté au bureau Cisco Finesse et votre état est défini à Non prêt. En cliquant sur les options de l'utilisateur dansle coin supérieur droit, votre rôle (agent ou superviseur), nom de l'agent, ID de l'agent, numéro de poste et de téléphone portable s'affichent dans la liste déroulante. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 22 Tâches courantes Connexion en tant qu'agent mobile Lorsque vous cochez la case Se connecter en tant qu'agent mobile et choisissez un mode (Appel par appel ou Connexion dédiée), Finesse stocke un cookie dans votre navigateur qui permet à ce dernier de se souvenir de ces sélections. Lorsque vous accédez de nouveau à la page de connexion, la case à cocher Se connecter en tant qu'agent mobile et le mode sont déjà . Ces sélections sont conservées après plusieurs connexions, redémarrages du navigateur, et scénarios de basculement. Toutefois,si vous accédez directement à un autre serveurFinesse et ne vous êtes pas déjà connecté à ce dernier comme agent mobile, vous devrez effectuer à nouveau ces sélections. Accepter les certificats de sécurité La première fois que vous vous connectez au bureauFinesse, vous pouvez être invité à accepter des certificats de sécurité avant de pouvoir continuer. Sauf si les certificats sont supprimés, vous ne devriez avoir besoin de les accepter qu'une seule fois. Ces certificats permettent au bureauFinesse de communiquer via une connexion sécurisée avec le serveur Finesse. Vous devez vous assurer que les fenêtres contextuelles sont autorisées sur le bureau Finesse. Si vous utilisez un client Windows, connectez-vous en tant qu'utilisateur Windows, et à l'aide d'Internet Explorer vous devez exécuter ce dernier en tant qu'administrateur pour installer ces certificats de sécurité. Dans le menu Démarrer, cliquez à droite sur Internet Explorer et sélectionnez Exécuter en tant qu'administrateur. Contactez votre administrateur si vous n'avez pas les permissions nécessaires pour installer les certificats de sécurité. Remarque Procédure Étape 1 Saisissez l'URL du bureau Finesse dans votre navigateur. Étape 2 Si vous utilisez Internet Explorer : a) Une page s'affiche pour indiquer que le certificat de sécurité du site Web pose problème. Cliquez sur Poursuivre sur ce site Web (non recommandé) pour ouvrir la page de connexion Finesse. b) Entrez votre ID de l'agent ou nom d'utilisateur, votre mot de passe, et numéro de poste, puis cliquez sur Connexion. c) Dans la boîte de dialogue Certificat SSL non accepté, cliquez sur le lien du certificat. Un nouvel onglet de navigateur s'ouvre pour chaque certificat que vous devez accepter. Une erreur de certificat apparaît dans la barre d'adresse. d) Pour ouvrir la boîte de dialogue Certificat, cliquez sur Erreurs de certificat > Afficher les certificats. e) Dansla boîte de dialogue Certificat, cliquez surInstalleruncertificat pour ouvrir l'Assistant Importation de certificat. Si vous utilisez Internet Explorer 11, l'option Installation de certificat n'apparaît pas jusqu'à ce que vous ajoutiez Finesse à vos sites de confiance. 1. Dans le menu du navigateur, sélectionnez Options Internet. 2. Sur l'onglet Sécurité, cliquez sur Sites de confiance > Sites. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 23 Tâches courantes Accepter les certificats de sécurité 3. Dans le champ Ajouter ce site Web à la zone, entrez l'URL du bureau Finesse et cliquez sur Ajouter. 4. Après avoir cliqué sur Installer le certificat, sous Emplacement du magasin, sélectionnez Utilisateur actuel pour installer le certificat pour l'utilisateur actuel uniquement, ou sélectionnez Machine locale pour installer le certificat pour tous les utilisateurs de Windows qui utilisent cet ordinateur. Si vous sélectionnez Machine locale, une boîte de dialogue s'affiche vous demandant si vous souhaitez autoriser le processus hôte Windows à apporter des modifications à cet ordinateur. Sélectionnez Oui. f) Dans l'assistant Importation de certificat, cliquez sur Suivant. g) Sélectionnez Placer tous les certificats dans le magasin suivant, puis cliquez sur Naviguer. h) Sélectionnez Autorités de certification racines de confiance, puis cliquez sur OK. i) Cliquez sur Suivant. j) Cliquez sur Terminer. k) Dans la boîte de dialogue Avertissement de sécurité, cliquez sur Oui pour installer le certificat. l) Cliquez sur OK dans la boîte de dialogue Importation de certificat. m) Cliquez sur OK pour fermer la boîte de dialogue cCertificat. n) Fermez l'onglet du navigateur. Le lien de certificat accepté estsupprimé de la boîte de dialogue Certificat SSL non accepté. Répétez les étapes précédentes pour tous les liens de certificat. Après avoir accepté tous les certificats, le processus de connexion s'achève. Remarque Pour supprimer l'erreur de certificat du bureau, vous devez fermer et rouvrir votre navigateur. Étape 3 Si vous utilisez Edge : a) Une page s'affiche indiquant que le site n'est pas sécurisé. Cliquez sur Détails > Poursuivre sur ce site Web (non recommandé) pour ouvrir la page de connexion Finesse. b) Entrez votre ID de l'agent ou nom d'utilisateur, votre mot de passe, et numéro de poste, puis cliquez sur Connexion. c) Dans la boîte de dialogue Certificat SSL non accepté, cliquez sur le lien du certificat. Un nouvel onglet de navigateur s'ouvre pour chaque certificat que vous devez accepter. Une erreur de certificat apparaît dans la barre d'adresse. d) Pour ouvrir lesinformationssur le certificat, cliquez sur Erreursde certificat > Afficher les certificats. e) Dans la colonne informations sur le certificat , cliquez sur Exporter dans un fichier, naviguez vers n'importe quel emplacement sur votre ordinateur et enregistrez le certificat. f) À partir de Démarrer, recherchez et ouvrez l'outil Gérer les certificats d'utilisateur. g) Dans Gérer les certificats d'utilisateur, sous Certificats - ordinateur local, effectuez un clic droit sur Autorités de Certification racine de confiance et cliquez sur Toutes les tâches > Importation. h) Dans l'assistant Importation de certificat, cliquez sur Suivant. i) Cliquez sur Parcourir, naviguez jusqu'à l'emplacement où vous aviez exporté le certificat etsélectionnez le certificat, puis cliquez sur Ouvrir. j) Dans l'assistant Importation de certificat, cliquez sur Suivant > Suivant > Terminer. k) Cliquez sur OK, dans la boîte de dialogue Assistant d'importation de certificat. l) Fermez l'onglet du navigateur. Le lien de certificat accepté estsupprimé de la boîte de dialogue Certificat SSL non accepté. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 24 Tâches courantes Accepter les certificats de sécurité Répétez les étapes précédentes pour tous les liens de certificat. Après avoir accepté tous les certificats, le processus de connexion s'achève. Pour supprimer l'erreur de certificat du bureau, vous devez fermer et rouvrir votre navigateur. Si voussouhaitez ajouter un nom de domaine completFinesse aux sites de confiance de Edge : 1. Ouvrez le Panneau de configuration. 2. Recherche et ouvrez Options Internet. 3. Suivez l'étape e d' Accepter les certificats dans Internet Explorer. Remarque Étape 4 Si vous utilisez Firefox : a) Sur la page Votre connexion n'est pas sécurisée, cliquez sur Avancé > Ajouter une exception. Important Assurez-vous que la case Stocker de façon permanente cette exception est cochée. b) Cliquez sur Confirmer l'exception de sécurité. c) Entrez votre ID de l'agent ou nom d'utilisateur, votre mot de passe, et numéro de poste, puis cliquez sur Connexion. d) Dans la boîte de dialogue Certificat SSL non accepté, cliquez sur le lien du certificat. Un nouvel onglet de navigateur s'ouvre pour chaque certificat que vous devez accepter. e) Sur chaque onglet, cliquez sur Je comprends les risques > Ajouter une exception. f) Assurez-vous que la case Stocker de façon permanente cette exception est cochée. g) Cliquez sur Confirmer l'exception de sécurité. L'onglet du navigateur se ferme une fois que vous acceptez le certificat et le lien de certificat accepté est supprimé de la boîte de dialogue Certificat SSL non accepté. Fermez l'onglet du navigateur s'il ne se ferme pas automatiquement. Répétez les étapes précédentes pour tous les liens de certificat. Après avoir accepté tous les certificats, le processus de connexion s'achève. Étape 5 Si vous utilisez Chrome : a) Une page apparaît qui indique que votre connexion n'est pas privée. Cliquez sur Avancé > PoursuivreFQDN Finesse pour ouvrir la page de connexion Finesse. b) Entrez votre ID d'agent ou nom d'utilisateur, votre mot de passe, et poste, puis cliquez sur Connexion. c) Dans la boîte de dialogue Certificat SSL non accepté, cliquez sur le lien du certificat. Un nouvel onglet de navigateur s'ouvre pour chaque certificat que vous devez accepter. d) Dans l'onglet du navigateur, cliquez sur Avancé > Poursuivre FQDN Finesse. L'onglet du navigateur se ferme une fois que vous acceptez le certificat et le lien de certificat accepté est supprimé de la boîte de dialogue Certificat SSL non accepté. Fermez l'onglet du navigateur s'il ne se ferme pas automatiquement. Répétez les étapes précédentes pour tous les liens de certificat. Après avoir accepté tous les certificats, le processus de connexion s'achève. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 25 Tâches courantes Accepter les certificats de sécurité Si vous cliquez sur le lien de certificat et ne l'acceptez pas, le lien du certificat reste activé dans la boîte de dialogue Certificat SSL non accepté. Remarque Accepter les certificats du gadget Données en direct Le gadget Données en direct de Cisco Unified Intelligence Center fournit des rapports que vous pouvez visualiser dans le bureau Finesse. Si votre bureau contient ces rapports, la première fois que vous vous connectez, vous pouvez être invité à accepter des certificats de sécurité. Procédure Étape 1 Connectez-vous au bureau Finesse. Le gadget Données en direct de Cisco Unified Intelligence Center affiche un message qui indique queFinesse vérifie la connectivité. Si Finesse détecte que les certificats de sécurité doivent être acceptés, un message apparaît qui répertorie les certificats que vous devez accepter pour utiliser Cisco Unified Intelligence Center. Remarque Chaque rapport Cisco Unified Intelligence Center affiche ce message. Étape 2 Cliquez sur OK. Un nouvel onglet du navigateur (ou fenêtre, en fonction des paramètres de votre navigateur) s'ouvre pour chaque certificat que vous devez accepter. Le message du gadget est modifié pour indiquer que pour continuer, vous devez accepter les certificats des onglets ouverts. Étape 3 Si vous utilisez Internet Explorer : a) Cliquez sur Erreurs de certificat > Afficher les certificats pour ouvrir la boîte de dialogue Certificat. b) Dansla boîte de dialogue Certificat, cliquez surInstalleruncertificat pour ouvrir l'Assistant Importation de certificat. Si vous utilisez Internet Explorer 11 avec Windows 10, l'option Installation de certificat n'apparaît pas jusqu'à ce que vous ajoutiez Finesse à vos sites de confiance. 1. Dans le menu du navigateur, sélectionnez Options Internet. 2. Sur l'onglet Sécurité, cliquez sur Sites de confiance > Sites. 3. Dans le champ Ajouter ce site Web à la zone, entrez l'URL du bureau Finesse et cliquez sur Ajouter. 4. Après avoir cliqué sur Installer le certificat, sous Emplacement du magasin, sélectionnez Utilisateur actuel pour installer le certificat pour l'utilisateur actuel uniquement, ou sélectionnez Machine locale pour installer le certificat pour tous les utilisateurs de Windows qui utilisent cet ordinateur. Si vous sélectionnez Machine locale, une boîte de dialogue s'affiche vous demandant si vous souhaitez autoriser le processus hôte Windows à apporter des modifications à cet ordinateur. Sélectionnez Oui. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 26 Tâches courantes Accepter les certificats du gadget Données en direct c) Dans l'assistant Importation de certificat, cliquez sur Suivant. d) Sélectionnez Placer tous les certificats dans le magasin suivant, puis cliquez sur Naviguer. e) Sélectionnez Autorités de certification racines de confiance, puis cliquez sur OK. f) Cliquez sur Suivant. g) Cliquez sur Terminer. h) Dans la boîte de dialogue Avertissement de sécurité, cliquez sur Oui pour installer le certificat. i) Dans la boîte de dialogue Importation de certificat, cliquez sur OK. j) Cliquez sur OK dans la boîte de dialogue Certificat. k) Fermez l'onglet du navigateur. Répétez les étapes précédentes jusqu'à ce que tous les certificats soient acceptés. Après fermeture des onglets du navigateur, le gadget Données en direct de Cisco Unified Intelligence Center est rechargé. Étape 4 Pour accepter le certificat dans Edge : a) Dans l'onglet du navigateur Erreur de certificat, cliquez sur Erreurde certificat > Afficher les certificats pour ouvrir les informations de certificat. b) Dans la colonne informations sur le certificat , cliquez sur Exporter dans un fichier, naviguez vers n'importe quel emplacement sur votre ordinateur et enregistrez le certificat. c) À partir de Démarrer, recherchez et ouvrez l'outil Gérer les certificats d'utilisateur. d) Dans Gérer les certificats d'utilisateur, sous Certificats - ordinateur local, effectuez un clic droit sur Autorités de Certification racine de confiance et cliquez sur Toutes les tâches > Importation. e) Dans l'assistant Importation de certificat, cliquez sur Suivant. f) Cliquez sur Parcourir, naviguez jusqu'à l'emplacement où vous aviez exporté le certificat et sélectionnez le certificat, puis cliquez sur Ouvrir. g) Dans l'assistant Importation de certificat, cliquez sur Suivant > Suivant > Terminer. h) Cliquez sur OK, dans la boîte de dialogue Assistant d'importation de certificat. i) Après fermeture des onglets du navigateur, le gadget Données en direct de Cisco Unified Intelligence Center est rechargé. Étape 5 Si vous utilisez Firefox : a) Sur chaque onglet, cliquez sur Je comprends les risques, puis cliquez sur Ajouter une exception. b) Assurez-vous que la case Stocker de façon permanente cette exception est cochée. c) Cliquez sur Confirmer l'exception de sécurité. Après fermeture des onglets du navigateur, le gadget Données en direct de Cisco Unified Intelligence Center est rechargé. Étape 6 Pour accepter les certificats dans Chrome : a) Sur la page Votre connexionn'estpasprivée, cliquez sur Avancé > Poursuivre Nom de domaine complet CUIC. Après fermeture des onglets du navigateur, le gadget Données en direct de Cisco Unified Intelligence Center est rechargé. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 27 Tâches courantes Accepter les certificats du gadget Données en direct Déconnexion du bureau Finesse Ne fermez pas votre navigateur pour vous déconnecter du bureau Finesse. Finesse peut mettre jusqu'à 120 secondes pour détecter que votre navigateur est fermé et 60 secondes supplémentaires pour vous déconnecter. Finesse peut continuer à vous acheminer des contacts pendant ce temps. Vous ne pouvez pas vous déconnecter du poste de travail Finesse lorsque vos canaux vocaux ou numériques sont à l'état Prêt. Important Procédure Étape 1 Assurez-vous que votre état est défini sur Non prêt. Cliquez sur l'icône d'options de l'utilisateur dans le coin supérieur droit de l'écran. L'option de déconnexion s'affiche avec une liste déroulante de codes motif de déconnexion. Étape 2 Sélectionnez le code motif de déconnexion approprié pour vous déconnecter. Si aucun code motif de déconnexion n'est configuré pour votre équipe, Finesse vous déconnecte lorsque vous cliquez sur Déconnexion. Remarque Étape 3 Dans l'écran de confirmation de Déconnexion, vous pouvez choisir de quitter le navigateur ou de cliquer sur le lien Connexion pour être redirigé vers l'écran de connexion Finesse. Modifier votre état Lorsque vous vous connectez au bureau Cisco Finesse, votre état est défini sur Non prêt par défaut. Ceci s'applique à la fois à la voix et aux canaux numériques. Vous pouvez ensuite définir votre état sur Prêt ou choisir l'un des codes motif Non prêt configurés. Lorsque vous êtes en communication, en conversation ou répondez à un courrier électronique, vous pouvez sélectionner et appliquer un état lorsque vous terminez la tâche. Modifier votre état pour les canaux vocaux Lorsque vous vous connectez au bureau Cisco Finesse, votre état est défini sur Non prêt par défaut. Pour accepter l'appel entrant, vous devez définir votre état sur Prêt. Lorsque vous prenez un appel, vous pouvez modifier votre état après la fin de l'appel. Si vous devez effectuer un traitement post-appel, quand un appel est terminé, vous passerez à l'état Post-appel. En état Post-appel, vous pouvez mener à bien tout travail post-appel.Si le traitement post-appel est facultatif dans votre cas, vous pouvez sélectionner Post-appel lors d'un appel pour passer à l'état Post-appel lorsque l'appel est terminé. Pour mettre fin à l'état Post-appel, vous pouvez sélectionner votre nouvel état dans la liste déroulante ou attendre la fin du minuteur pré-configuré. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 28 Tâches courantes Déconnexion du bureau Finesse Procédure Étape 1 Cliquez sur la flèche déroulante à côté de votre état actuel. Étape 2 Sélectionnez l'état approprié dans la liste. Votre état d'agent est modifié pour refléter votre nouvel état sélectionné. Si vous sélectionnez le changement d'état alors que vous êtes toujours en communication, le changement d'état est répercuté après l'exécution de l'appel. Modifier votre état pour tous les canaux numériques Lorsque vous vous connectez au bureau Cisco Finesse, l'état par défaut sera Non prêt pour tous les canaux numériques. Pour les canaux numériques individuels, l'état par défaut répercuté est en fonction de l'enregistrement pour ce canal particulier. Remarque Vous pouvez inscrire et configurer jusqu'à quatre canaux numériques pour le déploiement de Unified CCE. Pour changer l'état de tous les canaux numériques : Procédure Étape 1 Cliquez sur la flèche déroulante à côté de votre état actuel. Étape 2 Sélectionnez l'état Prêt dans la liste. Pour tous les canaux numériques, le changement d'état sélectionné est affiché comme Prêt. Que faire ensuite Poursuivez pour modifier l'état de vos canaux numériques enregistrés individuels. Modifier votre état pour des canaux numériques individuels Vous pouvez modifier l'état des canaux numériques individuels que vous avez configurés et enregistrés. Procédure Étape 1 Cliquez sur la liste déroulante à côté du canal configuré. Étape 2 Sélectionnez l'état souhaité dans la liste. Le changement d'état pour les canaux numériques individuels est reflété comme changement de couleur de l'icône.Par exemple, pour indiquer le changement d'état, si vous avez enregistré Disponible et Non disponible Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 29 Tâches courantes Modifier votre état pour tous les canaux numériques en tant que terminologie pour le canal Conversation et que vous sélectionnez Disponible pour votre état, l'icône Conversation devient verte et si vous sélectionnez Non Disponible l'icône Conversation devient rouge. Afficher une fenêtre contextuelle de notifications des canaux numériques Lorsque vous recevez une demande de conversation, d'e-mail ou de canal numérique que vous avez enregistré et configuré, une fenêtre contextuele de notification s'affiche sur le bureau Finesse. Cliquez sur Accepter pour accepter la demande ou Rejeter rejeter la demande. Si vous n'acceptez pas la demande, la fenêtre contextuelle de notification disparaît. La durée de la notification est configurée par l'administrateur. Remarque Passer un appel Votre état doit être défini sur Prêt ou Non prêt pour passer un appel sortant. Finesse prend en charge l'utilisation de tous les caractères ASCII lors du passage d'un appel.Finesse convertit les lettres saisies sur le clavier de numérotation en nombres. Il ne supprime pas des caractères non numériques (notamment les parenthèses et traits d'union) de numéros de téléphone. Tous les caractères spéciaux et alphabétiques des numéros de téléphone, y compris #, , +, et : sont pris en charge. Remarque Procédure Étape 1 Cliquez sur l'icône de clavier de numérotation sur le bureau Cisco Finesse. La boîte de dialogue Numéroteur contenant le clavier et une liste de contacts téléphoniques s'affiche. Votre administrateur vous attribue des contacts téléphoniques. Étape 2 Cliquez sur le contact dans la liste ou entrer le numéro manuellement dans le clavier pour passer un appel. Saisissez du texte dans la zone de recherche pour rechercher dans la liste des contacts.Pour modifier le numéro avant de passer un appel, cliquez sur l'icône Modifier en regard du contact pour remplir le clavier de numérotation avec le numéro de téléphone. Remarque Étape 3 Pour terminer l'appel, cliquez sur Terminer. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 30 Tâches courantes Afficher une fenêtre contextuelle de notifications des canaux numériques Répondre à un appel Vous devez être à l'état Prêt pour être disponible pour les appels des clients. Quand un appel arrive sur le bureau, votre état passe automatiquement à Réservé. Une fenêtre contextuelle de notification avec les détails du client configurés s'affiche avec le bouton Réponse. Remarque Vous pouvez recevoir un appel d'un autre agent pendant que vous êtes à l'état Non prêt. Procédure Étape 1 Cliquez sur Réponse dans la fenêtre contextuelle de notification. Votre état passe à Conversation. Vous êtes connecté à l'appelant. Les variables d'appel configurées s'affichent dans la zone de contrôle des appels et peuvent être agrandies ou réduites, si nécessaire. Cela est possible grâce à la flèche agrandir/réduire ou en cliquant sur le contrôle d'appel. Si un deuxième appel arrive sur le bureau, l'affichage des variables d'appel de l'appel initial est réduit. Étape 2 Pour terminer l'appel, cliquez sur Terminer. Votre état passe à Prêt et vous êtes disponible pour le prochain appel entrant. Pour être à l'état Non prêt lorsque l'appel est terminé, cliquez sur la flèche déroulante à côté de votre état pendant que vous êtes en communication et choisissez Prêt ou Non prêt avec le code motif approprié. Votre état passe de Conversation --> Non prêt (en attente). Lorsque l'appel est terminé, votre état passe à Non prêt. Répondreàunappeldeprévisualisationd'optiond'appelsortant Un appel de prévisualisation d'option d'appel sortant vous permet de visualiser les informations de contact d'un client avant de choisir d'accepter ou de refuser l'appel. Procédure Étape 1 Assurez-vous que votre état est défini sur Prêt, pour recevoir un appel. L'appel de prévisualisation d'option sortante arrive sur le bureau sous la forme d'une fenêtre contextuelle avec les boutons Accepter et Refuser. Le gadget de contrôle des appels s'agrandit pour afficher les informations du client. Étape 2 Après avoir vérifié les informations, cliquez sur Accepter pour accepter l'appel ou sur Refuser pour refuser l'appel. Si vous acceptez l'appel, le système effectue l'appel au client. Si la tentative réussit, vous êtes connecté au client. Si la tentative échoue, l'appel de réservation disparaît et Finesse vous transfère à l'état Prêt. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 31 Tâches courantes Répondre à un appel Si vous refusez l'appel, vous devez choisir de rejeter ou de fermer le contact. Si vous cliquez sur Rejeter, le contact reste dans la campagne pour un nouvelle tentative à une date ultérieure. Si vous cliquez sur Fermer, le contact est clos pour la durée de la campagne. Répondre à un appel sortant de prévisualisation directe Un appel sortant de prévisualisation directe vous permet de visualiser les informations de contact d'un client avant de choisir d'accepter ou de refuser l'appel. Procédure Étape 1 Assurez-vous que votre état est défini sur Prêt, pour recevoir un appel. Un appel sortant de prévisualisation directe arrive sur le bureau comme un fenêtre contextuelle dotée de boutons Accepter et Refuser. Votre état passe à réservé (sortant). Le gadget de contrôle des appels s'agrandit pour afficher les informations du client. Étape 2 Après avoir vérifié les informations, cliquez sur Accepter pour accepter l'appel ou sur Refuser pour refuser l'appel. Si vous acceptez l'appel, le système passe l'appel au client directement depuis votre téléphone. Si la tentative réussit, vous êtes connecté au client. Si la tentative échoue, Finesse vous fait passer à l'état Prêt. Si vous refusez l'appel, vous devez choisir de rejeter ou de fermer le contact. Si vous cliquez sur Rejeter, le contact reste dans la campagne pour un nouvelle tentative à une date ultérieure. Si vous cliquez sur Fermer, le contact est clos pour la durée de la campagne. Reclasser un appel sortant de prévisualisation directe Le bouton Reclasser vous permet de reclasser un appelsortant de prévisualisation directe en tant que Répondeur, Fax, Numéro non valide ou Vocal. Par défaut, un appel est classé comme Vocal. Ce bouton est disponible après avoir accepté l'appel de prévisualisation directe et le demeure pendant la durée de vie de l'appel. Il est également disponible lorsque vous êtes à l'état Post-appel. Vous pouvez reclasser un appel plusieurs fois. Procédure Étape 1 Répondre à un appel sortant de prévisualisation directe Étape 2 Écoutez l'appel. Si vous déterminez que le numéro appelé est occupé, est un répondeur, un fax ou un numéro non valide, cliquez sur Reclasser. Étape 3 Choisissez l'option appropriée dans la liste déroulante générée. Étape 4 Pour terminer l'appel, cliquez sur Terminer. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 32 Tâches courantes Répondre à un appel sortant de prévisualisation directe Planifier un rappel Si vous traitez un appel composé sortant et que le client souhaite être rappelé à une heure ultérieure, vous pouvez planifier un rappel. Procédure Étape 1 Pendant que vous êtes en ligne cliquez sur Rappel. La boîte de dialogue Rappel apparaît. Le champ Heure actuelle contient l'heure actuelle dans le fuseau horaire du client (ce champ est en lecture seule). Le champ Numéro de téléphone contient le numéro de téléphone qui a été composé pour cet appel. Étape 2 Si le client préfère se faire appelersur un numéro de téléphone différent, entrez le nouveau numéro de téléphone dans le champ Numéro de téléphone. Étape 3 Dans les champs Date et heure, entrez la date et l'heure d rappel du client. Entrez la date et l'heure dans les champs respectifs ou sélectionnez la date et l'heure à partir du calendrier affiché. Vous devez saisir l'heure du lieu du client (pas l'heure de votre région). Vous pouvez basculer entre AM ou PM et cliquez sur Entrée. L'heure correspond au fuseau horaire du client. Finesse utilise le code téléphonique de la zone du client afin de déterminer le fuseau horaire. Un client utilisant un téléphone mobile peut ne pas être dans le fuseau horaire qui correspond au code téléphonique de la zone. Par conséquent, vous devez confirmer le fuseau horaire avec le client. Remarque Étape 4 Cliquez sur Planification. Étape 5 Si vous avez besoin de mettre à jour les informations après avoir planifié un rappel, cliquez sur Rappel pour rouvrir la boîte de dialogue de rappel. Étape 6 Mettez à jour les champs nécessaires, puis cliquez sur Mettre à jour. Étape 7 Si vous avez besoin d'annuler le rappel après l'avoir planifié, cliquez sur Rappel pour rouvrir la boîte de dialogue de rappel. Étape 8 Cliquez sur Annuler. Un message s'affiche confirmant que le rappel a été annulé. Répondre à un appel de rappel personnel d'option d'appel sortant Lorsque vous êtes sur un appel d'option d'appel sortant, vous pouvez planifier un rappel pour rappeler le client à un moment plus opportun. Lesrappels planifiés peuvent être desrappels personnels ou desrappels classiques, en fonction de la configuration de votre centre de contact. Lesrappels classiques apparaissentsur votre bureau dans le même mode d'option d'appel sortant que l'appel d'origine (par exemple, si l'appel initial était un appel de prévisualisation, l'appel de rappel est un appel de prévisualisation). Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 33 Tâches courantes Planifier un rappel Les rappels personnels sont similaires aux appels de prévisualisation d'option d'appel sortant, mais les boutons du bureau sont légèrement différents. Procédure Étape 1 Assurez-vous que votre état est défini sur Prêt, pour recevoir un appel. Quand un appel de rappel personnel d'option d'appel sortant arrive sur le bureau, votre état passe à Réservé (sortant). Le gadget de contrôle des appels s'agrandit pour afficher les informations du client. Étape 2 Après avoir vérifié les informations, cliquez sur Accepter pour accepter l'appel ou sur Refuser, puis cliquez sur Fermer. Si vous acceptez l'appel, le système effectue l'appel au client. Si la tentative réussit, vous êtes connecté au client. Si la tentative échoue, l'appel de réservation disparaît et Finesse vous transfère à l'état Prêt. Si vous refusez l'appel, le contact est clos pour la durée de la campagne. Lancer un appel de consultation Vous devez être en appel actif pour lancer un appel de consultation. Procédure Étape 1 Cliquez sur Consulter. La boîte de dialogue Numéroteur contenant le clavier et une liste de contacts téléphoniques s'affiche. Étape 2 Choisissez le contact que vous souhaitez consulter dans la liste des contacts ou saisissez son numéro sur le pavé numérique. Étape 3 Sur le clavier de numérotation, cliquez sur Appeler. L'appel du client est mis en attente et vous êtes mis en relation avec le contact que vous avez appelé. Étape 4 Après avoir consulté le contact que vous avez appelé, vous pouvez choisir de mettre fin à l'appel de consultation et reprendre l'appel du client, d'ajouter le clientsousforme de conférence téléphonique à l'appel de consultation, ou de transférer le client à l'agent au superviseur que vous avez consulté. Option Description Cliquez sur Terminer sur l'appel de consultation, puis cliquez sur Reprendre sur l'appel de client. Pour mettre fin à l'appel de consultation et reprendre l'appel du client Pour placer l'autre agent ou le superviseur en Cliquez sur Reprendre sur l'appel client. attente et revenir au client Cliquez sur Reprendre sur l'appel de consultation pour placer le client en attente et revenir à l'autre agent ou au superviseur. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 34 Tâches courantes Lancer un appel de consultation Option Description Cliquez sur Conférence. Si vous voulez quitter la conférence, cliquez sur Terminer. Pour réaliser une conférence téléphonique avec le client au sein de l'appel de consultation Pour transférer le client à l'agent ou au superviseur Cliquez sur Transfert. que vous consultez Transférer un appel (transfert en une seule étape) Cette fonction vous permet de transférer un appel sans lancer d'abord un appel de consultation. Vous devez être à l'état Conversation pour lancer un transfert. Si vous mettez l'appel en attente, le bouton Transfert disparaît. Remarque Procédure Étape 1 Cliquez sur Transfert direct. La boîte de dialogue Numéroteur contenant le clavier et une liste de contacts téléphoniques s'affiche. Remarque Votre administrateur vous attribue des contacts téléphoniques. Étape 2 Choisissez le contact dans la liste ou saisissez le numéro que vous voulez appeler dans le pavé numérique de composition d'appel. Entrez le texte dans le champ de recherche pour effectuer une recherche dans la liste de contacts ou sélectionnez un contact pour copier son numéro de téléphone sur le clavier de numérotation. Remarque Étape 3 Dans la boîte de dialogue Numéroteur, cliquez sur transfert direct. L'appel disparaît de votre bureau. Vous êtes désormais prêt pour le prochain appel. Envoyer DTMF Utilisez cette fonction pour envoyer une chaîne de caractères multifréquence à deux tonalités (Dual Tone Multifrequency, DTMF) lors d'un appel. Par exemple, vous pouvez utiliser cette fonction pour interagir avec un système de réponse vocale interactive (RVI) pour saisir un numéro de compte ou un mot de passe. Remarque Pour utiliser cette fonction, vous devez être en communication. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 35 Tâches courantes Transférer un appel (transfert en une seule étape) Procédure Étape 1 Cliquez sur le bouton Pavé numérique. La boîte de dialogue Numéroteur contenant le clavier et une liste de contacts téléphoniques s'affiche. Étape 2 Cliquez sur les boutons appropriés du pavé numérique pour saisir les caractères DTMF. Vous pouvez envoyer les caractères suivants dans le cadre d'une chaîne DTMF : • 0 à 9 • A, B, C et D • le dièse (#) • l'astérisque () Vous devez utiliser le clavier pour saisir les caractères. Vous ne pouvez pas taper les caractères à l'aide de votre clavier. Remarque Les caractères correspondants apparaissent dans la zone de texte au-dessus du pavé numérique (ce champ de texte est en lecture seule). Étape 3 Cliquez sur le bouton Clavier à nouveau ou sur n'importe où en dehors de la zone pour fermer le clavier de numérotation. Conversation de bureau L'interface de conversation du bureau est hébergée par le bureau du navigateur Finesse et nécessite une connexion séparée. Cette fonctionnalité fournit des fonctionnalités de conversation nécessaires aux agents et superviseurs pour discuter entre eux ou avec d'autres experts techniques de l'entreprise. La fonctionnalité Conversation sur le bureau n'est disponible sur votre bureau Finesse que si l'administrateur a configuré cette fonction pour vous. La conversation sur le bureau ne prend pas en chargeSingleSign-On (L'authentification unique). Elle nécessite une connexion explicite pour l'authentification unique et les plates-formes non SSO. Remarque Les utilisateurs de la conversation de bureau sont identifiés par un identifiant unique qui est sous la forme de nomutilisateur@FQDN.com. L'état de l'agent dans la conversation de bureau est différent de l'état vocal ou de celui des canaux numériques, et peut être contrôlé par l'utilisateur. L'état de conversation de bureau est répercuté sur la présence combinée de l'utilisateur. Par exemple, si vous vous connectez à la conversation de bureau, vous êtes visibles comme disponible dans Jabber ou d'autres outils de conversation connectés. Lors de l'acceptation des certificats de conversation de bureau, si vous acceptez un certificat et ignorez le reste, vous perdrez votre statut de conversation de bureau pendant un basculement. Assurez-vous d'accepter Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 36 Tâches courantes Conversation de bureau tous les certificats pour préserver la connexion et le statut de la conversation de bureau après un basculement. Selon le type de basculement, vous pouvez perdre ou conserver vos sessions de conversation sur le bureau. Se connecter à une conversation de bureau Procédure Étape 1 Dans le bureau Finesse, cliquez sur l'icône conversation de bureau ( ). Étape 2 Saisissez vos nom d'utilisateur et mot de passe, puis cliquez sur Connexion. Étape 3 Remarque Si vous utilisez des certificats auto-signés, vous obtenez la fenêtre d'acceptation de certificat. Cliquez sur le lien des certificats. Un nouvel onglet de navigateur s'ouvre pour chaque certificat que vous devez accepter. Une erreur de certificat apparaît dans la barre d'adresse. Pour accepter les certificats dans Internet Explorer, reportez-vous à la section Accepter les certificats de sécurité > étape 2 > sous-étape d et suivantes. Pour accepter les certificats dans Edge, reportez-vous à la section Accepter les certificats de sécurité > étape 3 > sous-étape d et suivantes. Pour accepter les certificats dans Firefox, reportez-vous à la section Accepter les certificats de sécurité > étape 4 et suivantes. Pour accepter les certificats de Chrome, reportez-vous à la section Accepter les certificats de sécurité > étape 5 et suivantes. Ajouter un contact Si vous disposez de Cisco Jabbersur votre bureau, la première fois que vous vous connectez à une conversation de bureau, vous verrez votre liste de contacts Cisco Jabber dans la fenêtre de conversation de bureau. Si vous ne disposez pas de Cisco Jabber, votre liste de contacts sera vide. Procédure Étape 1 Pour ajouter un contact : • Dans la liste de contacts vide, saisissez le nom de l'agent ou un ID dans le champ Recherche. Lorsque vous entrez le texte à rechercher, le champ de recherche est prérempli avec lesrésultats pertinents dans la liste déroulante. Dans la liste des résultats, passez le curseur sur le contact requis et cliquez sur l'icône . Remarque • Dansla liste de contacts existante, cliquez sur l'icône à l'extrémité du groupe et cliquez sur Ajouter. • À partir du groupe Conversations récentes, cliquez sur l'icône à l'extrémité de la discussion requise et cliquez sur Ajouter. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 37 Tâches courantes Se connecter à une conversation de bureau Étape 2 Dans la fenêtre ajouter un contact, vous pouvez modifier le nom d'affichage. Étape 3 À partir de la liste déroulante Ajouter au groupe, choisissez un groupe existant ou créez un nouveau groupe pour ajouter le contact. Étape 4 Cliquez sur Ajouter. Le contact est ajouté à votre groupe existant ou nouvellement créé. Modification d'un contact Utilisez cette option pour modifier le nom du groupe. Procédure Étape 1 Dans la liste des contacts, cliquez sur l'icône à l'extrémité du contact requis. Étape 2 Dans la liste déroulante, cliquez sur Modifier. Étape 3 Dans la fenêtre Modifier le Contact, modifiez le nom d'affichage ou le groupe. Lors de la modification du groupe pour le contact, vous pouvez ajouter le contact à des groupes existants ou créer un nouveau groupe. Étape 4 Cliquez sur Enregistrer. Déplacer un contact Utilisez cette option pour déplacer un contact vers un autre groupe. Procédure Étape 1 Pour déplacer un contact unique : a) Cliquez sur l'icône à l'extrémité du contact requis. b) Dans la liste déroulante, cliquez sur Déplacer. c) Dans le sélectionner la Destinationfenêtre, sélectionnez un groupe existant ou créer un nouveau groupe. d) Cliquez sur Déplacer. Étape 2 Pour déplacer plusieurs contacts : a) Maintenez enfoncé la touche Ctrl et sélectionnez les contacts requis. b) Dans l'en-tête de liste de contacts, cliquez sur déplacer. c) Dansla fenêtreSélectionner ladestination,sélectionnez un groupe existant ou créez un nouveau groupe. d) Cliquez sur Déplacer. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 38 Tâches courantes Modification d'un contact Supprimer un contact Utilisez cette option pour supprimer un contact. Si le contact fait partie de plusieurs groupes, il n'est supprimé qu'à partir de ce groupe et non à partir d'autres groupes. Procédure Étape 1 Pour supprimer un seul contact : a) Dans la liste des contacts, cliquez sur l'icône à l'extrémité du contact requis. b) Dans la liste déroulante, cliquez sur Supprimer. c) Dans l'invite de confirmation, cliquez sur Supprimer pour supprimer le contact à partir de ce groupe. Étape 2 Pour supprimer plusieurs contacts : a) Maintenez enfoncé la touche Ctrl et sélectionnez les contacts requis. b) Dans l'en-tête de liste de contacts, cliquez sur Supprimer. c) Dans l'invite de confirmation, cliquez sur Supprimer pour supprimer le contact à partir de ce groupe. Modification d'un groupe Utilisez cette option pour modifier le nom du groupe. Procédure Étape 1 Dans la liste des contacts, cliquez sur l'icône à l'extrémité du groupe requis. Étape 2 Dans la liste déroulante, cliquez sur Modifier. Étape 3 Dans la fenêtre Groupe, modifiez le nom de groupe. Étape 4 Cliquez sur Enregistrer. Suppression d'un groupe Utilisez cette option pour supprimer un groupe. Procédure Étape 1 Dans la liste des contacts, cliquez sur l'icône à l'extrémité du groupe requis. Étape 2 Dans la liste déroulante, cliquez sur Supprimer. Étape 3 Dans la boîte de dialogue de confirmation, cliquez sur Supprimer. Le groupe est supprimé avec tous les contacts. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 39 Tâches courantes Supprimer un contact Fenêtre de conversation Lorsque vous recevez une demande de conversation entrante, une fenêtre de conversation apparaît avec le nom d'affichage de l'agent dans l'en-tête de la fenêtre de conversation. Si la fenêtre ou l'onglet Finesse du bureau est inactif,Finesse affiche une notification avec les détails de la conversation. Cliquez sur la notification d'alerte pour restaurer le bureau Finesse. Vous pouvez déplacer la fenêtre de conversation vers n'importe quel emplacement de l'écran, mais vous ne pouvez pas utiliser le mode plein écran. Vous pouvez discuter avec des agents qui sont connectés à la conversation de bureau. Vous ne pouvez pas envoyer des messages aux agents déconnectés. Remarque La fenêtre de conversation du bureau offre les fonctionnalités suivantes : • Zone de saisie : entrez votre message dans la zone de saisie. Cliquez à l'aide du bouton droit de la souris pour effectuer les opérations de Presse-papiers de base. • L'indicateur de reconnaissance de la frappe apparaît lorsque l'autre participant effectue une saisie. • Plusieurs conversations : • Tous les agents sont affichés dans les onglets de conversation en bas de la fenêtre de conversation. • La zone des onglets de conversation affiche jusqu'à trois conversations actives. Pour afficher plus de trois conversations actives, cliquez sur l’icône . • Pour chaque onglet de conversation, la notification de conversation non lue est affichée en un badge en regard du nom d'affichage. Le badge disparaît lorsque l'onglet de conversation est actif. • Lorsque vous passez le curseur sur l'état de n'importe quel onglet de conversation en regard du nom d'affichage, vous avez la possibilité de fermer cet onglet de conversation. • Cliquez sur l'en-tête de la fenêtre de conversation pour la réduire ou l'agrandir. • Lorsqu'elle est réduite, l'en-tête de la fenêtre de conversation affiche le nombre total de conversations qui comportent des messages non lus. • Cliquez sur X sur l'en-tête de la fenêtre de conversation et confirmez pour fermer toutes les conversations. • L'historique de conversation : la fenêtre de conversation du bureau stocke l'historique des conversations pour une session particulière. Si vous vous déconnectez ou si le navigateur est actualisé ou fermé, l'historique des conversations est perdu. • Redimensionner la fenêtre de conversation : cliquez sur le bouton sur l'en-tête de la fenêtre de conversation pour augmenter la taille de l'image de la fenêtre de conversation et sur le bouton pour rétablir la taille de l'image. • Pièces jointes : Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 40 Tâches courantes Fenêtre de conversation L'administrateur doit avoir activé la prise en charge des pièces jointes pour que vous puissiez envoyer et recevoir des pièces jointes. Remarque • Pour envoyer une pièce jointe : 1. Cliquez sur le bouton Envoyer un fichier et accédez au fichier que vous souhaitez envoyer. 2. Cliquez sur OK. • Lorsque vous recevez une pièce jointe, vous êtes invité à accepter et refuser la pièce jointe. Cliquez sur Accepter pour télécharger la pièce jointe ou sur Refuser pour le refuser. • Le nom de fichier et la taille du fichier sont affichés dans l'en-tête de la pièce jointe. • Les pièces jointes sont téléchargées dans le dossier Téléchargements du navigateur. • Vous ne pouvez pas ouvrir la pièce jointe à partir de la fenêtre de conversation. • Les types de fichiers pris en charge et la taille maximale de pièce jointe sont configurés par votre administrateur. Vous ne pouvez envoyer ou recevoir des pièces jointes qu'à destination ou qu'à partir des utilisateurs utilisant la conversation de bureau. Remarque Modifier votre état de conversation du bureau Lorsque vous vous connectez à la conversation de bureau, votre état est défini sur Disponible par défaut.Pour modifier votre état : Procédure Étape 1 Cliquez sur la flèche déroulante à côté de votre état actuel dans la fenêtre de conversation de bureau. Étape 2 Choisissez l'état approprié dans la liste. Si votre état est défini sur Ne pas déranger et que vous recevez un message de conversation, le message ne s'affiche que si votre fenêtre de conversation est active. Si la fenêtre de conversation est fermée ou réduite, l'icône de conversation de bureau clignote et vous ne voyez que l'en-tête de la fenêtre de conversation réduite avec le nombre d'onglets de conversation qui ont des messages non lus. Remarque Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 41 Tâches courantes Modifier votre état de conversation du bureau Se déconnecter d'une conversation de bureau Lorsque vous vous déconnectez de la conversation de bureau, vous ne serez déconnecté que de la conversation de bureau et non des canaux Voix ou Numérique. L'état de vos canaux Voix et Numérique demeure inchangé. Pour vous déconnecter : Procédure Étape 1 Cliquez sur la flèche déroulante à côté de votre état actuel dans la fenêtre de conversation de bureau. Étape 2 Dans la liste affichée, cliquez sur Se déconnecter. Appliquer un motif de traitement post-appel Les motifs de post-appel sont appliquées aux appels. Si votre administrateur vous a attribué des motifs de travail post-appel, le bouton Motifs Post-appel apparaît lorsque vous êtes sur un appel ou lorsque vous êtes à l'état Post-appel après un appel (si votre configuration inclut les traitements post-appel). Si vous n'avez pas de motif post-appel attribué, vous n'aurez pas cette fonctionnalité sur votre bureau. Votre administrateur crée et attribue des motifs Post-appel. Les motifs post-appel sont définis par appel. Cela signifie que si vous appliquez un motif de traitement post-appel à un appel, le même sera répercuté sur les postes de travail de tous les autres participants (agents) à l'appel. Remarque Vous pouvez saisir un motif de traitement post-appel lors d'un appel ou lorsque vous êtes dansl'étatPost-appel après la fin de l'appel (y compris la fin de l'appel normal, ainsi que les scénarios de transfert et d'abandon de conférence).Si vous devez effectuer un traitement post-appel, vous passez automatiquement à l'étatPost-appel lorsque l'appel est terminé. Si le traitement post-appel est facultatif dans votre cas, vous pouvez sélectionner Post-appel dansla liste déroulante État de l'agent lors de l'appel. Votre état apparaît alors comme Conversation --> Post-appel (en attente) pour la durée de l'appel. Lorsque l'appel est terminé, vous passez à l'étatPost-appel et pouvez mener à bien tout traitement post-appel. Si vous voulez spécifier dans quel état passer lorsque le minutagePost-appel expire, vous pouvez sélectionner l'état dans la liste déroulante avant de sélectionner Post-appel. Par exemple, pendant un appel, sélectionnez Non Prêt dans la liste déroulante. Puis cliquez sur Post-appel. Pour mettre fin à l'état Post-appel, vous pouvez sélectionner votre nouvel état (Prêt ou Non prêt) dans la liste déroulante ou attendez la fin du minuteur pré-configuré. Une fois que vous entrez à l'état Post-appel, aucune autre mise à jour d'appel n'est effectuée dans le gadget de contrôle d'appel. Toutefois, si vous saisissez un motif de traitement post-appel de l'appel en étant à l'état Post-appel, le gadget de contrôle d'appel est mis à jour avec le motif Post-appel uniquement ; toutes les autres informations d'appel demeurent telles qu'elles étaient avant de passer à l'état Post-appel. Remarque Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 42 Tâches courantes Se déconnecter d'une conversation de bureau Procédure Étape 1 Cliquez sur Post-appel. Étape 2 Vous pouvez sélectionner le motif approprié en faisant défiler la liste déroulante ou utiliser le champ de recherche fourni dans la liste déroulante post-appel. Étape 3 Cliquez sur Appliquer. Une coche verte apparaît à côté du bouton Appliquer pour indiquer que Finesse a appliqué avec succès le motif de traitement post-appel. Le motif de post-appel appliqué s'affiche en tant que balise juste sousle champ de recherche dans la fenêtre contextuelle post-appel. Vous pouvez modifier le motif Post-appel durant l'appel. Si vous décidez que vous voulez utiliser un autre motif Post-appel, cliquez de nouveau sur le bouton Post-appel, sélectionnez un nouveau motif Post-appel, et cliquez sur Appliquer. Si vous souhaitez annuler le motif de post-appel, cliquez sur Annuler pour fermer la popover post-appel. Remarque Modifier des variables d'appel Vous pouvez modifier les valeurs des variables d'appel si l'administrateur a configuré la variable d'appel comme étant modifiable. Vous pouvez modifier les valeurs lors d'un appel actif ou à l'état Post-appel. Procédure Étape 1 Cliquez dans la zone de texte pour modifier les valeurs selon vos besoins. Dans les scénarios suivants, les modifications apportées à la variable d'appel par un utilisateur sont remplacées : • Lorsque plusieurs utilisateurs modifient le même champ en même temps.Par exemple, lorsque deux utilisateurs (utilisateur A et utilisateur B) modifient le même champ en même temps et que l'utilisateur A enregistre les valeurs modifiées. Les modifications apportées par l'utilisateur B sont alors remplacées et l'utilisateur B est averti par un message. • Lorsqu'un script est modifié sur le serveur CTI et que pendant ce temps, un utilisateur modifie les valeurs. Les modifications apportées par l'utilisateur sont alors remplacées et l'utilisateur reçoit un message. Remarque Étape 2 Cliquez sur Enregistrer. Cliquez sur Rétablir pour revenir aux valeurs enregistrées précédemment. Remarque Les valeurs de champ non enregistrées sont remplacées cas de conflit. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 43 Tâches courantes Modifier des variables d'appel Forcer le travail post-appel Si votre administrateur vous a attribué des motifs post-appel et que vous voulez modifier votre état dePost-appel à n'importe quel autre état, une info-bulle avec le message Sélectionnez un motif post-appel s'affiche. Vous ne pouvez pas modifier votre état, sauf si le motif post-appel est appliqué, ou qi votre minuteur expire et que votre état est modifié automatiquement. Le minutage post-appel s'applique lorsque l'administrateur a configuré la durée de post-appel pour la file d'attente de service de contact. Lorsque les agents mettent fin à un appel, le minuteur post-appel commence le compte à rebours et les agents sont tenus d'effectuer les tâches post-appel avant que le minuteur n'ait atteint zéro. Par exemple, si le minuteur est défini sur 30 secondes, le minuteur démarre à 30 et se termine à zéro. Le minuteur post-appel s'affiche au-dessous de l'état. Afficher Mon historique Utilisez l'onglet Mon historique sur le poste de travail de l'agent ou d'un superviseur pour afficher votre historique d'appels récents et l'historique de l'état. Historique des appels récents Cliquez sur l'onglet Mon historique sur le bureau, vous pouvez afficher les détails suivants de vos appels depuis la dernière fois que vous avez ouvert une session : • Type : indique si l'appel était entrant ou sortant. • Numéro : indique le numéro de téléphone de l'appel. • Répartition : indique l'action effectuée pour l'appel. • Motif Post-appel : indique la catégorie de motif d'appel de l'appel. • File d'attente : indique la file d'attente associée à l'appel. • Heure de début : indique l'heure de début de l'appel. • Durée : indique la durée de l'appel. • Elle inclut le temps de sonnerie, le temps d'attente et le temps de conversation des appels entrants. • Pour les appels sortants, elle inclut la tonalité, sonnerie, temps de conversation et temps d'attente. • Appeler : cliquez sur l'icône d'appel pour initier un appel sortant lorsque vous êtes à l'état Prêt ou Non prêt. Historique des états récents Cliquez sur l'onglet Monhistorique sur le bureau, vous pouvez afficher les détails suivants de votre historique d'états d'appels depuis la dernière fois que vous avez ouvert une session : • Heure de début : indique l'heure à laquelle l'état de l'agent a été créé. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 44 Tâches courantes Forcer le travail post-appel • État : indique l'état ACD de l'agent. • Raison : indique la raison de l'état actuel de l'agent. • Durée : indique la durée de l'état d'agent. Affichage de plusieurs vues de rapport de données en temps réel Cisco Unified Intelligence Center vous permet d'afficher plusieurs vues ou rapports de données en temps réel sur un seul gadget. Vous pouvez sélectionner la vue que vous souhaitez afficher à partir d'une liste déroulante sur la barre d'outils de gadget, qui répertorie jusqu'à cinq vues de rapport au format Nom de rapport - Nom de la vue. L'administrateur détermine les vues disponibles pour la sélection. À partir de la barre d'outils Rapport de données en direct, vous pouvez : • Mettre en pause et reprendre les mises à jour d'événement du gadget de données en direct en utilisant le bouton Pause et lecture. (Si le bouton est sur Pause lorsque des mises à jour sont disponibles sur le gadget, une notification apparaît sur le bouton.) • Masquer et restaurer la barre d'outils à l'aide de la flèche située au centre de la barre d'outils. • Accéder à l'aide pour les gadgets de rapports pertinents en cliquant sur le bouton d'aide. Afficher un message de l'équipe Lors de la connexion au bureau Finesse, vous pouvez afficher la bannière du Message de l'équipe qui diffuse les mises à jour actives d'équipe envoyées par votre superviseur en temps réel. Le nombre total de messages actifs envoyés par votre superviseur est affiché dans la bannière. En cliquant sur le nombre, vous pouvez afficher le dernier message avec le nom du superviseur et l'horodatage affiché à côté de chaque message. Vous pouvez basculer entre les messages actifs (Remarquez que les messages expirent après une période de temps, définie par le superviseur). Si le bureau Finesse est inactif, une notification d'alerte s'affiche lorsqu'un nouveau message d'équipe est envoyé par le superviseur. Vous pouvez cliquer sur la notification pour afficher le message. Lors du basculement, la bannière de basculement et la bannière des messages d'équipe sont affichées conjointement. Remarque Envoyer le rapport d'erreur Si vous rencontrez des difficultés avec le bureau Finesse, vous pouvez envoyer un ensemble de journaux du bureau à votre administrateur. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 45 Tâches courantes Affichage de plusieurs vues de rapport de données en temps réel Procédure Étape 1 Pour envoyer les journaux du bureau à l'administrateur, cliquez sur les options de l'utilisateur dans le coin supérieur droit de votre écran. Étape 2 Sélectionnez l'option Envoyer le rapport d'erreur dans la liste déroulante. Une fois que le bureau Finesse envoie les journaux, l'option Envoyer le rapport d'erreur est modifiée pour afficher le message de cnfirmation Envoyé avec succès. L'option Envoyer le rapport d'erreur réapparaît une fois que le bureau Finesse a envoyé les journaux. Si votre navigateur se bloque ou se ferme avant que vous ne puissiez cliquer sur le l'option Envoyer le rapport d'erreur et que vous deviez redémarrer votre navigateur, ne cliquez pas tout de suite sur l'option Envoyer le rapport d'erreur. Après un redémarrage du navigateur, les journaux ne sont plus disponibles. Vous devez attendre jusqu'à ce que le bureau commence à signaler à nouveau le problème, puis cliquer sur l'option. Remarque Faire glisser-déplacer ou redimensionner un gadget et un composant Les fonctions de glisser-déplacer ou de redimensionner vous permettent de personnaliser le bureau en faisant glisser les gadgets ou les composants vers la position requise sur la disposition du poste de travail. Elle vous permet également de réduire ou d'étendre les gadgets ou les composants à la taille personnalisée. Cette fonctionnalité s'applique aux agents et aux superviseurs qui utilisent le poste de travail finesse. Le bureauFinesse conserve vos choix lorsque vous accédez à nouveau au navigateur.Pour plus d'informations sur la réinitialisation de la disposition par défaut, voir Rétablissement de la disposition. Remarque Cette fonctionnalité est également applicable aux gadgets tiers. Limitations et restrictions Les restrictions et limitations relatives aux fonctions de glisser-déposer ou de redimensionnement sont les suivantes : • La réorganisation et le redimensionnement d'une action effectuée sur un gadget ou un composant est spécifique à l'utilisateur connecté, au navigateur utilisé, à l'onglet et au périphérique utilisé. • Les actions de réorganisation et de redimensionnement ne sont pas applicables pour les gadgets et les composants de niveau d'en-tête et de page. Par exemple, l'état de l'agent pour le composant vocal et du numéroteur. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 46 Tâches courantes Faire glisser-déplacer ou redimensionner un gadget et un composant Si l'administrateur modifie la présentation par défaut, les modifications apportées par vous sont remplacées par les paramètres par défaut. Les modifications sont reflétées lorsque vous actualisez ou que vous vous reconnectez. Remarque Faire glisser et déplacer un gadget ou un composant Avant de commencer Cette fonctionnalité n'est disponible sur votre bureauFinesse que si l'administrateur a configuré cette fonction pour vous. Procédure Étape 1 Se connecter au bureau Cisco Finesse. Étape 2 Placez le pointeur sur le gadget ou l'en-tête du titre du composant. Lorsque le pointeur se transforme en , cliquez sur le gadget ou le composant, puis faites-le glisser vers l'emplacement souhaité sur la page du bureau. L'action de glisser-déposer effectuée sur un gadget ou un composant est spécifique à l'utilisateur connecté, au navigateur utilisé, à l'onglet et au périphérique utilisé. Vous pouvez réorganiser un maximum de 12 gadgets ou composants côte à côte sur un onglet spécifique. Remarque Redimensionner un gadget ou un composant Avant de commencer Cette fonctionnalité n'est disponible sur votre bureauFinesse que si l'administrateur a configuré cette fonction pour vous. Procédure Étape 1 Se connecter au bureau Cisco Finesse. Étape 2 Placez le pointeur sur la bordure du gadget ou du composant. Lorsque le pointeur se transforme en , cliquez et faites glisser le pour redimensionner le gadget ou le composant sur la disposition du bureau. L'action de redimensionnement effectuée sur un gadget ou un composant estspécifique à l'utilisateur connecté, au navigateur utilisé, à l'onglet et au périphérique utilisé. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 47 Tâches courantes Faire glisser et déplacer un gadget ou un composant • indique le redimensionnement vertical et indique le redimensionnement horizontal. • La taille maximale horizontale est la longueur de l'écran. La taille minimale horizontale est de l'écran/12. Remarque Réinitialiser la mise en page L'option Réinitialiser la disposition est disponible dans la liste déroulante de l'icône Options utilisateur. Utilisez cette fonction pour réinitialiser la disposition à la vue par défaut. Remarque Vous pouvez également effacer le cache de votre navigateur pour réinitialiser la disposition à la vue par défaut. Procédure Étape 1 Cliquez sur l'icône d'options de l'utilisateur dans le coin supérieur droit de l'écran. Étape 2 Cliquez sur Réinitialiser la disposition. Étape 3 Dans la boîte de dialogue de confirmation cliquez sur OK. Restaure la vue par défaut pour toutes les dispositions. Accéder aux Raccourcis clavier Utilisez lesraccourcis clavier pour accéder facilement aux fonctions de poste de travail d'agent et de superviseur Cisco Finesse. Les raccourcis clavier sont disponibles pour les agents et les superviseurs. Pour plus d'informations sur la liste complète des raccourcis clavier et des raccourcis clavier conflictuels, reportez-vous à la boîte de dialogue Liste des raccourcis clavier. Remarque Pour exécuter un raccourci clavier, assurez-vous que le curseur se trouve dans l'écran du poste de travail. Procédure Étape 1 Cliquez sur l'icône d'options de l'utilisateur dans le coin supérieur droit de l'écran. Étape 2 Cliquez sur Raccourcis clavier ou appuyez sur Ctrl + Alt + F. La boîte de dialogue Liste des raccourcis clavier répertorie les éléments suivants : • Raccourcis clavier prédéfinis • Raccourcis clavier de gadgets de fabricants tiers Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 48 Tâches courantes Réinitialiser la mise en page • Raccourcis clavier incompatibles Les raccourcis clavier ne répondent pas s'il existe des incompatibilités entre les gadgets ou les composants. Pour résoudre ces conflits, contactez votre administrateur. Remarque Raccourcis clavier de l'agent Le tableau ci-dessous répertorie les raccourcis clavier spécifiques à l'agent. Tableau 1 : Liste des raccourcis clavier de l'agent (Windows) Groupe Action Touche de raccourci Remarques État de l'agent Prêt pour l'appel Ctrl + Alt + R - Affiche la liste déroulante des codes motif lorsque plusieurs codes raison d'état Non prêt sont répertoriés. Non prêt pour les appels Ctrl + Alt + N Ouvrir Contrôle d'état des Ctrl+Maj+L - canaux numériques Prêt pour tous les canaux Ctrl + Maj + V - numériques Non prêt pour tous les Ctrl + Maj + Z - canaux numériques Permet de basculer entre les fenêtres contextuelles lorsqu'il y a plusieurs notifications de fenêtres contextuelles. Permuter les fenêtres Ctrl Alt + P contextuelles Application Maximiser / restaurer la vue Ctrl + Maj + 0 - Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 49 Tâches courantes Raccourcis clavier de l'agent Groupe Action Touche de raccourci Remarques Traitement des Effectuer un nouvel appel Ctrl + Alt + O - appels Appel de transfert direct Ctrl + Alt + Q - Ouvrir le clavier numérique Ctrl + Alt + K - (DTMF) Ouvrir Consulter Ctrl + Alt + C - Résumer l'appel Ctrl + Alt + W - Reclasser les appels Ctrl + Alt + Y - Programmer le rappel Ctrl + Alt + S - Utilisez la touche de raccourci dans les scénarios suivants : • Répondre à un appel entrant • Accepte un appel d'option d'appel sortant ou un appel de prévisualisation directe Répondre à un appel / Ctrl + Alt + A Accepter un appel Fermez - supprimez Ctrl + Alt + J - l'enregistrement de la campagne Rejeter - Renvoyer Ctrl + Alt + U - l'enregistrement à la campagne / Fermer ce rappel Met fin au dernier appel actif lorsqu'il y a plusieurs appels. Mettre fin à l'appel Ctrl + Alt + E Passe l'appel avec l'option d'attente lorsqu'il y a plus d'un appel. Si tous les appels sont dotés de l'option d'attente, le dernier appel actif est mis en attente. Mise en attente de l'appel Ctrl + Alt + V Récupère l'appel qui comporte l'option Récupérer lorsqu'il y a plus d'un appel. Si tous les appels sont dotés de l'option récupérer, le dernier appel mis en attente est récupéré. Récupérer l'appel Ctrl + Alt + G Transférer l'appel Ctrl + Alt + X - Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 50 Tâches courantes Raccourcis clavier de l'agent Groupe Action Touche de raccourci Remarques Conférence téléphonique Ctrl + Alt + H - Permuter, minimiser et Ctrl + Maj + 1 - maximiser la fenêtre de conversation Conversation de bureau Ouvrir Conversation de Ctrl + Maj + 3 - bureau Enregistrer des valeurs de Ctrl + Alt + M - variables d'appel modifiées Modifier une variable d'appel Rétablir des valeurs de Ctrl + Alt + Z - variables d'appel modifiées Raccourcis clavier Liste des raccourcis clavier Ctrl + Alt + F - L'ordre des numéros de touches de raccourci dépend de la façon dont les gadgets sont disposés sur votre barre de navigation. Par exemple, si le gadget Mon historique est le premier de votre barre de navigation, la combinaison de touches Ctrl + Alt + 1 ouvre le gadget Mon historique. Navigation Domicile Ctrl + Alt + 1 Mon historique Ctrl + Alt + 2 - Mes statistiques Ctrl + Alt + 3 - Gérer le client Ctrl + Alt + 4 - Envoyer le rapport Envoyer le rapport d'erreur Ctrl + Maj + 2 - d'erreur Fermeture de session Fermeture de session Ctrl + Alt + L - • Les lettres utilisées dans les raccourcis clavier ne sont pas sensibles à la casse. • Si vous utilisez un clavier Mac, appuyez sur Option au lieu de Alt. Par exemple, pour accéder à la liste des raccourcis clavier, appuyez sur Ctrl + option + F. • Si vous utilisez le clavier Mac via un navigateur Firefox, configurez l'accès complet au clavier sur Toutes les commandes (Préférences système > Clavier > Touchesde raccourci) pour décaler le focus du clavier vers toutes les commandes. Remarque Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 51 Tâches courantes Raccourcis clavier de l'agent ECE (Enterprise Chat et Email) Lesraccourcis clavier de ECE (Enterprise Chat et Email) ne sont disponibles que si le gadget ECE est configuré dans le déploiement de Unified CCE. Tableau 2 : Liste des raccourcis clavier de l'agent (Windows) Groupe Action Touche de raccourci Remarques Prêt pour les courriers Ctrl + Maj + 4 - électroniques État de l'agent Prêt pour la discussion Ctrl + Maj + 5 - Non prêt pour les courriers Ctrl + Maj + 6 - électroniques Non prêt pour la discussion Ctrl + Maj + 7 - Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 52 Tâches courantes Raccourcis clavier de l'agent CHAPITRE 3 Tâches des superviseurs Ce chapitre décrit les tâches que les superviseurs effectuent. • Afficher les performances de l'équipe, à la page 53 • Afficher les détails de l'appel actif, à la page 54 • Afficher l'historique des appels récents, à la page 55 • Afficher l'historique des états récents, à la page 55 • Modifier l'état d'un agent, à la page 56 • Surveiller un appel, à la page 57 • Intervention sur un appel, à la page 57 • Intercepter un appel, à la page 58 • Envoyer des messages d'équipe, à la page 58 • Raccourcis clavier du superviseur, à la page 59 Afficher les performances de l'équipe Utilisez le gadget Afficher les performances de l'équipe pour afficher les agents de chacune des équipes qui vous sont affectées. Procédure Étape 1 Dans le gadget des performances de l'équipe, vous pouvez afficher les informations détaillées de l'équipe qui est sélectionnée par défaut dans la liste déroulante Nom de l'équipe. Une liste des agents de l'équipe sélectionnée, leur état actuel, la durée dans l'état, et leurs numéros de poste sont affichés. Cliquez sur les en-têtes de colonne pour trier l'information par Nom d'agent, État, Durée dans l'état, ou Poste. Pour que la Durée dans l'état apparaisse pour les agents déconnectés et Non prêts, l'état de l'agent doit avoir changé au moins une fois après le redémarrage du serveur Remarque Par défaut, la liste ne contiendra que les agents connectés de l'équipe sélectionnée. Si vous voulez afficher les agents connectés et déconnectés, cochez la case Inclure les agents déconnectés. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 53 Utilisez l'option de Recherche pour préciser la recherche de n'importe quelle information relative à l'agent en utilisant le critère de recherche de nom d'agent, d'état ou de numéro de poste. Lesrésultats de la recherche sont conservés même lorsque vous basculez entre les onglets pendant la session active. Remarque Sélectionnez un agent et sur la ligne correspondante, cliquez sur dans l'onget Actions pour surveiller l'agent, modifier l'état à Prêt, Non prêt ou déconnecter l'agent. Le champ Durée dans l'état est actualisé toutes les 10 secondes. Lorsque Finesse reçoit le prochain événement de changement d'état d'agent d'un agent, le minuteur repasse à 0. Remarque Étape 2 Pour afficher une autre équipe, cliquez sur la liste déroulante Nom de l'équipe et choisissez une nouvelle équipe. Afficher les détails de l'appel actif Si l'administrateur a configuré à votre intention les détails de l'appel actif, utilisez le gadget des performances de l'équipe pour afficher les détails de l'appel actif d'un agent de votre équipe affectée. Procédure Étape 1 À partir de la liste déroulante Nom de l'équipe, sélectionnez l'équipe de l'agent. Étape 2 Dans la liste affichée, sélectionnez un agent à l'état en conversation. Étape 3 Dans l'onglet Actions de l'agent sélectionné, cliquez sur la flèche vers le bas. Les informations d'appel suivantes apparaissent : • La fenêtre contextuele d'en-tête de la variable d'appel et les variables d'appel configurées par l'administrateur. • Participants actifs : les numéros de téléphone des participants à l'appel actif. • Participants enattente : les numéros de téléphone des participants à l'appel en attente. Les informations sur les participants en attente ne sont pas disponibles pour les périphériques non surveillés. Par exemple, pour le client ou des périphériques externes. Leslistes de participants actifs et de participants en attente ne contiennent pasle numéro d'agent développé, mais uniquement les autres participants à l'appel. Remarque • Durée : la durée de l'appel. • État de l'appel : l'état actuel de l'appel. Indique l'état de l'agent développé dans l'appel. • Nom de la file d'attente : la file d'attente du service client à laquelle appartient l'appel. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 54 Tâches des superviseurs Afficher les détails de l'appel actif Afficher l'historique des appels récents Si l'administrateur a configuré à votre intention l'historique de la vue, utilisez le gadget des performances de l'équipe pour afficher l'historique de la vue d'un agent de votre équipe affectée. Procédure Étape 1 À partir de la liste déroulante Nom de l'équipe, sélectionnez l'équipe de l'agent. Étape 2 Dans la liste affichée, sélectionnez un agent. Par défaut, la liste contient tous les agents connectés de l'équipe sélectionnée. Si vous voulez afficher les agents connectés et déconnectés, cochez la case Inclure les agents déconnectés. Étape 3 Dans l'onglet Actions de l'agent sélectionné, cliquez sur > afficher l'historique. Les détails suivants d'appel de l'historique des appels récents de l'agent sélectionné s'affichent : • Heure de début : indique l'heure de début de l'appel. • Durée : indique la durée de l'appel. • Type : indique si l'appel était entrant ou sortant. • Numéro : indique le numéro de téléphone de l'appel. • Répartition : indique l'action effectuée sur l'appel. • File d'attente : indique le nom de la file d'attente affectée à l'agent. • Motif de travail post-appel : indique le motif de travail post-appel sélectionné par l'agent. Vous ne pouvez pas sélectionner un autre agent ou choisir une autre équipe lors du chargement de l'historique des appels récents de l'agent sélectionné. Toutefois, vous pouvez modifier l'état d'un agent ou surveiller l'appel d'un agent au cours de cette période. Remarque Pour revenir à la vue de gadget des performances de l'équipe, cliquez sur la flèche vers la gauche à côté de l'en-tête Afficher l'historique des appels récents. Remarque Afficher l'historique des états récents Si l'administrateur a configuré à votre intention l'historique de l'état, utilisez le gadget des performances de l'équipe pour afficher l'historique de l'état d'un agent de votre équipe affectée. Procédure Étape 1 À partir de la liste déroulante Nom de l'équipe, sélectionnez l'équipe de l'agent. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 55 Tâches des superviseurs Afficher l'historique des appels récents Étape 2 Dans la liste affichée, sélectionnez un agent. Par défaut, la liste contient tous les agents connectés de l'équipe sélectionnée. Si vous voulez afficher les agents connectés et déconnectés, cochez la case Inclure les agents déconnectés. Étape 3 Dans l'onglet Actions de l'agent sélectionné, cliquez sur > afficher l'historique. Les détails suivants de l'historique des états récents de l'agent sélectionné s'affichent : • Heure de début : indique l'heure de début de l'appel. • État : indique l'état de l'agent. Dans le gadget des performances de l'équipe, lorsqu'un état d'agent passe à Post-appel, l'état correspondant dans le gadget de l'historique des états récents est affiché comme TRAVAIL_PRÊT. • Motif : indique le motif Post-appel de l'appel. • Durée : indique la durée de l'appel. Vous ne pouvez pas sélectionner un autre agent ou choisir une autre équipe lors du chargement de l'historique des étatsrécents de l'agentsélectionné. Toutefois, vous pouvez modifier l'état d'un agent ou surveiller l'appel d'un agent au cours de cette période. Remarque Pour revenir à la vue de gadget des performances de l'équipe, cliquez sur la flèche vers la gauche à côté de l'en-tête Afficher l'historique des états récents. Remarque Modifier l'état d'un agent Vous pouvez utiliser le gadget Performances de l'équipe pour changer l'état d'un agent à l'état Prêt, Non prêt ou Déconnexion. Procédure Étape 1 À partir de la liste déroulante Nom de l'équipe, sélectionnez l'équipe de l'agent. Étape 2 Dans la liste affichée, sélectionnez un agent pour en modifier l'état. Étape 3 Dans l'onglet Actions de l'agent sélectionné, cliquez sur et choisissez : Prêt Pour forcer l'état de l'agent à Prêt. Non prêt Pour forcer l'état de l'agent à Non prêt. Fermeture de session Pour déconnecter l'agent. Dans l'onglet Actions, les options Prêt, Non prêt et Déconnexion ne sont actives que si l'action est autorisée. Par exemple, si vous sélectionnez un agent qui est à l'état Prêt, vous ne verrez que les options Non prêt et Déconnexion. Si vous sélectionnez un agent qui est à l'état Non prêt, vous ne verrez que les options Prêt et Déconnexion. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 56 Tâches des superviseurs Modifier l'état d'un agent Si vous déconnectez un agent sur un appel en cours (à l'état Conversation), ou qui a un appel en attente (à l'état En attente), cet agent est immédiatement déconnecté du bureau, mais l'appel est conservé. Surveiller un appel Vous devez être à l'état Non prêt pour surveiller un agent. Vous ne pouvez surveiller qu'un agent à la fois. Pour surveiller un autre agent, vous devez mettre fin à l'appel en surveillance silencieuse, puis sélectionnez un nouvel agent. Procédure Étape 1 Dans la liste déroulante Nom de l'équipe, choisissez l'équipe dont vous souhaitez surveiller les agents. Étape 2 Dans l'onglet Actions de l'agent sélectionné, cliquez sur > Surveiller. L'appel en surveillance silencieuse apparaît dans la zone de contrôle des appels du bureau. Les boutons En attente, Interruption et Terminer sont activés. Cliquer : En attente Pour mettre un appel en attente. Extraire Pour récupérer un appel en attente. Intervenir Pour se joindre à l'appel. Étape 3 Pour mettre fin à l'appel en surveillance silencieuse cliquez sur Terminer. Intervention sur un appel La fonction Intervention vous permet de vous connecter à un appel entre un agent et un appelant. Remarque Vous ne pouvez intervenir que sur un appel que vous écoutez en silence. Procédure Étape 1 À partir de la liste déroulante Nom de l'équipe, sélectionnez l'équipe de l'agent. Étape 2 Dans la liste affichée, sélectionnez un agent à l'état en conversation. Étape 3 Dans l'onglet Actions de l'agent sélectionné, cliquez sur > Surveiller. L'appel en surveillance silencieuse apparaît dans la zone de contrôle des appels de votre bureau. Le bouton Intervention apparaît. Étape 4 Cliquez sur Intervention. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 57 Tâches des superviseurs Surveiller un appel L'appel devient une conférence téléphonique entre l'agent, l'appelant et vous. Intercepter un appel Après être intervenu dans un appel entre un agent et un appelant, vous pouvez intercepter l'appel en excluant l'agent de l'appel. Vous pouvez également exclure un participant de toute conférence téléphonique à laquelle vous participez. Procédure Étape 1 Cliquez sur la liste déroulante Exclure. Étape 2 Cliquez sur l'agent qui vous voulez exclure de la liste des participants. Même si un agent lance une conférence téléphonique, seul le superviseur peut exclure un agent de l'appel. Le superviseur ne peut pas exclure un point d'acheminement CTI, un port IVR, ou un appelant. Remarque Envoyer des messages d'équipe La fonctionnalité de Messages d'équipe vous permet de créer et envoyer un message de diffusion à une ou plusieurs équipes. Le message s'affiche en tant que bannière sur le bureau Finesse et les agents peuvent consulter ces messages en temps réel. Le message d'équipe n'est disponible sur votre bureau Finesse que si l'administrateur a configuré cette fonction pour vous. Procédure Étape 1 Dans le bureau Finesse, cliquez sur l'icône Message d'équipe. Étape 2 Dans la boîte de dialogue Composer un message, saisissez le message de diffusion (le nombre maximal de caractères autorisés est 255). Étape 3 Sélectionnez la ou les équipes à laquelle/auxquelles envoyer le message en cochant la case en regard du nom de l'équipe. Vous pouvez envoyer plusieurs messages à une seule équipe, à plusieurs équipes ou à toutes les équipes. Remarque Étape 4 Dans la liste déroulante, vous pouvez définir un délai d'expiration pour les messages composés : de 5 minutes à 23 h 55. L'heure est affichée en heures et minutes. Toutefois, cette période peut être modifiée. Étape 5 Cliquez sur Envoyer. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 58 Tâches des superviseurs Intercepter un appel Vous pouvez afficher les derniers messages envoyées en cliquant sur Afficher les messages récents. Si vous voulez supprimer un ou tous les messages, cochez la case en regard du message. Cliquez sur Oui et confirmez la suppression. Le message est supprimé de l'affichage actif et le message d'équipe non expiré précédent devient le message actif pour l'agent. L'administrateur ou le superviseur qui crée un message d'équipe peutsupprimer le message d'équipe créée au moyen de l'API TeamMessage. Pour plus d'informations sur la suppression d'un TeamMessage, reportez-vous à https://developer.cisco.com/docs/finesse/ #!teammessage-delete-a-team-message. Remarque La vitesse à laquelle les messages (créer/supprimer) sont publiés dans les équipes impliquées est plafonnée à 400 par heure et le nombre maximum de messages actifs autorisés est de 4800.Si la limite des messages actifs est atteinte, les superviseurs ne pourront pas diffuser de nouveaux messages tant qu'un message d'équipe existant n'aura pas été supprimé ou aura expiré. Comme il n'y a pas de limitation individuelle sur les superviseurs, un ou tous les superviseurs peut/peuvent diffuser des messages jusqu'à la limite maximale des messages actifs. Remarque Raccourcis clavier du superviseur Lorsque vous vous connectez en tant que superviseur, la boîte de dialogue Liste des raccourcis clavier répertorie à la fois les raccourcis clavier spécifiques aux agents et aux superviseurs. Pour plus d'informations sur les raccourcis clavier spécifiques aux agents, reportez-vous à la section Raccourcis clavier de l'agent, à la page 49. Le tableau ci-dessous répertorie les raccourcis clavier spécifiques au superviseur. Tableau 3 : Liste des raccourcis clavier du superviseur (Windows) Groupe Action Touche de raccourci Traitement des appels Rejoindre l'appel Ctrl + Alt + B Déconnecter le participant Ctrl + Alt + D Ouvrir la fenêtre Message Ctrl + Maj + Y d'équipe Message de l'équipe Performance des équipes Sélectionner une équipe Ctrl + Maj + F Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 59 Tâches des superviseurs Raccourcis clavier du superviseur • Les lettres utilisées dans les raccourcis clavier ne sont pas sensibles à la casse. • Si vous utilisez un clavier Mac, appuyez sur Option au lieu de Alt. Par exemple, pour accéder à la liste des raccourcis clavier, appuyez sur Ctrl + option + F. • Si vous utilisez le clavier Mac via un navigateur Firefox, configurez l'accès complet au clavier sur Toutes les commandes (Préférences système > Clavier > Touchesde raccourci) pour décaler le focus du clavier vers toutes les commandes. Remarque Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 60 Tâches des superviseurs Raccourcis clavier du superviseur CHAPITRE 4 Tâches de IP Phone Agent • Finesse IP Phone Agent, à la page 61 • Connexion à Finesse sur le téléphone IP, à la page 62 • Modifier l'état sur le téléphone IP, à la page 63 • Appliquer un motif Post-appel sur le téléphone IP Phone, à la page 64 • Déconnexion de Finesse sur le téléphone IP, à la page 65 • Restauration du service Finesse IP Phone Agent après une panne, à la page 65 • Configuration du serviceFinesse et desinformations de connexion à l'aide du portail d'aide en libre-service, à la page 66 • Comportement de Finesse IPPA, à la page 67 Finesse IP Phone Agent Finesse IP Phone Agent (IPPA) vous permet d'accéder aux fonctions Finesse sur votre téléphone IP Cisco au lieu d'accéder à Finesse via votre navigateur. Finesse IPPA prend en charge moins de fonctions que le bureau Finesse dans le navigateur, mais vous permet de recevoir et de gérer des appels Finesse si vous n'avez pas ou plus accès à un ordinateur. Tâches des superviseurs Finesse IPPA ne prend pas en charge les tâches de superviseur telles que la surveillance, l'intervention et l'interception, mais les superviseurs peuvent se connecter et effectuer toutes les tâches d'agents sur leur téléphone IP. Pour effectuer des tâches de superviseur pour les agents Finesse IPPA, les superviseurs doivent se connecter au bureau Finesse et procéder de la même façon que pour les agents du bureau Finesse (qui se limitent actuellement à l'affichage des performances des équipes et à la modification de l'état d'un agent). Tâches d'agents Le tableau suivant fournit un bref aperçu des tâches d'agents courantes. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 61 Tâche Étapes • Appuyez sur Services > Cisco Finesse. • Entrez votre ID, votre mot de passe et votre numéro de poste. • Appuyez sur SignIn. Connexion Modifier l'état Appuyez sur Prêt ou Non prêt. Appliquer des motifs post-appel Appuyez sur Post-appel et sélectionnez une option dans la liste. Si le traitement post-appel est facultatif, appuyez sur Post-appel lors de l'appel pour passer à l'état Post-appel à la fin de l'appel. Activer le traitement post-appel facultatif Fermeture de session À partir de l'état Non prêt, appuyez sur Fermeture de session. Pour plus d'informations relatives aux tâches d'agents, reportez-vous aux sections suivantes. Connexion à Finesse sur le téléphone IP Avant de commencer L'administrateur doit configurer votre accès à Finesse IPPA. Procédure Étape 1 Sur votre téléphone IP, appuyez sur le bouton Services. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 62 Tâches de IP Phone Agent Connexion à Finesse sur le téléphone IP Les exemples de figures présentés dans cette procédure peuvent différer de la présentation et de l'affichage de votre téléphone. Remarque Étape 2 Sélectionnez Cisco Finesse. Étape 3 Saisissez votre ID d'agent, votre mot de passe et votre numéro de poste, puis appuyez sur Connexion. • Vous devez saisir votre ID d'agent dansle champ ID. Contrairement au bureauFinesse,Finesse IPPA ne prend pas en charge le nom d'utilisateur pour la connexion. • L'ID (Finesse IPPA) dans le déploiement fait référence à AgentID (numéro de périphérique). Pour plus d'informations sur la récupération du numéro de périphérique d'un agent à partir de NomConnexion, reportez-vous au Guide du développeur des services Web Cisco Finesse, à l'adresse https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide. Remarque L'administrateur peut configurer votre téléphone avec la connexion à l'aide d'un bouton unique, qui vous permet de vous connecter sans indiquer d'ID, de mot de passe ou de numéro de poste. Dans ce cas, lorsque vous sélectionnez Finesse dans le menu Services, Finesse IPPA entre automatiquement vos informations de connexion et vous passez directement à l'écran d'accueil. La connexion Finesse IPPA par bouton unique peut également être configurée par l'administrateur seulement certains des paramètres tels que l'ID et le numéro de poste. Dans ce cas, vous devez uniquement saisir votre mot de passe pour vous connecter. Lors de la déconnexion de l'application deFinesse IPPA, la page de connexion s'affiche. Cliquez sur le bouton Quitter pour vous assurer que la connexion unique fonctionne correctement la prochaine fois que vous vous connectez à l'application Cisco Finesse. Remarque Modifier l'état sur le téléphone IP Lorsque vous vous connectez à Finesse sur le téléphone IP, votre état initial est défini sur Non prêt. Pour recevoir des appels, définissez votre état sur Prêt. Pendant que vous êtes en communication, vous pouvez définir l'état à appliquer lorsque l'appel sera terminé. Dans ce cas, Finesse affiche votre état actuel et l'état en attente que Finesse appliquera lorsque l'appel sera terminé. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 63 Tâches de IP Phone Agent Modifier l'état sur le téléphone IP Procédure Étape 1 Pour définir votre état sur Prêt, appuyez sur le bouton Prêt. Étape 2 Pour définir votre état sur Non prêt, appuyez sur le bouton Non prêt. Étape 3 Si des codes raison Non prêt s'affichent, faites défiler l'écran jusqu'au motif souhaité et appuyez sur le bouton Sélectionner. Pour modifier le code raison sélectionné, appuyez à nouveau sur le bouton Non prêt et sélectionnez un autre motif. Appliquer un motif Post-appel sur le téléphone IP Phone Un motif Post-appel indique la raison pour laquelle un client a appelé le centre de contact. Par exemple, vous pouvez avoir un motif Post-appel pour les appels des ventes et un autre pour les appels de l'assistance. Votre administrateur peut vous attribuer des motifs de traitementPost-appel. Dans ce cas, le boutonPost-appel apparaît pendant un appel ou lorsque vous êtes en état Post-appel une fois l'appel terminé. Lorsque vous êtes en communication (à l'état conversation), le bouton Post-appel s'affiche à côté des boutons Prêt et Non prêt. Vous pouvez sélectionner le motif de traitement Post-appel avant de mettre fin à l'appel. Si vous ne sélectionnez pas de motif de traitement Post-appel avant de mettre fin à l'appel, et si le motif de traitement Post-appel est configuré par l'administrateur, le bouton Post-appel s'affiche lorsque vous mettez fin à l'appel. Vous pouvez maintenant sélectionner le motif de post-appel. Si l'administrateur n'a pas configuré de motifs de traitement Post-appel à votre intention, le bouton Post-appel n'est pas affiché. Remarque L'administrateur peut définir un traitement post-appel en tant qu'étape obligatoire ou facultative.Si le traitement post-appel est obligatoire, vous passez automatiquement à l'état Post-appel à la fin de l'appel pour mener à bien tout traitement post-appel.Si le traitement post-appel est facultatif, appuyez surPost-appel lors de l'appel pour passer à l'état Post-appel à la fin de l'appel. Procédure Étape 1 Si le traitement post-appel est obligatoire, appuyez sur Post-appel pendant ou après l'appel et sélectionnez un motif Post-appel dans la liste. Étape 2 Si le traitement post-appel est facultatif, appuyez sur Post-appel lors de l'appel et effectuez l'une des opérations suivantes : • Sélectionnez Post-appel après un appel et sélectionnez un motif Post-appel à la fin de l'appel. • Sélectionnez Appliquer un motif Post-appel et sélectionnez un motif Post-appel lors de l'appel. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 64 Tâches de IP Phone Agent Appliquer un motif Post-appel sur le téléphone IP Phone Étape 3 Pour mettre fin à l'état Post-appel une fois l'appel terminé, sélectionnez votre nouvel état (Prêt ou Non prêt) dans la liste déroulante, ou attendez l'expiration du minuteur préconfiguré. Pendant que vous êtes en communication, vous pouvez indiquer l'état suivant à appliquer après le traitement post-appel en sélectionnant d'abord cet état. Par exemple, pendant un appel, sélectionnez Non prêt, puis Post-appel. Lorsque l'appel est terminé, vous entrez dans l'étatPost-appel avec un état en attente de Non prêt. À la fin du délai Post-appel, vous passez à l'état Non prêt. Vous ne pouvez pas saisir de motif Post-appel après avoir transféré un appel. Pour saisir un motif Post-appel pour un appel que vous transférez, sélectionnez le motif Post-appel alors que l'appel est en cours. Déconnexion de Finesse sur le téléphone IP Avant de commencer L'état Non Prêt doit être activé pour que vous puissiez vous déconnecter. Procédure Étape 1 Cliquez sur le bouton Déconnexion. Étape 2 Si des codes motif de déconnexion s'affichent, choisissez le motif souhaité et appuyez sur le bouton Sélectionner. Restauration du service Finesse IP Phone Agent après une panne Si le serveur Finesse auquel vous êtes actuellement connecté passe hors service, le téléphone IP affiche une erreur indiquant que le service Finesse n'est pas disponible. Contrairement au bureau Finesse, Finesse IP Phone Agent ne bascule pas automatiquement vers le serveur Finesse secondaire. Pour reprendre un fonctionnement normal, quittez le service de téléphone IP Finesse actuel et connectez-vous manuellement à un service de téléphone IP Finesse secondaire. Procédure Étape 1 Appuyez sur Réessayer pour relancer le service Finesse actuel. Étape 2 Si le problème n'est pas résolu, connectez-vous à un service Finesse secondaire : a) Appuyez sur Quitter pour quitter le service Finesse actuel. b) Appuyez sur le bouton Services. c) Sélectionnez un service Cisco Finesse secondaire dans le menu. d) Saisissez l'ID, le mot de passe et le numéro de poste de l'agent, puis appuyez sur le bouton Connexion. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 65 Tâches de IP Phone Agent Déconnexion de Finesse sur le téléphone IP • Si aucun des services Finesse disponibles ne vous laisse vous connecter, contactez l'administrateur. • Si votre téléphone IP affiche des informations d'état en attente lorsque vous perdez la connexion au service Finesse, ces informations d'état sont perdues lorsque vous vous reconnectez. Remarque Configuration du service Finesse et des informations de connexion à l'aide du portail d'aide en libre-service L'administrateur peut vous demander d'abonner votre téléphone au service Finesse à l'aide du portail d'aide en libre-service pour Unified Communications.Si l'administrateur configure la connexion à l'aide d'un bouton unique, il peut également vous demander de saisir votre ID, votre numéro de poste ou votre mot de passe dans le portail d'aide en libre-service pour Unified Communications. (Finesse IPPA peut ensuite entrer automatiquement ces informations de connexion chaque fois que vous vous connectez.) Procédure Étape 1 Utilisez votre ID et votre mot de passe pour vous connecter au portail d'aide en libre-service à partir de l'URL suivante : http://adresse UCM/ucmuser Où adresse UCM est l'adresse de Cisco Unified CM fournie par l'administrateur. Étape 2 Sur le portail d'aide en libre-service, accédez à Téléphones > Paramètres du téléphone > Services. Étape 3 Sélectionnez le téléphone que vous souhaitez abonner au service Finesse. Étape 4 Si l'administrateur a déjà abonné ce téléphone au service Finesse, cliquez sur l'icône Edit Service du service Finesse et allez à l'étape 7. Dans le cas contraire, passez à l'étape 5. Étape 5 Cliquez sur Ajouter un nouveau service pour le téléphone et sélectionnez le service Finesse dans la liste déroulante. Étape 6 Dansle champ Display Name,saisissez Cisco Finesse (ou un autre nom d'affichage approprié pour votre téléphone). Étape 7 Si l'administrateur vous demande de saisir vos informations de connexion, entrez les valeurs requises pour votre ID d'agent, votre mot de passe et votre numéro de poste. Étape 8 Cliquez sur Enregistrer. Que faire ensuite Si l'administrateur a également configuré un service Finesse secondaire en tant que sauvegarde, exécutez à nouveau cette procédure sur le service secondaire. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 66 Tâches de IP Phone Agent Configuration du service Finesse et des informations de connexion à l'aide du portail d'aide en libre-service Comportement de Finesse IPPA Les remarques suivantes décrivent le comportement de Finesse IPPA lorsque vous effectuez certaines tâches de l'agent. Affichage des données d'appel • Lorsque vous passez ou recevez un appel, Finesse IPPA affiche les données d'appel sur le téléphone en fonction de la présentation définie par l'administrateur. Contrairement au bureau Finesse, Finesse IPPA affiche toutes les données d'appel dans une seule colonne. L'ordre d'affichage relatif au bureau Finesse est le suivant : en-tête, colonne de gauche, colonne de droite. Vous pouvez faire défiler l'écran pour afficher les données, si nécessaire. • Lorsque vous participez à plusieurs appels (par exemple, un appel de consultation),Finesse IPPA affiche les données de l'appel actif.Si tous les appels sont en attente,Finesse IPPA affiche les données du dernier appel actif. • Certains modèles de téléphones IP affichent l'écran Finesse IPPA et non l'écran d'accueil lors d'un appel entrant ACD. Vous ne pouvez pas accepter l'appel car les touches programmablesRéponse et Refuser ne sont pas activées sur l'écran Finesse IPPA. Pour répondre à l'appel : • Appuyez sur la touche matérielle en haut à droite du téléphone IP. • Utilisez le combiné du téléphone. • Appuyez sur le bouton du haut-parleur. • Vous ne pouvez pas mettre fin à un appel actif car la touche programmable Fin n'est pas activée dans l'écran Finesse IPPA. Pour terminer un appel : • Appuyez sur le bouton Fin du téléphone IP. • Appuyez sur le bouton du haut-parleur. Comportement du téléphone lors du passage d'un appel • Si vous passez un appel sans accéder d'abord à l'écran d'accueil du téléphone, le téléphone IP affiche parfois l'écran Finesse. Pour afficher les numéros composés, retournez à l'écran d'accueil du téléphone. • Si vous appelez un numéro occupé, le téléphone IP affiche d'abord un message Occupé, puis Finesse affiche un message Conversation jusqu'à la fin de l'appel. Vous pouvez ignorer le message Conversation en toute sécurité. États Réservé et En attente non affichés • Contrairement au bureau Finesse, Finesse IPPA n'affiche pas les états Réservé et En attente. Finesse IPPA continue d'afficher à la place l'état appliqué précédemment (par exemple, Prêt ou Conversation) avant que vous ne passiez à l'état Réservé ou En attente. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 67 Tâches de IP Phone Agent Comportement de Finesse IPPA Pas de traitement post-appel lors des appels transférés • En cas de transfert d'appel, vous ne pouvez pas définir de données de traitement post-appel pour l'appel, même si Finesse IPPA indique que vous êtes à l'état Post-appel. Pour saisir un motif Post-appel pour un appel transféré, sélectionnez le motif Post-appel alors que l'appel est en cours. Comportements supplémentaires de Finesse IPPA • La nouvelle interface d'appel simplifiée n'est actuellement pas prise en charge par Finesse IPPA. L'activation de cette fonction ne permettra pas à l'agent d'effectuer des appels sortants à l'état Prêt. • Finesse IPPA n'est pas prise en charge sur VPN. • Lorsque le téléphone Finesse IPPA est éteint ou réinitialisé, vous êtes déconnecté du périphérique physique. Guide de l'utilisateur du bureau Cisco Finesse des agents et superviseurs, version 12.5 (1) 68 Tâches de IP Phone Agent Comportement de Finesse IPPA Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX Première publication : 2016-06-29 Dernière modification : 2019-12-13 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 following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required to correct the interference at their own expense. The following information is for FCC compliance of Class B devices: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If the equipment causes interference to radio or television reception, which can be determined by turning the equipment off and on, users are encouraged to try to correct the interference by using one or more of the following measures: • Reorient or relocate the receiving antenna. • Increase the separation between the equipment and receiver. • Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. • Consult the dealer or an experienced radio/TV technician for help. Modifications to this product not authorized by Cisco could void the FCC approval and negate your authority to operate the product. 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. 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. All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version. Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliatesin the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com go trademarks. Third-party trademarks mentioned 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. (1721R) © 2017–2019 Cisco Systems, Inc. Tous droits réservés. T ABLE DES M A TIÈRES CHAPITRE 1 Votre téléphone 1 Téléphones IP sans fil Cisco 8821 et 8821-EX 1 Prise en charge des fonctionnalités 4 Nouveautés et mises à jour 4 Nouveautés et modifications des informations concernant la prise en charge du téléphone IP sans fil Cisco 8821-EX 4 Nouveautés et informations mises à jour relatives à la version 11.0 (5) SR1 du micrologiciel 4 Nouveautés et informations mises à jour relatives à la version 11.0 (5) du micrologiciel 4 Nouveautés et informations mises à jour relatives à la version 11.0 (4) du micrologiciel 5 Nouveautés et informations mises à jour relatives à la version 11.0 (3) du micrologiciel 6 Démarrage 6 Activation de votre téléphone 7 Connexion au téléphone 7 Désactivation de votre téléphone 7 Verrouillage du clavier du téléphone 8 Déverrouillage du clavier du téléphone 8 Accès à votre messagerie vocale 8 Portail d'aide en libre-service 9 Numéros abrégés 10 Touches et matériel 11 Navigation 15 Fonctions à l’écran du téléphone 15 Icônes d’en-tête 16 Écran d'accueil 17 Différences entre les lignes téléphoniques et les appels 18 Alertes de sortie de portée 19 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX iii Batteries du téléphone 19 Bluetooth et votre téléphone 20 Entretien de votre téléphone 21 Nettoyage de l’extérieur du téléphone 22 Si votre téléphone tombe dans de l’eau 23 Aide et informations complémentaires 25 Conditions générales de la garantie matérielle limitée à un an de Cisco 25 Garantie de la batterie 25 CHAPITRE 2 Configuration du téléphone 27 Installation du matériel du téléphone 27 Installer la batterie du Téléphone IP sans fil Cisco 8821 27 Installer la batterie du Téléphone IP sans fil Cisco 8821-EX 32 Remplacer la batterie du Téléphone IP sans fil Cisco 8821 36 Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX 41 Chargement de la batterie du téléphone 47 Chargement de la batterie de rechange 47 Préparation de l’adaptateur d’alimentation 48 Chargez la batterie à l'aide de l’alimentation secteur 49 Chargez la batterie à l'aide d'un câble USB et d’un port USB de votre ordinateur 49 Configuration du téléphone 50 Ajout du téléphone au réseau Wi-Fi 51 CHAPITRE 3 Appels 53 Accès à l’application Téléphone 53 Passage d’appels 54 Faire un appel 54 Passage d’un appel d’urgence 54 Passage d'un appel avec un casque 54 Passage d'un appel à l'aide du haut-parleur du téléphone 55 Passage d'un appel à l'aide du haut-parleur du chargeur de bureau 55 Passage d’un appel à l’aide du téléphone ou d’une adresse vidéo 55 Recomposer un numéro 56 Retour d'un appel récent 56 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX iv Table des matières Passer un appel vers un numéro favori à partir de l'application Contacts 56 Passer un appel vers un numéro favori à partir de l’écran Applications 57 Passage d'un appel à l'aide de la numérotation simplifiée 57 Composition d'un numéro international 58 Comment recevoir une notification lorsqu’un contact est disponible 58 Appels nécessitant un code de facturation ou un code d’autorisation 58 Appels sécurisés 59 Prise d'appels 59 Pour répondre à un appel 59 Réponse aux appels en garde 59 Refus d’un appel 60 Appel ignoré 60 Mise en sourdine des appels entrants sur votre téléphone 60 Réponse au téléphone d’un collègue (interception d'appel) 61 Prise d’un appel dans votre groupe de recherche (interception) 61 Prise d’un appel à partir d’un autre groupe (interception de groupe) 61 Prise d’un appel à partir d’un groupe associé (autre interception) 61 Suivi d'un appel suspect 62 Contrôle de la sonnerie du téléphone lors d'un appel entrant 62 Mettre fin à un appel 62 Coupure du son 63 Mise en garde d'appels 63 Mise en garde d'un appel 63 Prise d’un appel mis en garde pendant trop longtemps 63 Permutation entre un appel actif et un appel en garde 64 Appel en garde par indicatif 64 Mise en garde d’un appel à l’aide du parcage d'appels 64 Récupération d’un appel en garde à l’aide du parcage d'appels 65 Transfert d’appels depuis votre téléphone 65 Désactivation du transfert d'appel depuis votre téléphone 66 Transfert d'un appel à une autre personne 66 Conférences téléphoniques et réunions 66 Ajout d’une autre personne à un appel 66 Affichage et suppression des participants à une conférence 67 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX v Table des matières Conférences téléphoniques planifiées (MultConf) 67 Organisation d'une conférence MultConf 67 Accès à une conférence MultConf 68 Appels intercom 68 Passer un appel intercom 68 Réponse à un appel intercom 69 Supervision et enregistrement des appels 69 Configuration d’un appel supervisé 69 Enregistrement d’un appel 70 Appels prioritaires 70 Composition d'appel prioritaire 71 Prise d'un appel prioritaire 71 Réponse à un appel prioritaire pendant un appel en cours 71 Lignes multiples 71 Lignes partagées 72 Comment s'ajouter soi-même à un appel sur une ligne partagée (InsConf) 72 CHAPITRE 4 Contacts 73 Accès à l’application Contacts 73 Favoris 74 Accéder aux favoris 74 Ajout d'un contact à votre liste de favoris 74 Suppression d'un contact de votre liste de favoris 74 Contacts locaux 75 Recherche d'un contact dans votre liste de contacts locaux 75 Ajout d’un nouveau contact à votre liste de contacts locaux 75 Modification d'un contact de votre liste de contacts locaux 76 Appel d'un contact de votre liste de contacts locaux 76 Suppression d'un contact de votre liste de contacts locaux 77 Suppression de tous les contacts locaux 77 Répertoire personnel 77 Connexion à un répertoire personnel et déconnexion 78 Carnet d'adresses pers. 78 Recherche d'un contact dans votre carnet d'adresses personnel 78 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX vi Table des matières Ajout d’un nouveau contact à votre répertoire personnel 78 Recherche des informations de contact d’un contact du répertoire personnel sur votre téléphone 79 Modification d'un contact figurant dans votre répertoire personnel 79 Appel d'un contact de votre répertoire personnel 80 Suppression d'un contact de votre carnet d'adresses personnel 80 Répertoire général 80 Recherche et appel d'un contact à partir du répertoire d'entreprise 80 Recherche des informations de contact d’un collègue sur votre téléphone 81 CHAPITRE 5 Historique des appels 83 Accès à l’application Récents 83 Indicateurs de nouveau message vocal et d’appel en absence 83 Liste des appels en absence 84 Consultation de vos appels en absence 84 Recherche des détails sur un appel en absence 84 Rappel d’un appel en absence 84 Suppression d'une entrée de la liste des appels en absence 85 Effacement de la liste des appels en absence 85 Liste des appels récents 85 Visualiser vos appels récents 85 Recherche des détails sur un appel récent 86 Retour d'un appel récent à partir de la liste Récents 86 Création d’un nouveau contact local à partir d’un enregistrement d'appel récent 86 Ajouter des informations d’appel récentes à un contact local 87 Suppression d'une entrée du journal d'appels 87 Effacement de la liste des appels récents 87 CHAPITRE 6 Applications 89 Appl. et bouton Application 89 Utilisation de l'application Push to Talk 89 CHAPITRE 7 Paramètres 91 Accès à l'application Paramètres 91 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX vii Table des matières Accès aux paramètres du téléphone 91 Passage au mode vibreur pour un appel entrant 92 Sélection de l’endroit où la sonnerie retentit 92 Modification de la sonnerie 92 Réglage du retour de casque 93 Désactivation des sons du clavier 93 Régler le filtre de bruit de fond 93 Réglage de la luminosité de l'écran 93 Modification de la taille de la police 94 Contrôle du voyant LED 94 Changement du délai d’expiration de l’affichage 95 Modification du fond d'écran 95 Verrouillage automatique du clavier 95 Réglages de la date et de l'heure 96 Régler l’affichage du niveau de la batterie 98 Accès aux paramètres Bluetooth 99 Activation de Bluetooth 99 Ajout d’un nouveau casque Bluetooth 99 Connexion d’un casque Bluetooth 100 Changement du nom d’un casque Bluetooth 100 Déconnexion d'un casque Bluetooth 101 Suppression d’un casque Bluetooth 101 Accès aux paramètres d’administration 101 Réglage du volume lors d'un appel 102 Réglage du volume de la sonnerie du téléphone 102 CHAPITRE 8 Accessoires 103 Accessoires pris en charge 103 Casques 104 Informations importantes relatives à la sécurité des casques 104 Casques standard 105 Casques Bluetooth 105 Conseils relatifs au casque 105 Chargeurs de bureau 105 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX viii Table des matières Configuration du chargeur de bureau 107 Chargement du téléphone avec le chargeur de bureau 107 Chargez la batterie de rechange avec le chargeur de bureau 109 Chargeurs multiples 109 Configuration du chargeur multiple 110 Installation du kit de fixation murale pour chargeur multiple 111 Chargement du téléphone avec le chargeur multiple 113 Chargez la batterie de rechange avec le chargeur multiple 114 Sécurisation du chargeur à l’aide d’un câble de verrouillage 114 CHAPITRE 9 Dépannage 115 Informations générales de dépannage 115 Recherche d’informations relatives à votre téléphone 117 Diagnostics du matériel 117 Exécution des diagnostics audio 118 Exécution de diagnostics WLAN 118 Champs Diagnostics WLAN 118 Créer un rapport de problème à partir du téléphone 120 CHAPITRE 1 0 Sûreté et sécurité du produit 123 Consignes de sécurité et renseignements relatifs aux performances 123 Consignes de sécurité 124 Avis de sécurité relatifs à la batterie 124 Environnements dangereux 126 Panne d’électricité 126 Domaines réglementaires 126 Environnements médicaux 127 Utilisation de périphériques externes 127 Comportement du téléphone en cas d’encombrement du réseau 127 DAS 128 Déclarations de conformité 128 Déclarations de conformité pour l'Union européenne 128 Marquage CE 128 Déclaration sur l’exposition aux fréquences radio de l’Union européenne 128 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX ix Table des matières Déclarations de conformité pour les États-Unis 128 Déclaration relative au DAS 128 Informations relatives à l'exposition aux fréquences radio 129 Informations générales sur la conformité des appareils RF 130 Appareil radio conforme à l’article 15 130 Déclarations de conformité pour le Canada 130 Déclaration de conformité pour le Canada 131 Déclarations de conformité pour la Nouvelle-Zélande 132 Avertissement général relatif à Permit to Connect (PTC) 132 Utilisation de réseaux IP avec PSTN 132 Utilisation de la compression vocale par le biais de PSTN 132 Annulation d'écho 132 Déclarations de conformité pour Taïwan 133 Déclaration d’avertissement DGT 133 Déclarations de conformité pour l'Argentine 133 Déclaration de conformité pour le Brésil 133 Déclaration de conformité pour Singapour 134 Présentation de la sécurité des produits Cisco 134 Informations importantes en ligne 134 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX x Table des matières CHAPITRE 1 Votre téléphone • Téléphones IP sans fil Cisco 8821 et 8821-EX, à la page 1 • Nouveautés et mises à jour, à la page 4 • Démarrage, à la page 6 • Portail d'aide en libre-service, à la page 9 • Touches et matériel, à la page 11 • Entretien de votre téléphone, à la page 21 • Aide et informations complémentaires, à la page 25 Téléphones IP sans fil Cisco 8821 et 8821-EX Les TéléphonesIPsansfil Cisco 8821 et 8821-EX sont des périphériquessansfil 802.11 bibande qui délivrent des communications vocales en association avec Cisco Unified Communications Manager et avec les points d'accès Cisco Aironet et Cisco Meraki dans un réseau de communications d'entreprise privé. Les téléphones permettent une communication vocale via le même LAN sans fil que votre ordinateur. Ainsi, vous pouvez passer et recevoir des appels, mettre des appels en garde, transférer des appels, établir des conférences, etc. Le Téléphone IP sans fil Cisco 8821-EX est certifié ATEX (atmosphère potentiellement explosive) zone 2 IP54 (en cours) et Amérique du Nord Classe 1 Division 2/Zone 2. Le téléphone est certifié pour une utilisation dans des environnements où il existe des risques d’explosion (dangereux) où des gaz, des vapeurs ou des liquides inflammables peuvent être présents pendant une brève période ou dans des conditions anormales. Le téléphone est de couleur jaune, conformément aux normes de l'industrie, ce qui permet de le reconnaître rapidement en cas d'urgence. La figure suivante illustre le Téléphone IP sans fil Cisco 8821 à gauche et le Téléphone IP sans fil Cisco 8821-EX à droite. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 1 Illustration 1 : Téléphones IP sans fil Cisco 8821 et 8821-EX Cestéléphones, comme d'autres périphériquesréseau, doivent être configurés et gérés. Lestéléphones prennent en charge les codecs G.711a, Codecs G.711u, G.722, G.729a, G.729ab, iLBC, iSAC, et OPUS. Lestéléphones prennent également en charge l'audio large bande non compressé (16 bits, 16 kHz). Les téléphones sont compatibles avec les prothèses auditives (HAC, Hearing Aid Compatible) mais ne sont pas dotés de fonctions de téléscripteur. Ils comportent des picots sur les bords de la touche 5, qui est un repère tactile. Les caractéristiques physiques sont : • Résistance aux dégâts causés par les chutes du téléphone • Tolérance au nettoyage antibactérien et à l'alcool • Exempt de latex et de plomb • Résistance aux chocs et aux vibrations • Interface USB On-the-Go (OTG) 2.0 • Téléphone IP sans fil Cisco 8821: Protection IP54 qui indique un équipement résistant à la poussière et à l'eau (voir ci-dessous) • Téléphone IP sans fil Cisco 8821-EX seulement : • Protection IP67 dans les emplacements ordinaires • Certifié pour une utilisation dans une atmosphère potentiellement explosive : • ATEX zone 2 IP54 (en cours) • METLABS certifié pour les classes I et II, division 2 et catégorie III, divisions 1 et 2, groupes A, B, C et D. • La couleur jaune conforme aux normes de l'industrie permet de le reconnaître en cas d'urgence. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 2 Votre téléphone Téléphones IP sans fil Cisco 8821 et 8821-EX • Chargez à l'aide d'un chargeur de bureau pour un seul téléphone ou d'un chargeur multiple pour un maximum de 6 téléphones. Pour plus de détails, consultez la section Accessoires pris en charge, à la page 103. Votre téléphone peut en outre proposer desfonctions d'optimisation de la productivité, qui permettent d'étendre les capacités de base de gestion des appels. En fonction de façon dont il a été configuré, votre téléphone prend en charge : • L'utilisation de casques sans fil Bluetooth, notamment de fonctions d'appel mains libres • Un accès sans fil à votre numéro de téléphone et au répertoire d'entreprise • L'accès aux données du réseau, aux applications XML et aux services Web • La personnalisation en ligne des fonctions et services du téléphone à partir du portail Self Care Pour éviter tout endommagement de l’appareil : • Ne vous baignez pas ou ne nagez pas avec le téléphone. • N'exposez pas le téléphone à de l'eau sous pression ou courante, par exemple lors d'une douche, d'un nettoyage ou d'un lavage des mains. • N’utilisez pas le téléphone dans un sauna ou un hammam. • Ne plongez pas intentionnellement le téléphone dans l’eau. • Ne pas utiliser le téléphone en dehors des plages de température suggérées ou dans des conditions extrêmement humides, chaudes ou froides. • Ne stockez paslestéléphones, les batteries et les accessoires en dehors des plages de température suggérées ou dans des conditions extrêmement humides, chaudes ou froides. • Ne laissez pas tomber le téléphone et ne le soumettez pas à d'autres chocs. • Ne démontez pas le téléphone ; n’enlevez pas les vis. • N'utilisez pas d'agents de nettoyage agressifs, comme l'eau de Javel et autres produits chimiques, pour nettoyer l'extérieur du téléphone. • N'utilisez pas un couvercle de pile cassé ou un couvercle de pile dont le joint est brisé. Minimisez l'exposition de votre téléphone au savon, aux détergents, aux acides ou aux aliments acides et à tout liquide ; par exemple, à l'eau salée, à l'eau savonneuse, à l'eau de piscine, aux parfum, insecticide, lotions, crème solaire, écran solaire, huile, dissolvant pour adhésif, colorant capillaire, boissons gazeuses et solvants. Pour plus de détails, consultez la section Entretien de votre téléphone, à la page 21. IP54 et IP67 Les Téléphones IP sans fil Cisco 8821 et 8821-EX sont testés dans des conditions contrôlées de laboratoire selon la norme CEI 60529. Le Téléphone IP sans fil Cisco 8821 a une classification de IP54 et Téléphone IP sans fil Cisco 8821-EX a une classification de IP67 dans les emplacements ordinaires. L'indice de protection de niveau 54 (IP54) et 67 (IP67) indique que l'équipement est étanche à la poussière et est protégé contre l'eau. La résistance aux éclaboussures, à l'eau et à la poussière ne sont pas des conditions permanentes, et la résistance pourrait diminuer en raison de l'usure normale. Les utilisateurs doivent prendre soin du téléphone et ne doivent pas exposer délibérément l'appareil à un environnement hostile de poussière, d'éclaboussures ou d'immersion dans l'eau. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 3 Votre téléphone Téléphones IP sans fil Cisco 8821 et 8821-EX Sujets connexes Environnements dangereux, à la page 126 Prise en charge des fonctionnalités Nouveautés et mises à jour Nouveautés et modifications des informations concernant la prise en charge du téléphone IP sans fil Cisco 8821-EX Les mises à jour suivantes ont été apportées au document. Fonctionnalités Description Téléphones IP sans fil Cisco 8821 et 8821-EX, à la page 1 Batteries du téléphone, à la page 19 Installer la batterie du Téléphone IP sans fil Cisco 8821-EX, à la page 32 Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX, à la page 41 Accessoires pris en charge, à la page 103 Chargeurs de bureau, à la page 105 Chargeurs multiples, à la page 109 Téléphone IP sans fil Cisco 8821-EX Assistance Nouveautés et informations mises à jour relatives à la version 11.0 (5) SR1 du micrologiciel Les mises à jour suivantes ont été apportées au document. Fonctionnalités Description Mises à jour mineures Batteries du téléphone, à la page 19 Nouveautés et informations mises à jour relatives à la version 11.0 (5) du micrologiciel Le tableau suivant décrit les modifications apportées à ce guide pour prendre en charge la version du micrologiciel 11.0 (5). Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 4 Votre téléphone Prise en charge des fonctionnalités Nom de la caractéristique Mises à jour Batteries du téléphone, à la page 19 Chargeurs de bureau, à la page 105 Chargeurs multiples, à la page 109 Nouveaux chargeurs pour le Téléphone IPsans fil Cisco 8821 Icônes d’en-tête, à la page 16 Passer un appel vers un numéro favori à partir de l’écran Applications, à la page 57 Refus d’un appel, à la page 60 Plusieurs sections modifiées dans Favoris, à la page 74 Plusieurssections modifiées dans Contactslocaux, à la page 75 Création d’un nouveau contact local à partir d’un enregistrement d'appel récent, à la page 86 Exécution des diagnostics audio, à la page 118 Régler l’affichage du niveau de la batterie, à la page 98 Améliorations de l’interface utilisateur Téléphones IP sans fil Cisco 8821 et 8821-EX, à la page 1 Installer la batterie du Téléphone IP sans fil Cisco 8821, à la page 27 Remplacer la batterie du Téléphone IP sans fil Cisco 8821, à la page 36 Suite à des modificationsrécentes du matériel, le téléphone IP sans fil Cisco 8821 est désormais certifié pour la norme IP54 de protection contre les insertions, et n'est plus certifié pour la norme IP67 de protection contre les insertions. Nouveautés et informations mises à jour relatives à la version 11.0 (4) du micrologiciel Le tableau suivant décrit les modifications apportées à ce guide pour prendre en charge la version du micrologiciel 11.0 (4). Nom de la caractéristique Mises à jour Touches et matériel, à la page 11 a été mis à jour pour discuter de la navigation. Fonctions à l’écran du téléphone, à la page 15 a été mis à jour. Écran d'accueil, à la page 17 a été ajouté pour décrire les options de l’écran d’accueil. Beaucoup de procédures d'accès à l'application ont été mises à jour. Écran d’accueil configurable Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 5 Votre téléphone Nouveautés et informations mises à jour relatives à la version 11.0 (4) du micrologiciel Nom de la caractéristique Mises à jour Le téléphone peut être endommagé si voussoufflez ou utilisez de l’air comprimé sur les microphones, de sorte que des déclarations de prudence supplémentaires sont ajoutées à : • Entretien de votre téléphone, à la page 21 • Nettoyage de l’extérieur du téléphone, à la page 22 • Si votre téléphone tombe dans de l’eau, à la page 23 Amélioration des instructions de nettoyage Favoris, à la page 74 et Contacts locaux, à la page 75 leurs sous-sections ont été ajoutées au chapitre « Contacts » . Contacts locaux Créer un rapport de problème à partir du téléphone, à la page 120 décrit comment signaler un problème de téléphone. Outil de rapport de problème Modification du fond d'écran, à la page 95 a été mis à jour pour les nouveaux fonds d’écran. Fonds d’écran redimensionnés Réglage de la luminosité de l'écran, à la page 93et Changement du délai d’expiration de l’affichage, à la page 95 ont été mis à jour avec les informations de paramètre par défaut. Améliorations de l’interface utilisateur Informations importantes relatives à la sécurité des casques, à la page 104 Ajoutées. Mises à jour générales Nouveautés et informations mises à jour relatives à la version 11.0 (3) du micrologiciel Le tableau suivant contient les informations qui ont été ajoutées ou modifiées dans ce manuel pour cette version du micrologiciel. Fonctionnalité Mises à jour Régler le filtre de bruit de fond, à la page 93 Conseils relatifs au casque, à la page 105 Filtre de bruits de fond Améliorations de l’économie d’énergie Batteries du téléphone, à la page 19 Démarrage Lisez la section Sûreté et sécurité du produit, à la page 123 avant d'installer ou de charger la batterie. Votre téléphone est alimenté par une batterie Lithium ion rechargeable. Pour pouvoir utiliser votre téléphone, vous devez y insérer la batterie et la charger. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 6 Votre téléphone Nouveautés et informations mises à jour relatives à la version 11.0 (3) du micrologiciel Votre téléphone doit se connecter au réseau sans fil d'entreprise et au réseau de téléphonie IP. Votre administrateur peut configurer votre nouveau téléphone sansfil, mais vous devrez peut-être le faire vous-même. Une fois le téléphone configuré, vous pouvez l’utiliser. Sujets connexes Configuration du téléphone, à la page 27 Batteries du téléphone, à la page 19 Activation de votre téléphone Afin d'économiser la batterie, le téléphone s’éteint automatiquement lorsqu’il n’est pas utilisé. Vous devez rallumer le téléphone pour pouvoir l'utiliser. Pour allumer le téléphone, vous devrez peut-être saisir un nom d'utilisateur et un mot de passe pour accéder au réseau sans fil. Après l'authentification et l'enregistrement du téléphone auprès du système de contrôle des appels, l'écran principal s'affiche et vous pouvez passer ou prendre des appels. Procédure Appuyez et maintenez la pression sur Alimentation/Find'appel jusqu’à ce que le voyant rouge s'allume. Connexion au téléphone Si un écran de connexion s'affiche lorsque vous allumez votre téléphone, vous devez saisir votre nom d'utilisateur et votre mot de passe pour accéder aux fonctions du téléphone. Vous devrez peut-être aussi saisir d'autresinformations,selon les exigences de sécurité du réseau sansfil. Communiquez avec votre administrateur pour obtenir de l'aide. Procédure Étape 1 Entrez votre ID utilisateur. Étape 2 Entrez votre mot de passe. Désactivation de votre téléphone Pour économiser la batterie, désactivez le téléphone lorsque vous n'avez pas besoin de passer ou de recevoir des appels. Procédure Étape 1 Appuyez et maintenez la pression sur Alimentation/Fin d'appel pendant 4 secondes. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 7 Votre téléphone Activation de votre téléphone Étape 2 Appuyez sur Désactivé. Sujets connexes Changement du délai d’expiration de l’affichage, à la page 95 Verrouillage du clavier du téléphone Vous pouvez verrouiller le clavier pour ne pas appuyer sur des touches par inadvertance. Procédure Appuyez et maintenez la pression sur Zéro (0) jusqu’à ce qu’un message vous indique que le clavier est verrouillé. Sujets connexes Verrouillage automatique du clavier, à la page 95 Déverrouillage du clavier du téléphone Si vous verrouillez le clavier, vous devez le déverrouiller pour pouvoir utiliser le téléphone. Procédure Étape 1 Appuyez sur Déverrouiller. Étape 2 Appuyez sur Zéro (0) . Accès à votre messagerie vocale Pour accéder à votre messagerie vocale, appelez le numéro de téléphone de votre système de messagerie vocale. Cependant, si votre administrateur a activé l’accès rapide, vous pouvez accéder à la messagerie vocale en appuyant simplement sur un bouton. Le bouton appelle automatiquement le système de messagerie vocale à votre place. Le système de messagerie vocale et le téléphone sont deux entités distinctes. Pour plus d’informations sur les numéros de téléphone de système de messagerie vocale pour l'accès en interne et en externe, ou pour d’autres informations sur le système de messagerie vocale, communiquez avec votre administrateur. Procédure Étape 1 Appuyez et maintenez la pression sur la touche Un (1) du clavier numérique. Étape 2 Suivez les invites. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 8 Votre téléphone Verrouillage du clavier du téléphone Portail d'aide en libre-service Vous pouvez personnaliser certains paramètres du téléphone sur le site Web du portail d'aide en libre-service, auquel vous pouvez accéder depuis votre ordinateur. Le portail d'aide en libre-service fait partie du Cisco Unified Communications Manager de votre société. Votre administrateur peut vous fournit l'URL pour accéder au portail d'aide en libre-service et vous fournir votre ID utilisateur et mot de passe. Dans le portail d'aide en libre-service, vous pouvez contrôler les fonctionnalités, les paramètres de ligne et les services téléphoniques de votre téléphone. • Les fonctionnalités du téléphones incluent la numérotation abrégée, la fonction Ne pas déranger et votre carnet d'adresses personnel. • Les paramètres de ligne ont une incidence sur une ligne donnée (numéro de répertoire) de votre téléphone. Les paramètres de ligne peuvent inclure le renvoi d'appels, les indicateurs visuels et sonores de messages, les modèles de sonnerie et d'autres paramètres spécifiques à la ligne. • Les services téléphoniques peuvent inclure des fonctions spéciales, des données de réseau et des informations basées sur le Web (par exemple, les cours de la bourse ou les programmes de cinéma). Utilisez le portail d'aide en libre-service pour vous abonner à un service téléphonique avant de pouvoir y accéder sur votre téléphone. Le tableau suivant décrit certaines des fonctionnalités que vous pouvez configurer à l'aide du portail d'aide en libre-service. Pour obtenir plus d'informations, reportez-vous à la documentation du portail d'aide en libre-service relative à votre système de contrôle des appels. Tableau 1 : Fonctionnalités offertes sur le Portail en libre-Service Rôles Description Utilisez le numéro devant recevoir les appels lorsque le renvoi d'appel est activé sur le téléphone. Utilisez le portail d'aide en libre-service pour configurer des fonctions de renvoi d'appel plus complexes, par exemple lorsque votre ligne est occupée. Appel réacheminé Indiquez les téléphones supplémentaires (tels que votre portable) à utiliser pour passer et recevoir des appels en utilisant les mêmes numéros de répertoire que ceux de votre téléphone de bureau. Vous pouvez également définir les contacts bloqués et préférés, pour interdire ou autoriser que les appels provenant de certains numérossoient envoyés à votre téléphone portable. Lors de la configuration de téléphones supplémentaires, vous pouvez également configurer les fonctionnalités suivantes : • Numéro d'appel unique : indiquez si le téléphone supplémentaire doit sonner lorsqu’une personne appelle votre téléphone de bureau. • Appels mobiles : si le téléphone supplémentaire est un téléphone portable, vous pouvez le configurer afin qu’il soit possible de transférer les appels mobiles vers votre téléphone de bureau, ou les appels de votre téléphone de bureau vers votre téléphone portable. Téléphones supplémentaires Affectez des numéros de téléphone à des numéros simplifiés afin de pouvoir appeler rapidement ces numéros. Numérotation simplifiée Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 9 Votre téléphone Portail d'aide en libre-service Numéros abrégés Lorsque vous composez un numéro sur votre téléphone, vous saisissez une série de chiffres. Lorsque vous configurez un numéro simplifié, ce dernier doit contenir tous les chiffres nécessaires pour passer l’appel. Par exemple, si vous devez composer le 9 pour passer un appel externe, vous devez saisir le numéro 9, puis le numéro à appeler. Vous pouvez également ajouter à ce numéro, d’autres chiffres à composer. Ces chiffres supplémentaires peuvent représenter un code d'accès à une réunion, un numéro de poste, un mot de passe de messagerie vocale, un code d’autorisation ou un code de facturation. La chaîne de numérotation peut contenir les caractères suivants : • 0 à 9 • Dièse (#) • Astérisque () • La virgule (,) - il s’agit du caractère de pause, qui insère un délai de 2 secondes dans la chaîne de numérotation. Vous pouvez saisir plusieurs virgules consécutives dans la chaîne. Par exemple, deux virgules (,,) représentent une pause de 4 secondes. Les règles suivantes s’appliquent aux chaînes de numérotation : • Utilisez des virgules pour séparer les parties de la chaîne de numérotation. • Un code d'autorisation doit toujours précéder un code de facturation dans la chaîne de numérotation. • Une seule virgule est nécessaire entre le code d'autorisation et le code de facturation dans la chaîne. • Une étiquette de numérotation abrégée est requise pour les numéros simplifiés qui comportent des codes d’autorisation et des chiffres supplémentaires. Avant de configurer la numérotation abrégée, composez manuellement les chiffres au moins une fois pour vous assurer que la séquence de chiffres est exacte. Votre téléphone n'enregistre pas le code d'autorisation, le code de facturation ou les chiffres supplémentaires de la numérotation abrégée dans l'historique des appels. Si vous appuyez sur Bis après vous être connecté à une destination à l'aide de la numérotation abrégée, le téléphone vousinvite à saisir manuellement les éventuels code d'autorisation, code de facturation ou chiffres supplémentaires. Exemple Pour configurer un numéro simplifié afin d’appeler une personne à un numéro de poste donné, et si un code d’autorisation et un code de facturation sont nécessaires, procédez comme suit : • Vous devez composer le 9 pour joindre une ligne externe. • Vous voulez appeler le 5556543. • Vous devez saisir le code d’autorisation 1234. • Vous devez saisir le code de facturation 9876. • Vous devez patienter pendant 4 secondes. • Lorsque l’appel est connecté, vous devez saisir le numéro de poste 56789#. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 10 Votre téléphone Numéros abrégés Dans ce cas, le numéro simplifié est 95556543,1234,9876,,56789#. Sujets connexes Appels nécessitant un code de facturation ou un code d’autorisation, à la page 58 Touches et matériel Le téléphone sans fil est équipé de plusieurs boutons et fonctionnalités matérielles que vous utiliserez régulièrement. Reportez-vous à la figure et au tableau ci-après pour identifier les boutons et fonctionnalités importants du téléphone. La figure suivante illustre le Téléphone IP sans fil Cisco 8821, le Téléphone IP sans fil Cisco 8821-EX a un aspect similaire. Illustration 2 : Téléphone IP sans fil Cisco 8821 Touches et matériel Le tableau suivant décrit les fonctions des touches des téléphones. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 11 Votre téléphone Touches et matériel Élément Nom ou regroupement Description Témoin lumineux : permet d’identifier les différents états : • Rouge fixe : le téléphone est branché sur secteur et la batterie est en charge. • Vert fixe : le téléphone est branché sur secteur et la batterie est entièrement chargée. • Orange clignotant rapidement : vous avez un appel entrant. La batterie peut être en cours de chargement ou entièrement chargée. • Vert clignotant rapidement : vous avez un message vocal. Lorsque le téléphone est branché sur secteur, le témoin lumineux vert s'affiche plus longtemps que lorsqu'il est alimenté uniquement par la batterie. • Vert clignotant lentement (toutes les 2 secondes) : le téléphone est alimenté uniquement par la batterie. Le téléphone est enregistré auprès du réseau sans fil et il se trouve dans la zone couverte par le service. Port casque avec . Enlevez le cache de protection et branchez un casque ou des oreillettes dans le port. Témoin lumineux (LED) Port casque 1 Petitboutoncirculaire du Active ou désactive le mode Haut-parleur sur le téléphone. 2 Bouton haut-parleur Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 12 Votre téléphone Touches et matériel Élément Nom ou regroupement Description Touches programmables • La touche programmable Autres permet d’accéder à une liste de menus ou de fonctions. • La touche programmable active l’option affichée à l'écran. Bouton circulaire du . Bouton de navigation et de Sélection Anneau de navigation (anneau extérieur) : • Déplacez-vous vers le haut, le bas, la gauche ou la droite dans la vue applications pour sélectionner ces applications : • Récents • Contacts • Apps • Paramètres • Faites défiler les menus vers le haut et vers le bas pour mettre des options en surbrillance et pour vous déplacer vers la droite et la gauche parmi les numéros de téléphone et les entrées textuelles. • En mode ligne, appuyez à gauche sur l’anneau de navigation pour accéder à la vue Applications. Bouton Sélect. (au centre du cluster) : • Permet de passer un appel à partir de l’écran principal. • Permet de sélectionner un élément de menu, une touche programmable, un appel ou une action. Répond./Envoyer Permet de répondre à un appel qui sonne ou, après avoir composé un numéro, de passer un appel. Mise en marche/Fin d'appel Permet d’activer ou de désactiver le téléphone, de mettre fin à un appel connecté. Lorsque vous utilisez les menus ou une application, fait office de raccourci pour revenir à l'écran principal. Touches programmables Cluster de navigation Boutons de contrôle d'appel 3 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 13 Votre téléphone Touches et matériel Élément Nom ou regroupement Description Permet de composer des numéros de téléphone, de saisir des lettres et de sélectionner des options de menu via un numéro. Un (1) • Entrez « 1 » lorsque vous composez un numéro. • Accédez à la messagerie vocale. Appuyez et maintenez la pression pour appeler automatiquement le système de messagerie vocale. • Saisissez ces caractères spéciaux : / . @ : ; = ? - _ & % Astérisque () • Avant de composer un numéro de téléphone international, appuyez et maintenez la pression pendant quelques secondes pour ajouter le symbole plus (+) au numéro de téléphone. • Saisissez ces caractères spéciaux : + ~ ` < > Zéro (0) • Entrez « 0 » lorsque vous composez un numéro. • Verrouiller le clavier. • Entrez un espace ou ces caractères spéciaux : 0 , ! ^ ' " | Dièse (#) • Appuyez pour désactiver la sonnerie du téléphone. Lorsque cette option est configurée, le téléphone passe en mode vibreur. • Saisissez ces caractères spéciaux : # $ £ ¤ ( ) { } [ ] 4 Clavier Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 14 Votre téléphone Touches et matériel Élément Nom ou regroupement Description Petit bouton allongé À utiliser avec les applications XML telles que Push to Talk. Volume • Lorsque le téléphone est inactif, change le volume de la sonnerie ou désactive la sonnerie. • Lors d'un appel entrant (quisonne), appuyez une foissur le bouton pour désactiver la sonnerie. • Au cours d'un appel, contrôle le volume du haut-parleur du combiné, du casque ou du haut-parleur actif. • Lorsque le téléphone est placé sur le chargeur de bureau, contrôle le volume du haut-parleur du chargeur. Silence Active ou désactive le mode silence. 5 Côté gauche Navigation Utilisez l’anneau externe du cluster de navigation pour parcourir les menus et vous déplacer entre les champs. Appuyez sur la touche Sélect. à l’intérieur du bloc de navigation pour sélectionner des éléments du menu. Si un élément de menu comporte un numéro d’index, vous pouvez entrer le numéro d’index avec le clavier pour sélectionner l’élément. Fonctions à l’écran du téléphone L’écran du téléphone affiche des informations sur le téléphone, telles que le numéro de répertoire, l'appel actif et l'état de la ligne, les touches, les numéros simplifiés et les appels passés. L'écran est constitué des sections suivantes : • Section supérieure : présente le numéro de téléphone, la puissance du signal Wi-Fi, la charge de la batterie et plusieurs icônes de fonctionnalités. Les icônes de fonctionnalités sont affichées lorsque les fonctionnalités correspondantes sont activées. • Section du milieu : affiche l’écran d’accueil. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 15 Votre téléphone Navigation • Section inférieure : affiche la date et l'heure actuelles ou les libellés de touches programmables. Chaque libellé de touche programmable indique l’action associée à une touche programmable située sousl’écran. Sujets connexes Écran d'accueil, à la page 17 Icônes d’en-tête L’en-tête d’écran affiche de nombreuses icônes. Les tableaux suivants interprètent ces icônes. Tableau 2 : Icônes de chemin audio Icône Description Le haut-parleur ou le haut-parleur du chargeur de bureau est en cours d'utilisation. Un casque filaire ou Bluetooth est en cours d’utilisation. Le téléphone est en mode Silence. Le téléphone est en mode silencieux. Ce mode se produit lorsque vous éteignez la sonnerie à partir du menu Paramètres . Tableau 3 : Icônes Bluetooth Icône Description Bluetooth est activé. Un appareil est connecté au Bluetooth. Bluetooth est allumé, mais aucun périphérique n’est connecté. Tableau 4 : Icônes du réseau Icône Description Le Wi-Fi est connecté et le nombre de barres indique la force du signal. Il n’y a pas de connexion Wi-Fi Le téléphone est connecté à l’Ethernet avec la clé USB Ethernet. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 16 Votre téléphone Icônes d’en-tête Par défaut, votre téléphone affiche les icônes de charge de la batterie. Vous pouvez autoriser le téléphone à afficher le niveau de la batterie sous forme de pourcentage. Pour plus de détails, consultez la section Régler l’affichage du niveau de la batterie, à la page 98. Tableau 5 : Icônes de batterie Icône Description La batterie est complètement chargée. La charge de la batterie est d’environ 75 %. La charge de la batterie est d’environ 50 %. La charge de la batterie est d’environ 25 %. La charge de la batterie est inférieure à 25 %. La batterie est vidée. Rechargez la batterie ou remplacez-la par une batterie chargée. Il n’y a pas de batterie détectée. Écran d'accueil Lorsque votre téléphone est inactif, l’écran d’accueils’affiche. L’écran d’accueil peut être soit la vue application, soit la vue ligne. Votre administrateur détermine l’écran d’accueil qui s’affiche sur votre téléphone. Si vous passez ou recevez fréquemment des appels, vous préférerez peut-être que l'affichage des lignes soit votre écran d'accueil par défaut. La figure suivante est un écran d’accueil dans la vue application. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 17 Votre téléphone Écran d'accueil Illustration 3 : Vue Application La figure suivante est un écran d’accueil en mode ligne.Pour accéder à l’écran Applications, appuyez à gauche sur l’anneau de navigation. Illustration 4 : Vue en mode Ligne Différences entre les lignes téléphoniques et les appels Les termes lignes et appels sont utilisés ici de manière très précise pour expliquer comment utiliser votre téléphone. Voici une explication des différences entre ces deux termes. Lignes Chaque ligne est associée à un numéro de répertoire ou à un numéro intercom, que vos contacts peuvent utiliser pour vous appeler. Le téléphone prend en charge jusqu'à six lignes. Pour voir vos lignes téléphoniques, appuyez Téléphone pour ouvrir l’affichage des lignes. Vous disposez d'autant de lignes que de numéros de répertoire et d'icônes de lignes téléphoniques dans l'affichage des lignes. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 18 Votre téléphone Différences entre les lignes téléphoniques et les appels Appels Chaque ligne peut prendre en charge plusieurs appels, en général quatre au maximum. Le téléphone peut prendre en charge un maximum de 24 appels connectés, mais votre administrateur système peut adapter ce nombre à vos besoins. Un seul appel peut être actif à la fois; les autres appels sont automatiquement mis en garde. Par exemple, si vous disposez de deux lignes prenant chacune en charge quatre appels, un maximum de huit appels peuvent être connectés simultanément. Seul l’un de ces appels est actif et les sept autres appels sont mis en garde. Alertes de sortie de portée Votre administrateur système peut configurer votre téléphone pour qu'il vous alerte de manière sonore (un bip) lorsque vous êtes hors de la zone de couverture du réseau sans fil. Quand vous entendez l'alerte, l'icône (pas de signal) s'affiche sur l'écran du téléphone. Lorsque que vous n'êtes plus dans une zone couverte par le réseau sans fil, vous ne pouvez pas utiliser le téléphone pour des fonctions requérant une connexion au réseau sans fil, telles que l'émission et la réception d'appels. Si votre administrateur système a activé l'alerte Hors de portée, vous pouvez, en fonction de la configuration utilisée, entendre un seul bip ou un bip toutes les 10, 30 ou 60 secondes jusqu'à ce que vous soyez de nouveau dans la zone couverte par le réseau sans fil. Pour vous raccorder de nouveau au réseau sans fil après avoir entendu l'alerte, déplacez-vous jusqu'à ce que vous voyiez de nouveau l'icône de signal sur l'écran du téléphone. Batteries du téléphone Votre téléphone contient une batterie Lithium ion. Lorsque la batterie est entièrement chargée, elle fournit les heures de service suivantes : • Jusqu’à 11.5 heures de durée de conversation (dépend du micrologiciel du téléphone et de la version du chargeur) Le tableau suivant montre les différences de durée de conversation lorsque vous utilisez : • Le nouveau 4.35 V Chargeur de bureau pour téléphone IP sans fil Cisco 8821 et Multi chargeur pour Téléphone IP sans fil Cisco 8821 • Le Chargeur de bureau pour Téléphone IPsans fil Cisco 8821-EX et Multichargeur pour Téléphone IP sans fil Cisco 8821-EX Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 19 Votre téléphone Alertes de sortie de portée Tableau 6 : Comparaison des durées de conversation Chargeur de bureau pour Téléphone IP sans fil Cisco 8821-EX et Multichargeur pour Téléphone IP sans fil Cisco 8821-EX Nouveau Chargeur de bureau pour téléphone IP sans fil Cisco 8821 et Multi chargeur pour Téléphone IP sans fil Cisco 8821 Original Chargeur de bureau pour téléphone IP sans fil Cisco 8821 et Multi chargeur pour Téléphone IP sans fil Cisco 8821 Condition Téléphone chargé dans 9,5 heures 9,5 heures 9,5 heures le chargeur, avec adaptateur mural, ou avec USB Téléphone exécutant le micrologiciel version 11.0 (4) SR3 ou antérieure Téléphone chargé dans 11,5 heures 11,5 heures 9,5 heures le chargeur, avec adaptateur mural, ou avec USB Téléphone exécutant le micrologiciel version 11.0 (4) SR3 ou supérieure Batterie de rechange 9,5 heures 11,5 heures 9,5 heures chargée dans l'emplacement de recharge • Jusqu’à 145 heures d'autonomie en mode veille. La durée de vie de la batterie dépend d’un certain nombre de facteurs, notamment : • Durée en marche : la durée de vie de la batterie est réduite lorsque le téléphone est allumé. Les appels, les messages, l'utilisation d'applications, l'utilisation de Bluetooth et des actions telles que la navigation dans le menu utilisent l'alimentation. • Mode de balayage réseau : votre téléphone peut être configuré pour analyser les points d'accès de trois manières différentes(continue, automatique, APunique).Si votre téléphone utilise les modes de balayage Continu ou Automatique, le téléphone nécessite davantage d'énergie, ce qui réduit le temps de conversation de la batterie. Une batterie de rechange chargée peut s'avérer utile pour prolonger la durée de conversation. Bluetooth et votre téléphone Vous pouvez utiliser un casque Bluetooth avec votre téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 20 Votre téléphone Bluetooth et votre téléphone Les connexions Bluetooth sont optimales lorsque la distance vous séparant de votre téléphone est comprise entre 1 et 2 mètres, mais cette distance peut aller jusqu’à 20 mètres. La connexion Bluetooth risque de se dégrader si une barrière (un mur, une porte ou une fenêtre), un objet métallique volumineux ou d’autres périphériques électroniques sont situés entre votre téléphone et le périphérique connecté. Pour connecter un casque à votre téléphone à l'aide de Bluetooth, commencez par jumeler le casque avec votre téléphone. Vous pouvez jumeler jusqu’à 5 casques Bluetooth avec le téléphone. Une fois le casque jumelé, le téléphone s’y connecte lorsque le casque est allumé. Le dernier casque Bluetooth connecté au téléphone est le casque que le téléphone utilise par défaut. Le Téléphone IP sans fil Cisco 8821-EX n’a pas été testé ou certifié pour l’utilisation avec des accessoires dans une atmosphère potentiellement explosive. Remarque Sujets connexes Casques Bluetooth, à la page 105 Accès aux paramètres Bluetooth, à la page 99 Entretien de votre téléphone Vous pouvez nettoyer votre téléphone. Suivez les instructions de nettoyage fournies. Nettoyez immédiatement votre téléphone s'il entre en contact avec tout ce qui peut causer destaches ou d'autres dommages, comme la poussière ou le sable, l'encre, le maquillage, le savon, le détergent, les acides, les aliments acides ou les lotions. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 21 Votre téléphone Entretien de votre téléphone Ne soufflez pas ou n'utilisez pas d'air comprimé (par exemple, provenant de flacons d'aérosol, de buses d'air basse ou haute pression) pour nettoyer les orifices du téléphone. N'utilisez pas d'aspirateur ou un autre appareil d'aspiration pour nettoyer les orifices du téléphone. N’utilisez pas d’épingles ou d’autres objets pour nettoyer les orifices du téléphone. L'utilisation d'objets mécaniques pour nettoyer les orifices, de vide ou d'air risquerait d'endommager le téléphone et d'annuler sa garantie. Mise en garde Si vous faites tomber le téléphone dans de l’eau, ou s'il est éclaboussé, suivez nos instructions pour sécher le téléphone. Consultez la section Si votre téléphone tombe dans de l’eau, à la page 23. Nettoyage de l’extérieur du téléphone Vous pouvez nettoyer l'extérieur du téléphone à l'aide d'un chiffon sec, doux et non pelucheux. Dans les environnements médicaux, il est recommandé d’utiliser deslingettes Caviwipes™ etSaniwipes™ pour nettoyer le téléphone. Ces lingettes contiennent au maximum 17 % d’isopropanol. Toute solution de nettoyage contenant un pourcentage plus élevé d’isopropanol, notamment de l’isopropanol pur ou un liquide équivalent à base d’alcool, risquerait d’endommager le téléphone. Ne nettoyez pas le téléphone à l’eau de Javel ou avec d'autres produits corrosifs. Une utilisation excessive des lingettes Caviwipes et Saniwipes plus de 3 fois par jour endommagera le revêtement de la surface du téléphone et changera l'aspect du téléphone. Nettoyez immédiatement votre téléphone s'il entre en contact avec tout ce qui peut causer destaches ou d'autres dommages, comme la poussière ou le sable, l'encre, le maquillage, le savon, le détergent, les acides, les aliments acides ou les lotions. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 22 Votre téléphone Nettoyage de l’extérieur du téléphone Ne soufflez pas ou n'utilisez pas d'air comprimé (par exemple, provenant de flacons d'aérosol, de buses d'air basse ou haute pression) pour nettoyer les orifices du téléphone. N'utilisez pas d'aspirateur ou un autre appareil d'aspiration pour nettoyer les orifices du téléphone. N’utilisez pas d’épingles ou d’autres objets pour nettoyer les orifices du téléphone. L'utilisation d'objets mécaniques pour nettoyer les orifices, de vide ou d'air risquerait d'endommager le téléphone et d'annuler sa garantie. N'immergez pas le téléphone dans un quelconque liquide. N'utilisez pas un chiffon fortement saturé. Mise en garde Procédure Étape 1 Retirez le téléphone du chargeur ou débranchez le câble de chargement. Étape 2 Si le téléphone est dans un étui de protection, retirez le téléphone de l’étui. Étape 3 Essuyez le téléphone et l'écran avec un chiffon humide, doux et non pelucheux. Étape 4 S'il y a des corps étrangers (par exemple, du sable fin) dans une ouverture du téléphone, tapez le téléphone contre votre main pour déloger ces corps. Si votre téléphone tombe dans de l’eau Si votre téléphone tombe dans de l’eau, procédez comme suit : • Secouez le téléphone avec douceur pour éliminer l’eau. • Essuyez le téléphone avec un chiffon doux et non pelucheux. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 23 Votre téléphone Si votre téléphone tombe dans de l’eau • Laissez votre téléphone dans un endroit sec et aéré ; par exemple, un ventilateur soufflant de l'air frais peut être dirigé sur la grille du haut-parleur du téléphone pour le sécher. Il suffit de ne pas mettre le ventilateur près du téléphone. Voici les choses à ne pas faire : • N’ouvrez pas le volet de la batterie lorsque le téléphone est humide. • N’utilisez pas d'air comprimé pour éliminer l’eau. • N’utilisez pas un sèche-cheveux pour sécher le téléphone. • Ne placez pas un coton-tige, de l'essuie-tout ou un chiffon dans la prise jack du casque ou à l'intérieur du compartiment de la batterie. • Ne cognez pas le téléphone sur une surface dure. • Ne chargez un téléphone humide à l'aide du câble de chargement. Vous devez attendre que le téléphone soit complètement sec. • Ne placez pas un téléphone humide dans le chargeur de bureau, ou le chargeur multiple. Vous devez attendre que le téléphone soit complètement sec. Ne soufflez pas ou n'utilisez pas d'air comprimé (par exemple, provenant de flacons d'aérosol, de buses d'air basse ou haute pression) pour nettoyer les orifices du téléphone. N'utilisez pas d'aspirateur ou un autre appareil d'aspiration pour nettoyer les orifices du téléphone. N’utilisez pas d’épingles ou d’autres objets pour nettoyer les orifices du téléphone. L'utilisation d'objets mécaniques pour nettoyer les orifices, de vide ou d'air risquerait d'endommager le téléphone et d'annuler sa garantie. Mise en garde Pour garantir que de l’eau ne pénètre pas dans le compartiment à batterie, vérifiez que ce dernier est bien fermé. Voir Installer la batterie du Téléphone IP sans fil Cisco 8821, à la page 27. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 24 Votre téléphone Si votre téléphone tombe dans de l’eau Si le son est assourdi après avoir séché le téléphone, il se peut qu'il y ait encore de l'eau dans les compartiments du microphone ou des haut-parleurs. Placez le téléphone, côté du haut-parleur vers le bas, sur un chiffon sec non pelucheux, pour voir si de l'eau s'écoule. S’il y a encore de l’eau dans le téléphone, laissez le téléphone sécher complètement avant de l’utiliser. Aide et informations complémentaires Pour tout renseignement sur les fonctionnalités disponibles sur votre téléphone, communiquez avec votre administrateur. Vous trouverez sur le site Web de Cisco (http://www.cisco.com) des informations supplémentaires sur les téléphones et les systèmes de contrôle des appels. • Les guides de démarrage rapide, les guides d’accessoires et les guides de l’utilisateur en anglais sont disponibles à l'adresse suivante : http://www.cisco.com/c/en/us/support/collaboration-endpoints/unified-ip-phone-8800-series/ products-user-guide-list.html • Les guides dans d'autres langues que l'anglais sont disponibles à l'adresse suivante : http://www.cisco.com/c/en/us/support/collaboration-endpoints/unified-ip-phone-8800-series/ tsd-products-support-translated-end-user-guides-list.html • Les informations d’octroi de licence sont disponibles à l'adresse suivante : http://www.cisco.com/c/en/us/support/collaboration-endpoints/unified-ip-phone-8800-series/ products-licensing-information-listing.html Sujets connexes Dépannage, à la page 115 Conditions générales de la garantie matérielle limitée à un an de Cisco Des conditions spéciales s'appliquent à votre garantie matérielle et aux services qui sont à votre disposition au cours de la période couverte par la garantie. Cette garantie ne s’applique pas aux batteries du téléphone. La déclaration de garantie formelle, notamment les garanties et les accords de licence applicables aux logiciels Cisco sont disponibles sur Cisco.com, à cette adresse : https://www.cisco.com/go/hwwarranty. Garantie de la batterie La batterie est garantie pendant une période de 6 mois après sa date de fabrication. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 25 Votre téléphone Aide et informations complémentaires Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 26 Votre téléphone Garantie de la batterie CHAPITRE 2 Configuration du téléphone • Installation du matériel du téléphone, à la page 27 • Configuration du téléphone, à la page 50 Installation du matériel du téléphone Pour pouvoir utiliser votre téléphone, vous devez insérer la batterie et la charger. Il est possible que la batterie soit déjà dans votre téléphone, mais vous devrez peut-être l’y insérer vous-même. Lisez les informations relatives à la sécurité de la section Sûreté et sécurité du produit, à la page 123 avant d’utiliser, d'installer ou de charger le téléphone. Il est possible que la batterie ait déjà été chargée à l’aide d’une des méthodes agréées. Si la batterie n’est pas chargée, vous devez la charger pour pouvoir configurer le téléphone. Le Téléphone IP sans fil Cisco 8821 et le Téléphone IP sans fil Cisco 8821-EX ont des façons différentes de verrouiller le compartiment de la batterie. Utilisez les procédures adéquates pour votre téléphone. • Téléphone IP sans fil Cisco 8821 • Installer la batterie du Téléphone IP sans fil Cisco 8821, à la page 27 • Remplacer la batterie du Téléphone IP sans fil Cisco 8821, à la page 36 • Téléphone IP sans fil Cisco 8821-EX • Installer la batterie du Téléphone IP sans fil Cisco 8821-EX, à la page 32 • Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX, à la page 41 Mise en garde Installer la batterie du Téléphone IP sans fil Cisco 8821 Utilisez cette tâche pour le Téléphone IP sans fil Cisco 8821 uniquement. Pour le Téléphone IP sans fil Cisco 8821-EX, reportez-vous à la section Installer la batterie du Téléphone IPsans fil Cisco 8821-EX, à la page 32. La conformité IP54 signifie que le téléphone est imperméable à la poussière et à l’eau. Lorsque le téléphone quitte l’usine, il est complètement scellé. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 27 Si vous avez besoin d’ouvrir le compartiment de la batterie, ne l’ouvrez pas dans un environnement poussiéreux ou humide. Assurez-vous que le volet de la batterie est fermé pour vous assurer que la poussière et l’eau ne peuvent pas pénétrer dans le compartiment de la batterie. La poussière, l’huile et d’autres produits peuvent abîmer le joint du couvercle du compartiment à batterie, et compromettre ainsi son étanchéité. Inspectez le joint chaque fois que vous changez la batterie. Si le joint est abîmé, vous pouvez commander un couvercle de rechange. Remarque La durée de vie du téléphone et les fonctions pourraient être affectées si : • La batterie est installée incorrectement. • Le couvercle de la batterie n’est pas correctement fermé. • Le joint en caoutchouc du couvercle de la batterie est mal entretenu. • Le joint en caoutchouc du couvercle de la batterie est abîmé. • Le téléphone tombe régulièrement sur des surfaces dures. Mise en garde Procédure Étape 1 Retirez le couvercle du compartiment à batterie. a) Poussez et maintenez le loquet de verrouillage vers la gauche pour libérer le couvercle. b) Utilisez les languettes sur les côtés du couvercle pour soulever le haut du couvercle et décrochez le couvercle pour déverrouiller les languettes du bas. Étape 2 Installez la batterie. Si vous installez la batterie incorrectement dans le compartiment de la batterie, la batterie et le compartiment de la batterie seront endommagés. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 28 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821 La batterie comporte des contacts métalliques qui doivent toucher les contacts du compartiment de la batterie. La batterie comporte également une flèche dans la partie inférieure et le logo Cisco dans la partie supérieure. Lorsque la pile est correctement insérée, le logo et la flèche sont visibles. La flèche pointe vers le connecteur situé sur la base du téléphone et le logo est près de la patte de verrouillage. Le compartiment de la batterie comporte de petits onglets dans les coins inférieurs. La batterie doit glisser sous ces onglets. Le graphique suivant montre le compartiment de la batterie sans et avec la batterie correctement installée. a) Tenez la batterie de sorte que le bord inférieur soit proche du fond du compartiment. Vérifiez que les contacts métalliques de la batterie et du téléphone sont en face les uns des autres. Sur la batterie, le logo Cisco doit être près de la patte de verrouillage et la flèche doit pointer vers la base du téléphone. Ne forcez pas la batterie dans le compartiment ou vous endommagerez le compartiment et la batterie. Mise en garde b) Glissez la base de la batterie sous les languettes situées au bas du compartiment à piles. c) Appuyez la batterie dans le compartiment jusqu'à ce qu'elle soit à plat dans le compartiment. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 29 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821 Le graphique suivant montre une batterie correctement installée. d) Si la batterie a une languette en plastique léger, la languette doit être plate dans le compartiment. Étape 3 Inspectez le joint à l’intérieur du couvercle du compartiment à batterie et si nécessaire, nettoyez-le à l’aide d’un chiffon humidifié avec de l’eau. N'utilisez pas de produits à base d’ammoniaque ou d'alcool sur le joint. Ces produits abîmeraient le téléphone et annuleraient la garantie du téléphone. Mise en garde Étape 4 Remettez en place le couvercle du compartiment à batterie. Lorsque vous fermez le couvercle de la batterie, vérifiez qu'il est toujours bien fermé. Sinon, de la poussière ou de l’eau peuvent pénétrer dans le compartiment à batterie. Mise en garde a) Alignez les pattes situées sous le couvercle sur les encoches du téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 30 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821 Les onglets s'insèrent dans le téléphone. b) Appuyez fermement le couvercle contre le téléphone jusqu'à ce qu'il s'enclenche. Appuyez sur le haut, le milieu et le bas du couvercle de chaque côté. Appuyez fermement sur le couvercle. Ne forcez pas le couvercle. S'il ne s'enclenche pas facilement, retirez le couvercle et vérifiez que la batterie est correctement insérée. Mise en garde c) Vérifiez que le couvercle est aligné avec le téléphone, puis faites glisser le verrou vers la droite pour verrouiller le couvercle en place. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 31 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821 Installer la batterie du Téléphone IP sans fil Cisco 8821-EX Utilisez cette tâche pour le Téléphone IP sans fil Cisco 8821-EX uniquement. Pour le Téléphone IP sans fil Cisco 8821, reportez-vous à la section Installer la batterie du Téléphone IP sans fil Cisco 8821, à la page 27. La conformité IP67 signifie que le téléphone est imperméable à la poussière et à l’eau. Lorsque le téléphone quitte l’usine, il est complètement scellé. Si vous avez besoin d’ouvrir le compartiment de la batterie, ne l’ouvrez pas dans un environnement poussiéreux ou humide, ou dans un endroit dangereux. N'ouvrez pas le compartiment si la température est inférieure ou égale à 0 °C. Mise en garde Assurez-vous que le volet de la batterie est fermé pour vous assurer que la poussière et l’eau ne peuvent pas pénétrer dans le compartiment de la batterie. La poussière, l’huile et d’autres produits peuvent abîmer le joint du couvercle du compartiment à batterie, et compromettre ainsi son étanchéité. Inspectez le joint chaque fois que vous changez la batterie. Si le joint est abîmé, vous pouvez commander un couvercle de rechange. Remarque Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 32 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821-EX La durée de vie du téléphone et les fonctions pourraient être affectées si : • La batterie est installée incorrectement. • Le couvercle de la batterie n’est pas correctement fermé. • Le joint en caoutchouc du couvercle de la batterie est mal entretenu. • Le joint en caoutchouc du couvercle de la batterie est abîmé. • Le téléphone tombe régulièrement sur des surfaces dures. Mise en garde Procédure Étape 1 Utilisez une pièce de monnaie pour dévisser le couvercle de la batterie et retirez le couvercle du compartiment de la batterie. N'utilisez pas d'objet tranchant pour dévisser le couvercle du compartiment de la batterie ou retirer le couvercle du compartiment de la batterie du téléphone. Mise en garde a) Utilisez une pièce de monnaie pour dévisser la vis et déverrouiller le compartiment de la batterie. La vis demeure dans le couvercle. b) Soulevez et retirez le couvercle du compartiment de la batterie à l'aide de vos doigts, un coin à la fois. Étape 2 Installez la batterie. Si vous installez la batterie incorrectement dans le compartiment de la batterie, la batterie et le compartiment de la batterie seront endommagés. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 33 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821-EX La batterie comporte des contacts métalliques qui doivent toucher les contacts du compartiment de la batterie. La batterie comporte également une flèche dans la partie inférieure et le logo Cisco dans la partie supérieure. Lorsque la pile est correctement insérée, le logo et la flèche sont visibles. La flèche pointe vers le connecteur situé sur la base du téléphone et le logo est près de la patte de verrouillage. Le compartiment de la batterie comporte de petits onglets dans les coins inférieurs. La batterie doit glisser sous ces onglets. Le graphique suivant montre le compartiment de la batterie sans et avec la batterie correctement installée. a) Tenez la batterie de sorte que le bord inférieur soit proche du fond du compartiment. Vérifiez que les contacts métalliques de la batterie et du téléphone sont en face les uns des autres. Sur la batterie, le logo Cisco doit être près de la patte de verrouillage et la flèche doit pointer vers la base du téléphone. Ne forcez pas la batterie dans le compartiment ou vous endommagerez le compartiment et la batterie. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 34 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821-EX b) Glissez la base de la batterie sous les languettes situées au bas du compartiment à piles. c) Enfoncez la batterie dans le compartiment à batterie jusqu’à ce qu’elle s'enclenche. Assurez-vous qu’elle est bien à plat dans le compartiment. d) Si la batterie a une languette en plastique léger, la languette doit être plate dans le compartiment. Étape 3 Inspectez le joint à l’intérieur du couvercle du compartiment à batterie et si nécessaire, nettoyez-le à l’aide d’un chiffon humidifié avec de l’eau. N'utilisez pas de produits à base d’ammoniaque ou d'alcool sur le joint. Ces produits abîmeraient le téléphone et annuleraient la garantie du téléphone. Mise en garde Étape 4 Remettez en place le couvercle du compartiment à batterie. Lorsque vous fermez le couvercle de la batterie, vérifiez qu'il est toujours bien fermé. Sinon, de la poussière ou de l’eau peuvent pénétrer dans le compartiment à batterie. Mise en garde a) Alignez les pattes situées sous le couvercle sur les encoches du téléphone. Les onglets s'insèrent dans le téléphone. b) Appuyez fermement le couvercle contre le téléphone jusqu'à ce qu'il s'enclenche. Appuyez sur le haut, le milieu et le bas du couvercle de chaque côté. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 35 Configuration du téléphone Installer la batterie du Téléphone IP sans fil Cisco 8821-EX Ne forcez pas pour faire descendre le couvercle. S'il ne s'enclenche pas facilement, retirez le couvercle et vérifiez que la batterie est correctement insérée. Mise en garde c) Vérifiez que le couvercle est au ras du téléphone, puis utilisez une pièce de monnaie pour le visser en place. La vis doit être bien serrée. Ne le serrez pas trop fort cependant. Remplacer la batterie du Téléphone IP sans fil Cisco 8821 Utilisez cette tâche pour le Téléphone IP sans fil Cisco 8821 uniquement. Pour le Téléphone IP sans fil Cisco 8821-EX, reportez-vous à la section Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX, à la page 41. Si vous disposez d'une batterie de rechange, vous pouvez remplacer une batterie épuisée par une batterie chargée. La conformité IP54 signifie que le téléphone est imperméable à la poussière et à l’eau. Lorsque le téléphone quitte l’usine, il est complètement scellé. Si vous avez besoin d’ouvrir le compartiment de la batterie, ne l’ouvrez pas dans un environnement poussiéreux ou humide. Assurez-vous que le volet de la batterie est fermé pour vous assurer que la poussière et l’eau ne peuvent pas pénétrer dans le compartiment de la batterie. La poussière, l’huile et d’autres produits peuvent abîmer le joint du couvercle du compartiment à batterie, et compromettre ainsi son étanchéité. Inspectez le joint chaque fois que vous changez la batterie. Si le joint est abîmé, vous pouvez commander un couvercle de rechange. Remarque La durée de vie du téléphone et les fonctions pourraient être affectées si : • La batterie est installée incorrectement. • Le couvercle de la batterie n’est pas correctement fermé. • Le joint en caoutchouc du couvercle de la batterie est mal entretenu. • Le joint en caoutchouc du couvercle de la batterie est abîmé. • Le téléphone tombe régulièrement sur des surfaces dures. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 36 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821 Procédure Étape 1 Retirez le couvercle du compartiment à batterie. a) Poussez et maintenez le loquet de verrouillage vers la gauche pour libérer le couvercle. b) Utilisez les languettes sur les côtés du couvercle pour soulever le haut du couvercle et décrochez le couvercle pour déverrouiller les languettes du bas. Étape 2 Effectuez l'une des actions suivantes : • Si la batterie est munie d'une languette, tirez sur la languette de façon à l'enlever du téléphone • Si la batterie n'a pas de languette, tenez le téléphone d'une main avec l'écran dirigé vers la paume de votre main. Mettez votre autre main près de la base du téléphone.Secouez le téléphone pour faire tomber la batterie dans votre main. Étape 3 Installez la batterie. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 37 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821 Si vous installez la batterie incorrectement dans le compartiment de la batterie, la batterie et le compartiment de la batterie seront endommagés. Mise en garde La batterie comporte des contacts métalliques qui doivent toucher les contacts du compartiment de la batterie. La batterie comporte également une flèche dans la partie inférieure et le logo Cisco dans la partie supérieure. Lorsque la pile est correctement insérée, le logo et la flèche sont visibles. La flèche pointe vers le connecteur situé sur la base du téléphone et le logo est près de la patte de verrouillage. Le compartiment de la batterie comporte de petits onglets dans les coins inférieurs. La batterie doit glisser sous ces onglets. Le graphique suivant montre le compartiment de la batterie sans et avec la batterie correctement installée. a) Tenez la batterie de sorte que le bord inférieur soit proche du fond du compartiment. Vérifiez que les contacts métalliques de la batterie et du téléphone sont en face les uns des autres. Sur la batterie, le logo Cisco doit être près de la patte de verrouillage et la flèche doit pointer vers la base du téléphone. Ne forcez pas la batterie dans le compartiment ou vous endommagerez le compartiment et la batterie. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 38 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821 b) Glissez la base de la batterie sous les languettes situées au bas du compartiment à piles. c) Appuyez la batterie dans le compartiment jusqu'à ce qu'elle soit à plat dans le compartiment. Le graphique suivant montre une batterie correctement installée. d) Si la batterie a une languette en plastique léger, la languette doit être plate dans le compartiment. Étape 4 Inspectez le joint à l’intérieur du couvercle du compartiment à batterie et si nécessaire, nettoyez-le à l’aide d’un chiffon humidifié avec de l’eau. N'utilisez pas de produits à base d’ammoniaque ou d'alcool sur le joint. Ces produits abîmeraient le téléphone et annuleraient la garantie du téléphone. Mise en garde Étape 5 Remettez en place le couvercle du compartiment à batterie. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 39 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821 Lorsque vous fermez le couvercle de la batterie, vérifiez qu'il est toujours bien fermé. Sinon, de la poussière ou de l’eau peuvent pénétrer dans le compartiment à batterie. Mise en garde a) Alignez les pattes situées sous le couvercle sur les encoches du téléphone. Les onglets s'insèrent dans le téléphone. b) Appuyez fermement le couvercle contre le téléphone jusqu'à ce qu'il s'enclenche. Appuyez sur le haut, le milieu et le bas du couvercle de chaque côté. Appuyez fermement sur le couvercle. Ne forcez pas le couvercle. S'il ne s'enclenche pas facilement, retirez le couvercle et vérifiez que la batterie est correctement insérée. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 40 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821 c) Vérifiez que le couvercle est aligné avec le téléphone, puis faites glisser le verrou vers la droite pour verrouiller le couvercle en place. Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX Utilisez cette tâche pour le Téléphone IP sans fil Cisco 8821-EX uniquement. Pour le Téléphone IP sans fil Cisco 8821, reportez-vous à la section Remplacer la batterie du Téléphone IPsansfil Cisco 8821, à la page 36. Si vous disposez d'une batterie de rechange, vous pouvez remplacer une batterie épuisée par une batterie chargée. La conformité IP67 signifie que le téléphone est imperméable à la poussière et à l’eau. Lorsque le téléphone quitte l’usine, il est complètement scellé. Si vous avez besoin d’ouvrir le compartiment de la batterie, ne l’ouvrez pas dans un environnement poussiéreux ou humide, ou dans un endroit dangereux. N'ouvrez pas le compartiment si la température est inférieure ou égale à 0 °C. Mise en garde Assurez-vous que le volet de la batterie est fermé pour vous assurer que la poussière et l’eau ne peuvent pas pénétrer dans le compartiment de la batterie. La poussière, l’huile et d’autres produits peuvent abîmer le joint du couvercle du compartiment à batterie, et compromettre ainsi son étanchéité. Inspectez le joint chaque fois que vous changez la batterie. Si le joint est abîmé, vous pouvez commander un couvercle de rechange. Remarque Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 41 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX La durée de vie du téléphone et les fonctions pourraient être affectées si : • La batterie est installée incorrectement. • Le couvercle de la batterie n’est pas correctement fermé. • Le joint en caoutchouc du couvercle de la batterie est mal entretenu. • Le joint en caoutchouc du couvercle de la batterie est abîmé. • Le téléphone tombe régulièrement sur des surfaces dures. Mise en garde Procédure Étape 1 Utilisez une pièce de monnaie pour dévisser le couvercle de la batterie et retirez le couvercle du compartiment de la batterie. N'utilisez pas d'objet tranchant pour dévisser le couvercle du compartiment de la batterie ou retirer le couvercle du compartiment de la batterie du téléphone. Mise en garde a) Utilisez une pièce de monnaie pour dévisser la vis et déverrouiller le compartiment de la batterie. La vis demeure dans le couvercle. b) Soulevez et retirez le couvercle du compartiment de la batterie à l'aide de vos doigts, un coin à la fois. Étape 2 Effectuez l'une des actions suivantes : • Si la batterie est munie d'une languette, tirez sur la languette de façon à l'enlever du téléphone Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 42 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX • Si la batterie n'a pas de languette, tenez le téléphone d'une main avec l'écran dirigé vers la paume de votre main. Mettez votre autre main près de la base du téléphone.Secouez le téléphone pour faire tomber la batterie dans votre main. Étape 3 Installez la batterie. Si vous installez la batterie incorrectement dans le compartiment de la batterie, la batterie et le compartiment de la batterie seront endommagés. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 43 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX La batterie comporte des contacts métalliques qui doivent toucher les contacts du compartiment de la batterie. La batterie comporte également une flèche dans la partie inférieure et le logo Cisco dans la partie supérieure. Lorsque la pile est correctement insérée, le logo et la flèche sont visibles. La flèche pointe vers le connecteur situé sur la base du téléphone et le logo est près de la patte de verrouillage. Le compartiment de la batterie comporte de petits onglets dans les coins inférieurs. La batterie doit glisser sous ces onglets. Le graphique suivant montre le compartiment de la batterie sans et avec la batterie correctement installée. a) Tenez la batterie de sorte que le bord inférieur soit proche du fond du compartiment. Vérifiez que les contacts métalliques de la batterie et du téléphone sont en face les uns des autres. Sur la batterie, le logo Cisco doit être près de la patte de verrouillage et la flèche doit pointer vers la base du téléphone. Ne forcez pas la batterie dans le compartiment ou vous endommagerez le compartiment et la batterie. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 44 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX b) Glissez la base de la batterie sous les languettes situées au bas du compartiment à piles. c) Appuyez la batterie dans le compartiment jusqu'à ce qu'elle soit à plat dans le compartiment. Étape 4 Inspectez le joint à l’intérieur du couvercle du compartiment à batterie et si nécessaire, nettoyez-le à l’aide d’un chiffon humidifié avec de l’eau. N'utilisez pas de produits à base d’ammoniaque ou d'alcool sur le joint. Ces produits abîmeraient le téléphone et annuleraient la garantie du téléphone. Mise en garde Étape 5 Remettez en place le couvercle du compartiment à batterie. Lorsque vous fermez le couvercle de la batterie, vérifiez qu'il est toujours bien fermé. Sinon, de la poussière ou de l’eau peuvent pénétrer dans le compartiment à batterie. Mise en garde a) Alignez les pattes situées sous le couvercle sur les encoches du téléphone. Les onglets s'insèrent dans le téléphone. b) Appuyez fermement le couvercle contre le téléphone jusqu'à ce qu'il s'enclenche. Appuyez sur le haut, le milieu et le bas du couvercle de chaque côté. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 45 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX Ne forcez pas pour faire descendre le couvercle. S'il ne s'enclenche pas facilement, retirez le couvercle et vérifiez que la batterie est correctement insérée. Mise en garde c) Vérifiez que le couvercle est aligné avec le téléphone, puis utilisez une pièce de monnaie pour verrouiller le couvercle en place. Étape 6 Remettez en place le couvercle du compartiment à batterie. Lorsque vous fermez le couvercle de la batterie, vérifiez qu'il est toujours bien fermé. Sinon, de la poussière ou de l’eau peuvent pénétrer dans le compartiment à batterie. Mise en garde a) Alignez les pattes situées sous le couvercle sur les encoches du téléphone. Les onglets s'insèrent dans le téléphone. b) Appuyez fermement le couvercle contre le téléphone jusqu'à ce qu'il s'enclenche. Appuyez sur le haut, le milieu et le bas du couvercle de chaque côté. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 46 Configuration du téléphone Remplacer la batterie du Téléphone IP sans fil Cisco 8821-EX Ne forcez pas pour faire descendre le couvercle. S'il ne s'enclenche pas facilement, retirez le couvercle et vérifiez que la batterie est correctement insérée. Mise en garde c) Vérifiez que le couvercle est au ras du téléphone, puis utilisez une pièce de monnaie pour le visser en place. La vis doit être bien serrée. Ne le serrez pas trop fort cependant. Chargement de la batterie du téléphone Vous pouvez charger la batterie à l'aide des options suivantes : • Câble USB : vous pouvez charger le téléphone à l’aide d’un adaptateur secteur ou de votre ordinateur. • Chargeur de bureau : vous pouvez utiliser le téléphone et le charger en même temps. • Chargeur multiple : vous pouvez charger plusieurs téléphones simultanément. Risque d’explosion : n'utilisez pas la batterie du téléphone dans une atmosphère potentiellement explosive. Énoncé 431 Avertissement Le chargement de la batterie sur secteur, via le chargeur de bureau ou par le biais du chargeur multiple dure environ 3 heures. Environ 6 heures sont nécessaires pour la charger à l'aide d’un câble USB et de votre ordinateur. Sujets connexes Chargeurs multiples, à la page 109 Chargeurs de bureau, à la page 105 Chargement de la batterie de rechange Une batterie de rechange chargée peut s'avérer utile pour prolonger la durée de conversation. Vous pouvez charger une batterie de rechange dans le chargeur de bureau ou dans un chargeur multiple. Risque d’explosion : n'utilisez pas la batterie de rechange dans une atmosphère potentiellement explosive. Énoncé 431 Avertissement Le chargement de la batterie de rechange par le biais du chargeur de bureau ou du chargeur multiple dure environ 3 heures. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 47 Configuration du téléphone Chargement de la batterie du téléphone Sujets connexes Chargeurs multiples, à la page 109 Chargeurs de bureau, à la page 105 Préparation de l’adaptateur d’alimentation L’adaptateur d’alimentation du téléphone est compact. Pour pouvoir utiliser l'adaptateur d’alimentation, vous devez déplier les broches. Vous pouvez les replier lorsque vous avez fini d’utiliser l'adaptateur. Il est possible qu’un clip supplémentaire soit nécessaire pour que l’adaptateur d’alimentation qui correspond à votre région puisse être branché dans la prise électrique. Procédure Étape 1 Attrapez le bord d’une broche avec votre doigt et tirez la broche jusqu’à ce qu’elle s’enclenche. Étape 2 (Facultatif) Installez le clip d'alimentation international. Étape 3 (Facultatif) Avant de replier l’adaptateur, enlevez le clip d’alimentation international. Étape 4 (Facultatif) Appuyez sur la manette située en haut de l’adaptateur et appuyez sur les broches pour les replier. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 48 Configuration du téléphone Préparation de l’adaptateur d’alimentation Chargez la batterie à l'aide de l’alimentation secteur Vous pouvez charger votre téléphone à l’aide d’un boîtier d'alimentation secteur. Lorsque vous utilisez le boîtier d’alimentation pour charger votre téléphone, le chargement complet de la batterie peut nécessiter jusqu'à 3 heures. Le connecteur large du câble USB se branche dans le téléphone à l’aide d’aimants qui assurent le maintien du câble. Il est doté de broches qui doivent être correctement alignées. Lorsque l’écran du téléphone est face à vous, l’icône de batterie du connecteur est visible. Ne chargez pas le téléphone dans un environnement dangereux. Ne chargez pas le téléphone s'il est humide. Mise en garde Avant de commencer Vous aurez besoin du câble d’alimentation USB livré avec votre téléphone. Vous devez préparer l’adaptateur d'alimentation pour l’utilisation décrite à la sectionPréparation de l’adaptateur d’alimentation, à la page 48. Procédure Étape 1 Branchez le câble USB au bas du téléphone en alignant les broches. Étape 2 Branchez le câble USB dans l’adaptateur électrique. Étape 3 Branchez l'adaptateur électrique dans la prise secteur. Chargez la batterie à l'aide d'un câble USB et d’un port USB de votre ordinateur Vous pouvez charger votre téléphone à l’aide de votre ordinateur. Lorsque vous utilisez l’ordinateur pour charger votre téléphone, le chargement complet de la batterie peut nécessiter jusqu'à 6 heures. Le connecteur large du câble USB se branche dans le téléphone à l’aide d’aimants qui assurent le maintien du câble. Il est doté de broches qui doivent être correctement alignées. Lorsque l’écran du téléphone est face à vous, l’icône de batterie du connecteur est visible. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 49 Configuration du téléphone Chargez la batterie à l'aide de l’alimentation secteur Ne chargez pas le téléphone dans un environnement dangereux. Ne chargez pas le téléphone s'il est humide. Mise en garde Procédure Étape 1 Branchez le connecteur long du câble USB en dessous du téléphone en alignant les broches. Étape 2 Branchez l’autre extrémité du câble dans le port USB de l’ordinateur. Configuration du téléphone Vous pouvez configurer le téléphone à l'aide de l'une des méthodes suivantes : • Votre administrateur peut configurer le téléphone. Dans ce cas, vous n’avez aucune tâche de configuration à effectuer. Votre administrateur peut vous interdire l'accès aux menus de configuration. • Vous pouvez configurer le téléphone pour votre réseau Wi-Fi et pour qu'il se connecte au système de contrôle des appels. Dans ce cas, votre administrateur vous communique les informations à entrer dans le téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 50 Configuration du téléphone Configuration du téléphone Ajout du téléphone au réseau Wi-Fi Pour saisir une adresse IP, défilez jusqu’au champ et appuyez sur Sélect. Le champ est transformé en zones de texte. Utilisez le clavier pour saisir des chiffres, et l’anneau de navigation pour passer d’un champ à l'autre. Une fois le téléphone configuré et les modifications enregistrées, le téléphone se connecte à Cisco Unified Communications Manager. Lorsque la connexion est établie, le téléphone télécharge le fichier de configuration et si nécessaire, met à niveau le micrologiciel. Avant de commencer Vous devez disposer des informations suivantes sur le réseau Wi-Fi : • SSID • Type de sécurité (par exemple, WEP, EAP) • Code PIN ou clé d’accès pour le type de sécurité sélectionné Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Wi-Fi. Étape 3 Sélectionnez un profil. Étape 4 (Facultatif) Définissez un nom de profil. a) Sélectionnez Nom du profil. b) À l'aide du clavier, saisissez un nouveau nom. • La touche programmable Préc. permet d’effacer le caractère situé à gauche du curseur. • Utilisez l'anneau de navigation pour vous déplacer de gauche à droite dans le champ. c) Appuyez sur Autres et sélectionnez Enregistrer. Étape 5 Sélectionnez Configuration réseau > Configuration IPv4. Si votre réseau ne prend pas en charge DHCP, procédez comme suit. a) Obligatoire : Sélectionnez DHCP puis appuyez sur Désactivé. b) Sélectionnez Adresse IP et entrez l'adresse IP attribuée au téléphone. c) Sélectionnez Masque de sous-réseau et entrez le masque de sous-réseau requis. Par exemple, 255.255.255.0. d) Sélectionnez Routeur par défaut et entrez l'adresse IP du routeur par défaut. e) Sélectionnez Serveur DNS 1 et entrez l'adresse IP du serveur DNS. Pour tous les réseaux, a) Sélectionnez TFTP secondaire et définissez l’option sur Activé. b) Sélectionnez Serveur TFTP 1 et entrez l'adresse IP du serveur TFTP de Cisco Unified Communications Manager. c) Appuyez sur Autres et sélectionnez Enregistrer. d) Dans la fenêtre Liste sécurisée, appuyez sur Autres et sélectionnez Effacer. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 51 Configuration du téléphone Ajout du téléphone au réseau Wi-Fi e) Sélectionnez Précédent, puis appuyez à nouveau sur Précédent. Étape 6 Sélectionnez Configuration WLAN. Étape 7 Sélectionnez SSID. a) Utilisez le clavier pour saisir le SSID du point d'accès. b) Appuyez sur Autres et sélectionnez Enregistrer. Étape 8 Sélectionnez Mode sécurité. Étape 9 Sélectionnez le type de sécurité requis pour le point d'accès. Étape 10 Définissez les champs de sécurité comme décrit dans le tableau suivant : Mode sécurité Champ configuré Description Lorsque le mode de sécurité est défini sur Aucun, aucun autre champ ne doit être configuré. Aucun Aucun Saisissez une clé WEP Hex ou au format ASCII 40/104 ou 64/128. WEP Clé WEP Saisissez la phrase secrète Hex au format ASCII 8-63 ou 64. PSK Phrase secrète EAP-FAST ID de l’utilisateur Saisissez l’identifiant utilisateur. PEAP-GTC PEAP-MSCHAPV2 Mot de passe Entrez le mot de passe. Votre administrateur vous communiquera le type de certificat à sélectionner et installera le certificat sur votre téléphone. EAP-TLS Certificat utilisateur Étape 11 Sélectionnez Mode 802.11 et sélectionnez le mode requis. Le mode détermine la fréquence. Si vous définissez le mode sur Auto, le téléphone peut utiliser la fréquence 5 GHz ou 2,4 GHz, 5 GHz étant la fréquence préférée. Étape 12 Sélectionnez Éco. énerg. pdt appel et appuyez sur Sélect. pour changer le paramètre. Ce champ ne doit être défini sur Désactivé que si cela est nécessaire pour la résolution de problème. Étape 13 Appuyez sur Autres et sélectionnez Enregistrer. Étape 14 Appuyez sur Alimentation/Fin d'appel . Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 52 Configuration du téléphone Ajout du téléphone au réseau Wi-Fi CHAPITRE 3 Appels • Accès à l’application Téléphone, à la page 53 • Passage d’appels, à la page 54 • Prise d'appels, à la page 59 • Mettre fin à un appel, à la page 62 • Coupure du son, à la page 63 • Mise en garde d'appels, à la page 63 • Transfert d’appels depuis votre téléphone, à la page 65 • Transfert d'un appel à une autre personne, à la page 66 • Conférences téléphoniques et réunions, à la page 66 • Appels intercom, à la page 68 • Supervision et enregistrement des appels, à la page 69 • Appels prioritaires, à la page 70 • Lignes multiples, à la page 71 Accès à l’application Téléphone L’application Téléphone permet de passer et de recevoir aisément des appels. Si votre écran d’accueil est en mode ligne, alors vous êtes déjà dans l’application Téléphone. Procédure Utilisez l'une des options suivantes pour accéder à l’application Téléphone : • Dans l'écran de vue applicative, appuyez sur le bouton Sélect. pour choisir Téléphone . • Appuyez sur Répond./Envoyer pour passer un appel ou pour prendre un appel entrant. • Composez un numéro sur le clavier pour passer un appel. Sujets connexes Écran d'accueil, à la page 17 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 53 Passage d’appels Votre téléphone IP sans fil Cisco fonctionne comme un téléphone normal. Il permet toutefois de passer plus facilement des appels. Faire un appel Vous pouvez facilement passer un appel depuis l'écran d'accueil des applications, l'écran d'accueil de la vue de ligne ou l'application téléphone. Procédure Étape 1 Saisissez un numéro de téléphone. Étape 2 Appuyez sur Répond./Envoyer . Passage d’un appel d’urgence Vous pouvez passer un appel d'urgence sur votre téléphone, même si vous n’êtes pas connecté. Lorsque vous commencez à composer le numéro d'urgence, la liste des numéros d'urgence s'affiche, mais vous ne pouvez pas sélectionner de numéro. Si vous tentez de composer un numéro qui ne figure pas dans la liste des numéros d'urgence, le téléphone ne compose pas le numéro. Procédure Étape 1 Si vous téléphone n’est pas allumé, appuyez pendant 4 secondes sur Alimentation/Fin appel pour allumer le téléphone. Étape 2 Saisissez votre numéro d'urgence sur le clavier. Étape 3 Appuyez sur Répond./Envoyer . Passage d'un appel avec un casque Vous pouvez passer un appel à l’aide du casque. Si vous déconnectez le casque pendant un appel, le son bascule sur le haut-parleur et l’appel se poursuit. Avant de commencer Un casque filaire ou Bluetooth est connecté au téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 54 Appels Passage d’appels Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Saisissez un numéro de téléphone. Étape 4 Appuyez sur Répond./Envoyer . Sujets connexes Casques, à la page 104 Passage d'un appel à l'aide du haut-parleur du téléphone Vous pouvez passer un appel à l’aide du haut-parleur intégré au téléphone. Procédure Étape 1 Appuyez sur Haut-parleur et maintenez cette touche enfoncée pour activer le haut-parleur. Étape 2 Composez le numéro de téléphone. Étape 3 Appuyez sur Répond./Envoyer pour passer votre appel. Étape 4 Appuyez de nouveau sur Haut-parleur et maintenez cette touche enfoncée pour quitter le mode haut-parleur. Passage d'un appel à l'aide du haut-parleur du chargeur de bureau Lorsque le téléphone est dans le chargeur de bureau, vous utilisez automatiquement le haut-parleur intégré au chargeur. Si vous retirez le téléphone du chargeur pendant un appel, mettez le téléphone sur votre oreille pour entendre votre interlocuteur. Procédure Étape 1 Composez le numéro de téléphone. Étape 2 Appuyez sur Répond./Envoyer pour passer votre appel. Passage d’un appel à l’aide du téléphone ou d’une adresse vidéo Il est possible qu’au lieu d’un simple numéro de téléphone, vous disposiez également d’une adresse vidéo ou de téléphone, que vous pouvez utiliser pour passer un appel. Ces adresses peuvent ressembler à des adresses électroniques, comme par exemple nom_utilisateur1@exemple.com, ou elles peuvent contenir des chiffres, comme par exemple nom_utilisateur2@209.165.200.224. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 55 Appels Passage d'un appel à l'aide du haut-parleur du téléphone Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Appuyez sur Autres et sélectionnez ABC pour pouvoir saisir du texte à l’aide du clavier. Étape 4 Appuyez sur un chiffre du clavier pour afficher les options disponibles, puis appuyez de nouveau sur ce chiffre pour naviguer entre les choix. Par exemple, appuyez trois fois sur le chiffre 1 pour saisir le symbole @. Étape 5 Appuyez sur Répond./Envoyer . Recomposer un numéro Vous pouvez rappeler le dernier numéro de téléphone composé dans l’application Téléphone. Procédure Étape 1 Obligatoire : Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Appuyez sur Recomp. Retour d'un appel récent Vous pouvez retourner un appel récents depuis la liste Récents de l’application Téléphone. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Obligatoire : Sélectionnez une ligne. Étape 3 Sélectionnez une entrée dans la liste Récents. Étape 4 Appuyez sur Répond./Envoyer . Passer un appel vers un numéro favori à partir de l'application Contacts Vous pouvez aisément appeler un contact figurant dans votre liste de Favoris. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 56 Appels Recomposer un numéro Avant de commencer Vous devez configurer un favori (un numéro composé fréquemment) dans la liste Favoris de l’application Contacts. Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Favoris. Étape 3 Sélectionnez une entrée et appuyez sur Répondre/Envoyer . Sujets connexes Favoris, à la page 74 Passer un appel vers un numéro favori à partir de l’écran Applications Vous pouvez aisément appeler un contact figurant dans votre liste de Favoris à partir de la vue applicative. Avant de commencer • Vous devez configurer un favori (un numéro composé fréquemment) dansla listeFavoris de l’application Contacts. • Vous devez connaître le numéro d’index assigné au favori. Procédure Effectuez l'une des opérations suivantes : • Si un index à un seul chiffre est affecté au favori, appuyez sur la touche correspondant à ce chiffre et maintenez-la enfoncée. Par exemple, si le favori est affecté au numéro d'index 1, maintenez la touche 1 enfoncée jusqu'à ce que le téléphone passe l'appel. • Si le favori reçoit un index à deux chiffres, appuyez sur la première touche numérique, puissur la deuxième touche numérique et maintenez-la enfoncée. Par exemple, si le favori est affecté à l’index numéro 10, appuyez sur 1 , puis maintenez la touche 0 enfoncée jusqu’à ce que le téléphone effectue l’appel. Sujets connexes Favoris, à la page 74 Passage d'un appel à l'aide de la numérotation simplifiée Avant de commencer L'administrateur doit configurer pour vous, une ligne de numérotation simplifiée. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 57 Appels Passer un appel vers un numéro favori à partir de l’écran Applications Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Obligatoire : Sélectionnez une ligne de numérotation simplifiée . Composition d'un numéro international Vous pouvez passer des appels internationaux en composant le signe plus (+) avant le numéro de téléphone. Avant de commencer La fenêtre de l’application Téléphone doit être ouverte. Procédure Étape 1 Maintenez la touche astérisque () appuyée pendant au moins une seconde. Le signe plus (+) apparaît comme le premier chiffre du numéro de téléphone. Si le combiné est raccroché, la tonalité change lorsque le signe + est affiché. Étape 2 Composez le numéro. Étape 3 Appuyez sur Répond./Envoyer . Comment recevoir une notification lorsqu’un contact est disponible Si le numéro que vous appelez est occupé ou ne répond pas, vous pouvez être averti par un message et par une sonnerie spéciale dès que la ligne devient disponible. Procédure Étape 1 Appuyez sur Rappel. Étape 2 Appuyez sur Quitter. Étape 3 Lorsque le message ou la sonnerie spéciale vous indique que la ligne est disponible, appuyez sur Appel. Appels nécessitant un code de facturation ou un code d’autorisation Votre administrateur peut vous demander de saisir un code de facturation ou un code d’autorisation (ou les deux) lorsque vous avez composé un numéro de téléphone. Le code de facturation, appelé code d’affaire client, est utilisé à des fins comptables ou de facturation. Le code d’autorisation, appelé code d’autorisation forcé, contrôle l’accès à certains numéros de téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 58 Appels Composition d'un numéro international Lorsqu’un code de facturation est requis, le téléphone affiche le message Entrez le code d’affaire client, le numéro composé devient « » et vous entendez une tonalité spéciale. Lorsqu’un code d’autorisation est requis, le téléphone affiche le message Entrez le code d’autorisation, le numéro composé devient « * » et vous entendez une tonalité spéciale. Pour des raisons de sécurité, le téléphone affiche un « * » au lieu du numéro saisi. Si un code de facturation et un code d’autorisation sont requis, vous êtes d’abord invité à saisir le code d’autorisation. Vous êtes ensuite invité à saisir le code de facturation. Sujets connexes Numéros abrégés, à la page 10 Appels sécurisés Votre administrateur peut prendre des mesures pour empêcher que des personnes externes à votre société n’interfèrent avec vos appels. Lorsque l'icône de verrou est affichée sur votre téléphone lors d'un appel, votre téléphone est sécurisé.Selon la configuration de votre téléphone, vous devrez peut-être vous authentifier avant de passer un appel, ou une tonalité de sécurité retentira dans votre combiné. Prise d'appels Votre téléphone IP sans fil Cisco fonctionne comme un téléphone normal. Il permet toutefois de prendre plus facilement des appels. Pour répondre à un appel Procédure Appuyez sur Répond. ou sur Répond./Envoyer . Réponse aux appels en garde Lorsque vous avez un appel entrant alors que vous êtes déjà en communication, un seul bip retentit. Vous pouvez répondre au nouvel appel et mettre automatiquement l’appel actif en garde. Procédure Étape 1 Appuyez sur Répond. ou sur Répond./Envoyer . Étape 2 (Facultatif) Si plusieurs appels sont en garde, sélectionnez un appel entrant. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 59 Appels Appels sécurisés Refus d’un appel Lorsque vous recevez un appel entrant que vous ne souhaitez pas prendre, vous pouvez refuser l’appel, qui est alors renvoyé à la messagerie vocale. Si vous ne voyez pasla touche programmable Refuser, votre administrateur a désactivé la possibilité de refuser un appel. Procédure Appuyez sur Refuser. Appel ignoré Lorsque vousrecevez un appel entrant que vous ne souhaitez pas prendre, vous pouvez ignorer l’appel. L’appel est affiché dans la liste des appels. Procédure Appuyez sur les touches fléchées vers le haut ou vers le bas du cluster de navigation. Mise en sourdine des appels entrants sur votre téléphone Lorsque vous êtes occupé et ne voulez pas être dérangé, vous pouvez couper le son des appels entrants. Dans ce cas, le téléphone ne sonne pas, mais une alerte visuelle s'affiche. Ainsi, vous pouvez toujours choisir de prendre l'appel. Si vous ne prenez pas l'appel, il est envoyé à votre messagerie vocale. Procédure Choisissez l’une des options suivantes. • Dans le portail Self Care, activez Ne pas déranger. • Sur votre téléphone, 1. Ouvrez l’application Téléphone. 2. (Facultatif) Sélectionnez une ligne 3. Appuyez sur Autres et sélectionnez Ne pas déranger Sujets connexes Contrôle de la sonnerie du téléphone lors d'un appel entrant, à la page 62 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 60 Appels Refus d’un appel Réponse au téléphone d’un collègue (interception d'appel) Si vous partagez des tâches de gestion des appels avec vos collègues, vous pouvez prendre un appel qui sonne sur le téléphone d’un collègue. Auparavant, votre administrateur doit vous affecter à au moins un groupe de prise d’appel. Prise d’un appel dans votre groupe de recherche (interception) Vous pouvez prendre un appel quisonne sur un autre téléphone au sein de votre groupe d'interception d'appels. Si plusieurs appels peuvent être interceptés, vous devez d’abord répondre à l’appel qui sonne depuis le plus longtemps. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Autres et sélectionnez Intrcpt. Étape 3 Appuyez sur Répondre. Prise d’un appel à partir d’un autre groupe (interception de groupe) L’interception de groupe permet de répondre à un appel sur un téléphone qui se trouve en dehors de votre groupe d'interception d'appels. Pour intercepter l’appel, vous pouvez utiliser le numéro d’interception de groupe ou le numéro de la ligne téléphonique qui sonne. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Appuyez sur Autres et sélectionnez Int.app.grp. Étape 4 Saisissez le numéro d’interception de groupe ou le numéro de la ligne téléphonique sur laquelle sonne l'appel que vous souhaitez intercepter. Étape 5 Appuyez sur Autres et sélectionnez Appel. Étape 6 Appuyez sur Répondre. Prise d’un appel à partir d’un groupe associé (autre interception) Vous pouvez intercepter un appel qui sonne sur un téléphone membre d’un autre groupe d'appels. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 61 Appels Réponse au téléphone d’un collègue (interception d'appel) Étape 3 Appuyez sur Autres et sélectionnez Autre interception. Étape 4 Appuyez sur Répondre. Suivi d'un appel suspect Si vous recevez des appels indésirables ou abusifs, utilisez l'identification des appels malveillants (IDAM) pour prévenir votre administrateur. Votre téléphone enverra à votre administrateur, un message de notification silencieuse contenant des informations sur l’appel. Procédure Étape 1 Appuyez sur Autres et sélectionnez Rapport - appelant. Étape 2 Mettre fin à l'appel. Contrôle de la sonnerie du téléphone lors d'un appel entrant Vous pouvez désactiver la sonnerie du téléphone pour un appel individuel. Procédure Effectuez l'une des actions suivantes : • Appuyez sur le bas du bouton Volume . • Appuyez sur la touche Dièse (#) pendant 2 secondes pour activer ou désactiver la sonnerie. Sujets connexes Réglage du volume de la sonnerie du téléphone, à la page 102 Passage au mode vibreur pour un appel entrant, à la page 92 Sélection de l’endroit où la sonnerie retentit, à la page 92 Mise en sourdine des appels entrants sur votre téléphone, à la page 60 Mettre fin à un appel Procédure Effectuez l'une des actions suivantes : Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 62 Appels Suivi d'un appel suspect • Dans l’application Téléphone, appuyez sur Autres et sélectionnez Fin appel. • Appuyez sur Alimentation/Fin d'appel . Coupure du son Vous pouvez activer le mode silencieux afin de pouvoir entendre votre interlocuteur, sans qu'il puisse vous entendre. Le bouton Silence est situé près du bouton Volume sur le côté du téléphone. Lorsque le téléphone est dans le chargeur de bureau, vous pouvez couper le son du haut-parleur du chargeur de bureau à l'aide du bouton Silence situé dans le coin inférieur droit du chargeur. Procédure Étape 1 Appuyez sur Silence . Étape 2 Appuyez à nouveau sur Silence pour désactiver cette fonction. Mise en garde d'appels Vous pouvez mettre un appel actif en garde, puis le reprendre lorsque vous êtes prêt. Mise en garde d'un appel Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Garde pour mettre en garde un appel. Prise d’un appel mis en garde pendant trop longtemps Vous pouvez être averti de la mise en garde d’un appel. Les notifications sont similaires aux notifications d’appel entrant et incluent les signaux suivants : • Une seule sonnerie, répétée par intervalles • Un indicateur de message clignotant sur le combiné • Une notification visuelle sur l'écran du téléphone Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 63 Appels Coupure du son Procédure Appuyez sur Répond. pour reprendre l'appel mis en garde. Permutation entre un appel actif et un appel en garde Vous pouvez accéder à un appel en garde lorsque vous êtes en communication. Le téléphone met le premier appel en garde. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur la touche de navigation droite. Étape 3 Sélectionnez l’appel en garde. Étape 4 Appuyez sur Reprendre. Appel en garde par indicatif Vous pouvez utiliser votre téléphone pour parquer (stocker temporairement) un appel. L'appel parqué peut alors être récupéré depuis un autre téléphone (tel qu’un téléphone situé sur le bureau d’un collègue ou dans une salle de conférence). Si l'appel reste parqué pendant trop longtemps, une tonalité d’alerte retentit. Vous pouvez prendre l’appel ou le récupérer sur un autre téléphone. Si vous ne prenez pas l'appel dans un certain délai, il est redirigé vers une autre destination (par exemple votre messagerie vocale), configurée par votre administrateur. Mise en garde d’un appel à l’aide du parcage d'appels Vous pouvez parquer un appel actif que vous avez pris sur votre téléphone, puis le récupérer à l'aide d'un autre téléphone du système de contrôle des appels. Vous ne pouvez parquer qu'un seul appel au numéro de parcage d’appel. Avant de commencer Votre appel doit être actif. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Autres et sélectionnez Parquer. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 64 Appels Permutation entre un appel actif et un appel en garde Le téléphone affiche le numéro de poste du parcage d’appel. Récupération d’un appel en garde à l’aide du parcage d'appels Vous pouvez intercepter un appel parqué à partir de n’importe quel emplacement de votre réseau. Avant de commencer Vous aurez besoin du numéro de poste du parcage d’appel. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Composez le numéro de poste du parcage d’appel. Transfert d’appels depuis votre téléphone Vous pouvez renvoyer les appels de n'importe quelle ligne de votre téléphone vers un autre numéro. Le renvoi d'appels dépend de la ligne téléphonique. Ainsi, si un appel arrive sur une ligne où la fonction de renvoi d'appels n'est pas activée, le téléphone sonne comme d'habitude et l'appel n'est pas renvoyé. Il existe deux méthodes de renvoi d'appel : • Renvoyer tous les appels • Le renvoi d'appels dans des cas particuliers, par exemple lorsque le téléphone est occupé ou lorsqu’il ne répond pas. Pour vérifier que vos appels sont renvoyés, recherchez l'icône Renvoyer tout dans le libellé de la ligne. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez une ligne. Étape 3 Appuyez sur Autres et sélectionnez Transférer tout. Étape 4 Entrez le numéro sur lequel recevoir les appels ou sélectionnez une entrée dans la liste des appels récents. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 65 Appels Récupération d’un appel en garde à l’aide du parcage d'appels Désactivation du transfert d'appel depuis votre téléphone Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 (Facultatif) Sélectionnez la ligne transférée. Étape 3 Appuyez sur Autres et sélectionnez Dés. renvoi. Transfert d'un appel à une autre personne Lorsque vous transférez un appel, vous pouvez rester en ligne avec votre interlocuteur d’origine, jusqu’à ce que l’autre personne réponde. Ainsi, vous pouvez parler en privé avec l’autre personne avant de quitter la conversation. Si vous ne voulez pas parler, transférez l’appel sans attendre que l'autre personne réponde. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Autres et sélectionnez Transfert. Étape 3 Entrez le numéro à appeler ou sélectionnez une entrée dans la liste des appels récents. Étape 4 Appuyez sur Transfert. Conférences téléphoniques et réunions Vous pouvez parler avec plusieurs personnes lors d’un même appel. Vous pouvez appeler une autre personne et l’ajouter à l’appel. Si vous disposez de plusieurs lignes téléphoniques, vous pouvez combiner deux appels sur deux lignes. Lorsque vous ajoutez une ou plusieurs personnes à une conférence téléphonique, attendez quelques secondes avant l'ajout de chaque participant. En tant qu'hôte de la conférence, vous pouvez supprimer des participants individuels de la conférence. La conférence se termine lorsque tous les participants ont raccroché. Ajout d’une autre personne à un appel Vous pouvez ajouter une autre personne à un appel actif pour créer une conférence. Procédure Étape 1 Ouvrez l’application Téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 66 Appels Désactivation du transfert d'appel depuis votre téléphone Étape 2 Appuyez sur Autres et sélectionnez Conférence. Étape 3 Effectuez l'une des actions suivantes. • Composez un numéro et attendez que le destinataire de l'appel réponde. • Sélectionnez une entrée dans la liste des appels récents et attendez que le destinataire de l'appel réponde. • Sélectionnez un autre appel en garde sur la même ligne. • Appuyez sur la touche de navigation de droite, sélectionnez une ligne, sélectionnez un appel en garde sur cette ligne. Étape 4 Appuyez sur Fusionner. Affichage et suppression des participants à une conférence Lorsque vous êtes en conférence téléphonique, vous pouvez visualiser les participants à la conférence.Si vous êtes l'hôte de la conférence, vous pouvez supprimer un participant de la conférence. Un astérisque () est affiché sur l’écran près de l'hôte de la conférence. Avant de commencer Vous devez être en conférence téléphonique active. Procédure Étape 1 Appuyez sur Autres et sélectionnez Détails. Étape 2 (Facultatif) Appuyez sur MàJ pour actualiser la liste des participants. Étape 3 (Facultatif) Sélectionnez un participant, puis appuyez sur Supprimer. Conférences téléphoniques planifiées (MultConf) Vous pouvez organiser ou participer à une conférence téléphonique à une heure planifiée. La téléconférence ne commence pas avant que l’hôte ne compose le numéro d’accès et se termine lorsque tousles participants ont raccroché. La conférence ne se termine pas automatiquement lorsque l'hôte raccroche. Organisation d'une conférence MultConf Avant de commencer Demandez à votre administrateur de vous communiquer un numéro de conférence et transmettez ce numéro aux participants à la conférence. Procédure Étape 1 Ouvrez l’application Téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 67 Appels Affichage et suppression des participants à une conférence Étape 2 Appuyez sur Autres et sélectionnez MultConf. Étape 3 Entrez le numéro de la conférence MultConf. Étape 4 Saisissez le mot de passe de l’hôte de la réunion. Accès à une conférence MultConf Vous ne pouvez par participer à une conférence Multconf tant que l’hôte ne s’y est pas connecté. Si vous entendez une tonalité d’occupation, l’hôte ne s’est pas encore connecté à la conférence. Raccrochez, puis réessayez. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Autres et sélectionnez MultConf. Étape 3 Entrez le numéro de la conférence MultConf. Appels intercom Vous pouvez passer et de recevoir des appels unidirectionnels via une ligne intercom. Lorsque vous passez un appel intercom, le téléphone du destinataire répond automatiquement en modeSilence (Chuchotement). Votre message est diffusé dans le haut-parleur du destinataire, dans son casque ou dans son combiné si l'un de ces périphériques est activé. Après avoir reçu l’appel intercom, le destinataire peut lancer une session audio bidirectionnelle (en mode Connecté) pour poursuivre la conversation. Passer un appel intercom Lorsque vous passez un appel intercom, le téléphone passe en mode Chuchotement jusqu'à ce que le destinataire accepte l'appel intercom. En mode Chuchotement, votre interlocuteur vous entend, mais vous ne l'entendez pas. Si vous avez un appel en cours, il est mis en garde. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Sélectionnez une ligne intercom . Étape 3 Composez le numéro intercom cible. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 68 Appels Accès à une conférence MultConf Réponse à un appel intercom Vous pouvez prendre un appel intercom pour parler à l’autre personne. Avant de commencer Vous recevez un message sur l’écran de votre téléphone, ainsi qu'une alerte sonore. Votre téléphone répond à l’appel intercom en mode Chuchotement. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Sélectionnez l’appel intercom. Supervision et enregistrement des appels Vous pouvez superviser et enregistrer un appel. Au moinstrois personnes doivent être sur une ligne : l'appelant, le chaperon et l'appelé. Le chaperon prend un appel, crée une conférence et surveille et enregistre la conversation. Le chaperon effectue les tâches suivantes : • Il enregistre l'appel. • Il ajouter uniquement le premier participant à la conférence ; les autres participants ajoutent des personnes selon les besoins. • Il met fin à l'appel. La conférence se termine lorsque le chaperon raccroche le téléphone. Configuration d’un appel supervisé Lorsque vous devez superviser un appel, l'appel entrant indique la nécessité d’une surveillance. Avant de commencer Vous devez faire partie du groupe de recherche Chaperon. Procédure Étape 1 Appuyez sur Autres et sélectionnez Conférence. Étape 2 Appelez la personne à ajouter à l’appel. Étape 3 Lorsque la personne répond, appuyez sur Fusionner. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 69 Appels Réponse à un appel intercom Enregistrement d’un appel Vous pouvez enregistrer un appel. Vous entendrez peut-être une tonalité de notification pendant l’enregistrement de l’appel. L’enregistrement cesse lorsque vous appuyez sur la touche programmable Arrêter l'enregistrement ou lorsque vous mettez fin à l’appel. Procédure Étape 1 Appuyez sur Enregistrer. Étape 2 Appuyez sur Arrêter l’enregistrement lorsque l’enregistrement peut être arrêté. Appels prioritaires Au travail, il peut vous arriver de devoir gérer des situations urgentes ou critiques par téléphone. Vous pouvez identifier des appels comme étant très importants et ayant un niveau de priorité plus élevé que celui des appels normaux. Les priorités vont du niveau 1 (bas) au niveau 5 (élevé). Le système de priorité est appelé MLPP (Multilevel Precedence and Preemption, Préséance et préemption à plusieurs niveaux). Votre administrateur configuré les priorités que vous pouvez utiliser et détermine si des informations de connexion spéciales vous sont nécessaires. Lorsqu’un appel de priorité élevée sonne sur votre téléphone, le niveau de priorité est affiché sur l’écran du téléphone. Si un appel de priorité élevée sonne sur votre téléphone alors que vous êtes en communication, l’appel de priorité élevée a préemption sur l’appel en cours et vous entendez une tonalité de préemption spéciale. Vous devez mettre fin à l’appel en cours et prendre l’appel de priorité élevée. Lorsque vous avez un appel de priorité élevée, la priorité de l’appel ne change pas lorsque vous : • Mettez l’appel en garde • Transférez l’appel • Ajoutez l’appel à une conférence à trois • Répondez à l'appel par interception Tableau 7 : Préséance à plusieurs niveaux et niveaux de priorité de préemption Icône MLPP Niveau de priorité Niveau 1 : appel prioritaire Niveau 2 : appel de priorité moyenne (immédiate) Niveau 3 : appel de priorité élevée (urgence) Niveau 4 : entrée en tiers d’urgence Niveau 5 : entrée en tiers du demandeur Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 70 Appels Enregistrement d’un appel Composition d'appel prioritaire Pour passer un appel prioritaire, vous devrez peut-être vos connecter à l'aide de vosinformations d'identification spéciales. Après trois tentatives de saisie de vos informations d'identification, vous êtes averti que vous les avez saisies de façon incorrecte. Procédure Étape 1 Ouvrez l’application Téléphone. Étape 2 Appuyez sur Autres et sélectionnez NivPréc. Étape 3 Sélectionnez un niveau de priorité. Étape 4 Saisissez le numéro de téléphone voulu. Étape 5 Appuyez sur Répond./Envoyer . Prise d'un appel prioritaire Si vous entendez une sonnerie particulière qui est plusrapide que d’habitude, vousrecevez un appel prioritaire. Procédure Appuyez sur Répondre. Réponse à un appel prioritaire pendant un appel en cours Si une tonalité continue interrompt un appel en cours, votre collègue ou vous-même recevez un appel prioritaire. Raccrochez immédiatement pour permettre l’envoi de l'appel de priorité supérieure à l'interlocuteur voulu. Procédure Étape 1 Appuyez sur Fin d'appel. Étape 2 Appuyez sur Répondre. Lignes multiples Si vous partagez des numéros de téléphone avec d'autres personnes, vous pouvez avoir plusieurs lignes sur votre téléphone. Si vous disposez de plusieurs lignes téléphoniques, davantage de fonctionnalités sont disponibles. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 71 Appels Composition d'appel prioritaire Lignes partagées Vous pouvez partager un même numéro de téléphone avec un ou plusieurs de vos collègues. Par exemple, si vous êtes assistant de direction, vous devez filtrer les appels de votre directeur. Lorsque vous partagez un numéro de téléphone, vous pouvez utiliser cette ligne de téléphone comme n’importe quelle autre ligne, mais gardez à l’esprit ces caractéristiques relatives aux lignes partagées : • Le numéro de téléphone partagé est affiché sur tous les téléphones qui partagent ce téléphone. • Si votre collègue prend un appel sur la ligne partagée, l’icône de la ligne partagée est affiché en rouge sur votre téléphone. • Si vous mettez un appel en garde, l’icône de la ligne partagée est blanche. Mais la ligne est affichée en rouge sur le téléphone de votre collègue. Comment s'ajouter soi-même à un appel sur une ligne partagée (InsConf) Votre collègue ou vous-même pouvez participer à un appel sur une ligne partagée sans créer de conférence téléphonique. Procédure Étape 1 Sélectionnez une ligne partagée en cours d'utilisation. Étape 2 Appuyez sur Autres et sélectionnez InsConf. Étape 3 Appuyez sur Oui. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 72 Appels Lignes partagées CHAPITRE 4 Contacts • Accès à l’application Contacts, à la page 73 • Favoris, à la page 74 • Contacts locaux, à la page 75 • Répertoire personnel, à la page 77 • Répertoire général, à la page 80 Accès à l’application Contacts Vous pouvez ouvrir l'application Contacts à partir de l'écran de vue applicative. L’application Contacts vous permet d'accéder aux répertoires et aux listes suivants : • Répertoire d’entreprise : répertoire qui contient les employés de votre société • Répertoire personnel : répertoire qui contient vos contacts personnels. Le répertoire est hébergé dans le système de contrôle des appels et vous pouvez accéder à votre répertoire personnel à partir d’autres téléphones de votre réseau téléphonique. • Contacts locaux : répertoire qui contient vos contacts personnels, hébergé dans la mémoire du téléphone. • Favoris : une liste des contacts que vous appelez régulièrement. Procédure Étape 1 Dans l’écran vue de ligne, appuyez sur la flèche gauche du cluster de navigation pour afficher l’écran Applications. Étape 2 Dans l’écran Applications, utilisez la touche fléchée gauche du cluster de navigation pour sélectionner Contacts . Sujets connexes Écran d'accueil, à la page 17 Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 73 Favoris Vous pouvez ajouter des numéros fréquemment appelés à votre liste de favoris. Vous pouvez utiliser la liste pour composer rapidement une entrée dans la liste. Votre liste peut comporter jusqu’à 50 entrées. Sujets connexes Passer un appel vers un numéro favori à partir de l'application Contacts, à la page 56 Passer un appel vers un numéro favori à partir de l’écran Applications, à la page 57 Accéder aux favoris Vous pouvez accéder à votre liste de favoris de plusieurs façons. Procédure Effectuez l'une des opérations suivantes : • Appuyez sur Favoris. • Accédez à l’application Contacts et sélectionnez Favoris. • Ouvrez l’application Téléphone. Ajout d'un contact à votre liste de favoris Avant de commencer Le contact doit figurer dans votre liste de contacts locaux. Procédure Étape 1 Accédez aux Favoris en utilisant Accéder aux favoris, à la page 74. Étape 2 Sélectionnez une entrée non attribuée. Étape 3 Appuyez sur Affecter. Étape 4 Mettez en surbrillance un contact local et appuyez sur Détails. Étape 5 Mettez en surbrillance un numéro de téléphone et appuyez sur Affecter. Suppression d'un contact de votre liste de favoris Vous pouvez supprimer un favori de la liste des favoris. Le contact s’affiche toujours dans vos contacts locaux. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 74 Contacts Favoris Procédure Étape 1 Accédez aux Favoris en utilisant Accéder aux favoris, à la page 74. Étape 2 Sélectionnez une entrée attribuée. Étape 3 Appuyez sur Suppr. Étape 4 Appuyez sur Suppr pour confirmer la suppression. Contacts locaux Vous pouvez créer une liste de jusqu'à 200 contacts locaux. La liste des contacts locaux est stockée dans la mémoire du téléphone. Si votre administrateur vous donne accès à la page Web d'administration du téléphone, vous pouvez charger et télécharger des contacts. Pour plus d'informations, reportez-vous au Guide d'administration des téléphones IP sans fil Cisco 8821 et 8821-EX pour Cisco Unified Communications Manager. Recherche d'un contact dans votre liste de contacts locaux Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Contacts locaux. Étape 3 Entrez les informations dans la zone de recherche. La liste de contexte se met à jour lorsque vous entrez les informations. Étape 4 (Facultatif) Sélectionnez une entrée et effectuez l’une de ces actions : • Appuyez sur Sélect. • Appuyez sur Autres et sélectionnez Détails. Ajout d’un nouveau contact à votre liste de contacts locaux Vous pouvez ajouter manuellement un contact à votre liste de contacts locaux. Chaque contact nécessite : • un prénom ou un nom • au moins un numéro de téléphone Procédure Étape 1 Ouvrez l’application Contacts. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 75 Contacts Contacts locaux Étape 2 Sélectionnez Contacts locaux. Étape 3 Appuyez sur Autres et sélectionnez Ajouter un nouveau. Étape 4 Saisissez les informations du contact. Étape 5 Appuyez sur Autres et sélectionnez Enregistrer. Modification d'un contact de votre liste de contacts locaux Procédure Étape 1 Recherchez un contact comme décrit dans Recherche d'un contact dans votre liste de contacts locaux, à la page 75. Étape 2 Sélectionnez une entrée, appuyez sur Autres et sélectionnez Détails. Étape 3 Appuyez sur Autres et sélectionnez Modifier. Étape 4 Modifiez ou ajoutez des informations sur votre contact. Étape 5 (Facultatif) Mettez en surbrillance un numéro de contact, appuyez sur Autres, puis sélectionnez marquer comme principal pour définir le numéro principal du contact. Étape 6 Appuyez sur Autres et sélectionnez Enregistrer. Appel d'un contact de votre liste de contacts locaux Lorsque vous appelez un contact local, vous pouvez appeler son numéro principal (affiché avec une coche) ou l’un de ses numéros alternatifs. Procédure Étape 1 Recherchez un contact comme décrit dans Recherche d'un contact dans votre liste de contacts locaux, à la page 75. Étape 2 Sélectionnez un contact. Étape 3 Effectuez l'une des opérations suivantes : • Appuyez sur répondre/envoyer pour appeler le numéro principal. • Appuyez sur Autres, appuyez sur Composer. • Appuyez sur Autres, appuyez sur Détails pour afficher des informations supplémentaires, puis appuyez sur Autres et effectuez l’une de ces actions : • Sélectionnez Composer pour appeler le numéro principal du contact. • Sélectionnez Modifier la numérotation pour sélectionner et appeler un autre numéro. • Appuyez sur Répondre/Envoyer. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 76 Contacts Modification d'un contact de votre liste de contacts locaux Suppression d'un contact de votre liste de contacts locaux Si vous ne voulez pas d'un contact dans votre liste de contacts locaux, vous pouvez supprimer l’entrée. Si le contact figure également dans votre liste de favoris, lorsque voussupprimez le contact de votre liste de contacts locaux, l’entrée dans la liste des favoris est également supprimée. Procédure Étape 1 Recherchez un contact comme décrit dans Recherche d'un contact dans votre liste de contacts locaux, à la page 75. Étape 2 Sélectionnez le contact à supprimer. Étape 3 Appuyez sur Autres et sélectionnez Supprimer. Étape 4 Appuyez sur Suppr pour confirmer la suppression. Suppression de tous les contacts locaux Vous pouvez effacer tous les contacts de votre liste de contacts locaux. Lorsque vous supprimez tous les contacts, vos favoris sont également supprimés. Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Contacts locaux. Étape 3 Appuyez sur Autres et sélectionnez Supprimer tout. Étape 4 Appuyez sur Supprimer tout pour confirmer la suppression. Répertoire personnel Vous pouvez enregistrer des contacts personnels dans votre répertoire personnel. Le système protège votre répertoire personnel avec un ID utilisateur et un NIPque votre administrateur configure. Le répertoire personnel comporte deux parties : • Répertoire personnel : utilisez le répertoire personnel pour stocker les coordonnées de vos amis, de membres de votre famille ou de vos collègues. • Numérotations rapides personnelles : vous utilisez la liste de numérotation rapide personnelle pour composer rapidement le numéro d'un contact. Vous pouvez configurer votre répertoire personnel sur votre téléphone ou depuis le portail Self Care. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 77 Contacts Suppression d'un contact de votre liste de contacts locaux Connexion à un répertoire personnel et déconnexion Avant de commencer Pour pouvoir vous connecter à votre répertoire personnel, vous devez disposer de votre ID utilisateur et de votre code PIN. Communiquez avec votre administrateur si vous ne disposez pas de ces informations. Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Saisissez votre ID utilisateur et votre PIN. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Obligatoire : Dans la fenêtre Répertoire personnel, sélectionnez Déconnexion et appuyez sur OK pour vous déconnecter de votre répertoire personnel. Carnet d'adresses pers. Votre carnet d’adresses personnel contient les contacts que vous saisissez à partir de votre téléphone ou du portail d'aide en libre-service. Vous pouvez avoir jusqu’à 99 contacts dans votre carnet d’adresses personnel. Le téléphone énumère vos contacts personnels de carnet d’adresses par surnom. Recherche d'un contact dans votre carnet d'adresses personnel Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Entrez les critères de recherche. Étape 5 Appuyez sur Autres et sélectionnez Soumettre. Étape 6 (Facultatif) Sélectionnez une entrée, appuyez sur Autres et sélectionnez Modifier. Ajout d’un nouveau contact à votre répertoire personnel Vous pouvez ajouter un contact à votre répertoire personnel. Procédure Étape 1 Ouvrez l’application Contacts. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 78 Contacts Connexion à un répertoire personnel et déconnexion Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Appuyez sur Autreset sélectionnez Nouveau. Étape 6 Entrez le nom de la personne et un surnom. Le répertoire affiche le surnom. Étape 7 Appuyez sur Téléphones. Étape 8 Saisissez au moins un numéro de téléphone. Étape 9 Appuyez sur Soum. Recherche des informations de contact d’un contact du répertoire personnel sur votre téléphone Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Sélectionnez un contact. Étape 6 Appuyez sur Détails. Modification d'un contact figurant dans votre répertoire personnel Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Mettez en surbrillance un contact. Étape 6 Appuyez sur Autres et sélectionnez Modifier. Étape 7 Changez le nom du contact. Étape 8 Appuyez sur Autreset sélectionnez Téléphones. Étape 9 Changez les numéros de téléphone de contact. Étape 10 Appuyez sur MàJ. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 79 Contacts Recherche des informations de contact d’un contact du répertoire personnel sur votre téléphone Appel d'un contact de votre répertoire personnel Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Sélectionnez un contact. Étape 6 Mettez en surbrillance un numéro de téléphone et appuyez sur Composer. Suppression d'un contact de votre carnet d'adresses personnel Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire personnel. Étape 3 Sélectionnez Carnet d'adresses personnel. Étape 4 Appuyez sur Autres et sélectionnez Soumettre. Étape 5 Recherchez un contact. Étape 6 Appuyez sur Autres et sélectionnez Modifier. Étape 7 Appuyez sur Autres et sélectionnez Supprimer. Étape 8 Appuyez sur OK. Répertoire général Vous pouvez rechercher le numéro de téléphone d’un collègue à partir de votre téléphone, et l’appeler ainsi plus aisément. Votre administrateur configure et gère le répertoire. Recherche et appel d'un contact à partir du répertoire d'entreprise Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire d'entreprise. Étape 3 Saisissez les critères de recherche Étape 4 Appuyez sur Autres et sélectionnez Rechercher. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 80 Contacts Appel d'un contact de votre répertoire personnel Étape 5 Appuyez sur Autres et sélectionnez Appel. Recherche des informations de contact d’un collègue sur votre téléphone Procédure Étape 1 Ouvrez l’application Contacts. Étape 2 Sélectionnez Répertoire d'entreprise. Étape 3 Saisissez les critères de recherche Étape 4 Appuyez sur Autres et sélectionnez Rechercher. Étape 5 Obligatoire : Appuyez sur Autres et sélectionnez Détails. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 81 Contacts Recherche des informations de contact d’un collègue sur votre téléphone Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 82 Contacts Recherche des informations de contact d’un collègue sur votre téléphone CHAPITRE 5 Historique des appels • Accès à l’application Récents, à la page 83 • Indicateurs de nouveau message vocal et d’appel en absence, à la page 83 • Liste des appels en absence, à la page 84 • Liste des appels récents, à la page 85 Accès à l’application Récents Vous pouvez ouvrir l'application Récents à partir de l'écran Applications. Vous pouvez visualiser dans l’application Récents, vos messages vocaux, vos appels en absence et vos appels récents. Procédure Étape 1 Dans l’écran vue de ligne, appuyez sur la flèche gauche du cluster de navigation pour afficher l’écran Applications. Étape 2 Dans l’écran Applications, utilisez la touche fléchée gauche du cluster de navigation pour sélectionner Récents . Indicateurs de nouveau message vocal et d’appel en absence La case rouge de l’icône Récents de l’écran Applications indique le nombre de messages vocaux non écoutés et d’appels en absence. Dans l’écran vue ligne, la case rouge à côté de la ligne indique le nombre d’appels manqués Vous pouvez visualiser dans la liste Récents, le nombre d'appels en absence. Lorsque vous avez un message vocal non écouté, une tonalité saccadée peut également être émise lorsque vous accédez à la ligne téléphonique. Cette tonalité saccadée est propre à la ligne. Vous ne l'entendez que lorsque vous utilisez une ligne sur laquelle des messages sont en attente. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 83 Liste des appels en absence Utilisez les listes d'appels en absence pour visualiser les 150 derniers appels individuels et groupes d'appels. Si votre téléphone dispose de plusieurs lignes, votre administrateur peut configurer la liste Appl en abs. afin que les appels de toutes les lignes figurent sur une seule liste. Les appels figurant dans la liste Appl en abs. sont regroupés s’ils proviennent d’un même numéro et s'ils sont consécutifs. Consultation de vos appels en absence Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Appl en abs. Étape 3 Obligatoire : Sélectionnez une ligne téléphonique ou Tous les appels en absence. Recherche des détails sur un appel en absence Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Appl en abs. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels en absence. Étape 4 Sélectionnez un appel en absence. Étape 5 Appuyez sur Autres et sélectionnez Détails. Rappel d’un appel en absence Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Appl en abs. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels en absence. Étape 4 Sélectionnez un appel en absence. Étape 5 Appuyez sur Autres et sélectionnez Appel. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 84 Historique des appels Liste des appels en absence Suppression d'une entrée de la liste des appels en absence Vous pouvez effacer une entrée de votre liste d’appels en absence. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Appl en abs. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels en absence. Étape 4 Sélectionnez un appel en absence. Étape 5 Appuyez sur Autres et sélectionnez Supprimer. Étape 6 Appuyez sur Suppr pour confirmer la suppression. Effacement de la liste des appels en absence Vous pouvez effacer toutes les entrées de votre liste d’appels en absence. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Appl en abs. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels en absence. Étape 4 Appuyez sur Autres et sélectionnez Effacer la liste. Étape 5 Appuyez sur Effacer pour confirmer la suppression. Liste des appels récents Utilisez les listes Récents pour visualiser les 150 derniers appels individuels et groupes d'appels. Si votre téléphone dispose de plusieurs lignes, votre administrateur peut configurer la liste Récents afin que les appels de toutes les lignes figurent sur une seule liste. Les appels figurant dans la liste Récents sont regroupés s’ils proviennent d’un même numéro ou sont émis par ce numéro, et s'ils sont consécutifs. Visualiser vos appels récents Procédure Étape 1 Ouvrez l’application Récents. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 85 Historique des appels Suppression d'une entrée de la liste des appels en absence Étape 2 Sélectionnez Récents. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels récents. Recherche des détails sur un appel récent Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels récents. Étape 4 Sélectionnez un appel. Étape 5 Appuyez sur Autres et sélectionnez Détails. Retour d'un appel récent à partir de la liste Récents Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels récents. Étape 4 Sélectionnez un appel. Étape 5 Appuyez sur Autres et sélectionnez Appel. Création d’un nouveau contact local à partir d’un enregistrement d'appel récent Vous pouvez ajouter une entrée de votre liste de recents dans votre liste de contacts locaux. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Sélectionnez une ligne ou Tous les appels récents. Étape 4 Sélectionnez une entrée. Étape 5 Appuyez sur Autres et sélectionnez Créer un nouveau contact local. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 86 Historique des appels Recherche des détails sur un appel récent Étape 6 Appuyez sur Enreg. Ajouter des informations d’appel récentes à un contact local Si le contact se trouve déjà dans votre liste de contacts locaux, mais que vous voyez un autre numéro, vous pouvez ajouter des informations à l’entrée des contacts locaux existants. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Sélectionnez une ligne ou Tous les appels récents. Étape 4 Sélectionnez une entrée. Étape 5 Appuyez sur Autres et sélectionnez Ajouter à un contact local existant. Suppression d'une entrée du journal d'appels Vous pouvez effacer une entrée de votre liste d’appels récents. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels récents. Étape 4 Sélectionnez une entrée. Étape 5 Appuyez sur Autres et sélectionnez Supprimer. Étape 6 Appuyez sur Suppr pour confirmer la suppression. Effacement de la liste des appels récents Vous pouvez effacer toutes les entrées de votre liste d’appels récents. Procédure Étape 1 Ouvrez l’application Récents. Étape 2 Sélectionnez Récents. Étape 3 Obligatoire : Sélectionnez une ligne ou Tous les appels récents. Étape 4 Appuyez sur Autres et sélectionnez Effacer la liste. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 87 Historique des appels Ajouter des informations d’appel récentes à un contact local Étape 5 Appuyez sur Effacer pour confirmer la suppression. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 88 Historique des appels Effacement de la liste des appels récents CHAPITRE 6 Applications • Appl. et bouton Application, à la page 89 • Utilisation de l'application Push to Talk, à la page 89 Appl. et bouton Application Vous pouvez utiliser l'application Appl. pour accéder à des services spéciaux du téléphone. Utilisez le bouton Application pour lancer des applications comme le service Push to Talk ou d'autres services de votre téléphone. Le bouton Application est situé sur le côté gauche du téléphone. En fonction de la manière dont votre administrateur configure le bouton, vous pourrez l'utiliser depuis l'écran Applications uniquement, depuis n'importe quel menu ou service ou même lorsque le téléphone est verrouillé. Le bouton peut également être configuré pour exécuter une application immédiatement après que vous ayez appuyé sur le bouton, ou seulement après que vous l'ayez maintenu enfoncé pendant plusieurs secondes. Pour plus d'informations, contactez votre administrateur. Utilisation de l'application Push to Talk Vous pouvez utiliser le servicePush to Talk pour communiquer (comme avec une radio bidirectionnelle) avec les membres de votre entreprise. L'administrateur doit configurer le service Push to Talk, puis vous devez vous abonner à ce service dans le portail Self Care. Remarque Votre administrateur système dispose d'informations détaillées sur l'utilisation du service Push to Talk. Push to Talk utilise le même chemin audio que la sonnerie de votre téléphone. Si le chemin audio est celui de la sonnerie du téléphone, lorsque vous utilisez Push to Talk et que vous branchez votre casque, l'audio est acheminé vers le casque. Procédure Étape 1 Depuis l’écran de la vue ligne, appuyez sur la flèche gauche de l’anneau de navigation. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 89 Étape 2 Sélectionnez Apps . Étape 3 Sélectionnez Push to Talk. • Utilisez Application pour commencer ou arrêter une transmission, selon la configuration de votre service. • Utilisez Talk et Stop pour envoyer et recevoir de l’audio. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 90 Applications Utilisation de l'application Push to Talk CHAPITRE 7 Paramètres • Accès à l'application Paramètres, à la page 91 • Réglage du volume lors d'un appel, à la page 102 • Réglage du volume de la sonnerie du téléphone, à la page 102 Accès à l'application Paramètres Vous pouvez utiliser l'application Paramètres pour configurer, gérer et personnaliser votre téléphone. Les entrées de menu grises indiquent que l'administrateur a restreint l'accès au menu. Procédure Étape 1 Dans l’écran vue de ligne, appuyez sur la flèche gauche du cluster de navigation pour afficher l’écran Applications. Étape 2 Dans l’écran Applications, utilisez la touche fléchée gauche du cluster de navigation pour sélectionner Paramètres . Sujets connexes Recherche d’informations relatives à votre téléphone, à la page 117 Accès aux paramètres du téléphone Vous pouvez personnaliser votre téléphone dans le menu Paramètres du téléphone. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres du téléphone Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 91 Passage au mode vibreur pour un appel entrant Vous pouvez configurer votre téléphone pour qu’il vibre lorsque vous avez un appel entrant. La vibration peut être définie différemment selon que la sonnerie du téléphone est activée ou non. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Sons > Vibreur Étape 3 Sélectionnez Sonnerie sur vibreur et appuyez sur Activé pour que le téléphone vibre lorsqu’il sonne. Ou bien, appuyez sur Désactivé pour que le téléphone ne vibre pas lorsqu’il sonne. Étape 4 Sélectionnez Silence sur vibreur et appuyez sur Activé pour que le téléphone vibre lorsque la sonnerie est activée. Ou bien, appuyez sur Désactivé pour que le téléphone ne vibre pas lorsque la sonnerie est activée. Sélection de l’endroit où la sonnerie retentit Lorsque vous recevez un appel entrant, vous pouvez configurer votre téléphone pour faire sonner l'appel sur votre casque ou sur le haut-parleur. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Sons > Puissance de la sonnerie/PTT Étape 3 Sélectionnez l’option requise. Étape 4 Appuyez sur Sélect. Modification de la sonnerie Vous pouvez changer le son que vous entendez pour les appels entrants, et vous pouvez définir une sonnerie distincte pour chaque ligne téléphonique. Si votre environnement de travail est bruyant, vous pouvez utiliser Chirp1 (mobile) et Chirp2 (mobile) pour entendre la sonnerie. Ces sonneries sont optimisées pour le haut-parleur du téléphone sans fil. Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Sons > Sonnerie Étape 3 (Facultatif) Sélectionnez une ligne. Étape 4 Mettez une sonnerie en surbrillance. Étape 5 Appuyez sur Écouter pour entendre la sonnerie. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 92 Paramètres Passage au mode vibreur pour un appel entrant Étape 6 Appuyez sur Sélect. pour utiliser la sonnerie. Réglage du retour de casque Lorsque vous utilisez un casque, vous entendez votre propre voix dansl’oreillette ; c’est l’effet local du casque, également appelé retour du casque. Vous pouvez décider de la quantité d’effet local de votre casque. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Sons > Tonalité côté casque Étape 3 Sélectionnez l'une des options. Désactivation des sons du clavier Vous pouvez désactiver les sons du clavier pour ne pas entendre de bruit lorsque vous appuyez sur un bouton. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Sons > Tonalités des touches Étape 3 Appuyez sur Activé pour activer les tonalités, ou sur Désactivé pour les désactiver. Régler le filtre de bruit de fond Vous pouvez régler la sensibilité du microphone du téléphone pour filtrer le bruit de fond de manière à ce que votre interlocuteur vous entende mieux. Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres du téléphone > Sons > Filtre de bruit de fond Étape 3 Sélectionnez l’un de ces paramètres : Désactivé, Bas, Moyen, Élevé. La valeur par défaut est Désactivé. Réglage de la luminosité de l'écran Vous pouvez régler la luminosité de l'écran du téléphone. La valeur par défaut est 5. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 93 Paramètres Réglage du retour de casque Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Affichage > Luminosité Étape 3 Utilisez les flèches du cluster de navigation pour ajuster la luminosité. Étape 4 Appuyez sur Enreg. Modification de la taille de la police Vous pouvez modifier la taille de police utilisée sur l'écran du téléphone. Le choix d’une plus petite taille de police permet d'afficher plus de texte sur l’écran. Le choix d’une plus grande taille de police permet d'afficher moins de texte sur l’écran. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Affichage > Taille de police Étape 3 Sélectionnez le paramètre requis. Contrôle du voyant LED Un voyant LED est situé dans la partie supérieure de votre téléphone. Lorsque le voyant est activé, il indique l’état du téléphone : • Rouge fixe : le téléphone est branché sur secteur et la batterie est en charge. • Vert fixe : le téléphone est branché sur secteur et la batterie est entièrement chargée. • Orange clignotant rapidement : vous avez un appel entrant. La batterie peut être en cours de chargement ou entièrement chargée. • Vert clignotant rapidement : vous avez un message vocal. Lorsque le téléphone est branché sur secteur, le témoin lumineux vert s'affiche plus longtemps que lorsqu'il est alimenté uniquement par la batterie. • Vert clignotant lentement (toutes les 2 secondes) : le téléphone fonctionne sur batterie. Le téléphone est enregistré auprès du réseau sans fil et il se trouve dans la zone couverte par le service. Si vous le souhaitez, vous pouvez désactiver le voyant. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Indicateur de portée de LED Étape 3 Appuyez sur Désactivé pour désactiver l’indicateur ou sur Activé pour l’activer. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 94 Paramètres Modification de la taille de la police Changement du délai d’expiration de l’affichage Vous pouvez configurer la désactivation automatique de l’écran après un certain temps d'inactivité. Lorsque l’écran est éteint, le téléphone sollicite moins la batterie. Lorsque voussélectionnez un paramètre, l'écran du téléphone s'assombrit aprèsla période d'inactivité spécifiée. Après 10 secondes supplémentaires, l’écran s’éteint et le téléphone passe en mode veille. Le paramètre par défaut est de 10 secondes, Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Affichage > Mettre en veille. Étape 3 Sélectionnez le paramètre d’heure requis. Sujets connexes Désactivation de votre téléphone, à la page 7 Modification du fond d'écran Vous pouvez également changer le papier-peint (fond d'écran) de votre téléphone. Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Affichage > Papier-peint Étape 3 Sélectionnez un papier peint. Si vous ne voyez pas le fond d'écran que vous utilisez actuellement, il n’est pas personnalisé pour l’écran du téléphone. Vous pouvez continuer à utiliser l’ancien fond d’écran. Mais après avoir changé le fond d’écran, le fond d’écran précédent ne sera pas disponible. Étape 4 Appuyez sur Aperçu pour afficher le papier peint. Étape 5 Appuyez sur Enreg. Verrouillage automatique du clavier Vous pouvez configurer le verrouillage automatique du clavier. Si vous configurez le téléphone avec le verrouillage automatique du clavier, le clavier est verrouillé lorsque l’écran du téléphone s’éteint. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Clavier > Verrouillage auto. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 95 Paramètres Changement du délai d’expiration de l’affichage Étape 3 Appuyez sur Activé . Sujets connexes Verrouillage du clavier du téléphone, à la page 8 Réglages de la date et de l'heure Vous pouvez gérer certains paramètres de date et d’heure de votre téléphone. En général, le téléphone configure automatiquement la date, l’heure et le fuseau horaire à l’aide des informations du système de contrôle des appels. Toutefois, vous devrez peut-être remplacer les paramètres automatiques. Réglage manuel de la date et de l'heure Lorsque la date et l’heure du téléphone sont configurées manuellement, vous pouvez modifier les paramètres suivants : • Fuseau horaire automatique • Heure • Date • Fuseau horaire • Utilisation du format 12 ou 24 heures • Format de date Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure Étape 3 Sélectionnez Date et heure automatiques. Étape 4 Appuyez sur Désactivé. Réglage automatique de la date et de l'heure Lorsque la date et l’heure du téléphone sont automatiquement configurées, vous pouvez modifier les paramètres suivants : • Fuseau horaire automatique Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure Étape 3 Sélectionnez Date et heure automatiques. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 96 Paramètres Réglages de la date et de l'heure Étape 4 Appuyez sur Activé . Définition automatique du fuseau horaire Vous pouvez configurer votre téléphone pour définir le fuseau horaire automatiquement ou manuellement. Lorsque le champ Fuseau horaire automatique est activé, vous ne pouvez pas changer le fuseau horaire utilisé par votre téléphone. Lorsque le champFuseau horaire automatique est désactivé, vous pouvez définir le fuseau horaire utilisé par votre téléphone. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure > Fuseau horaire automatique Étape 3 Appuyez sur Désactivé pour pouvoir définir manuellement le fuseau horaire. Étape 4 Appuyez sur Enreg. Définition de l'heure Si la date et l’heure de votre téléphone sont définies manuellement, vous pouvez définir l’heure. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure > Heure Étape 3 Saisissez l’heure sur le clavier. Servez-vous des touches de navigation gauche et droite pour passer d’un champ à l’autre. Étape 4 Appuyez sur Enreg. Définition de la date Si la date et l’heure de votre téléphone sont définies manuellement, vous pouvez définir la date. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure > Date Étape 3 Saisissez la date sur le clavier.Servez-vous destouches de navigation gauche et droite pour passer d’un champ à l’autre. Étape 4 Appuyez sur Enreg. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 97 Paramètres Définition automatique du fuseau horaire Définir le fuseau horaire Vous pouvez définir le fuseau horaire. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure > Fuseau horaire Étape 3 Sélectionnez le fuseau horaire approprié. Étape 4 Appuyez sur Enreg. Utilisation des formats 12 et 24 heures Si la date et l’heure de votre téléphone sont définies manuellement, vous pouvez changer l’affichage de l’heure. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure Étape 3 Sélectionnez Utiliser le format 24 heures. Étape 4 Appuyez sur Désactivé pour le format 12 heures ou sur Activé pour le format 24 heures. Définition du format de date Si la date et l’heure de votre téléphone sont définies manuellement, vous pouvez configurer votre téléphone pour qu'il affiche la date sous l'un des formats prédéfinis. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres tél. > Date et heure > Format de date Étape 3 Sélectionnez le format approprié. Étape 4 Appuyez sur Enreg. Régler l’affichage du niveau de la batterie Vous pouvez configurer le téléphone pour qu'il affiche la puissance de la batterie sous forme de pourcentage, en plus de l'icône de niveau de batterie. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 98 Paramètres Définir le fuseau horaire Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Paramètres du téléphone > Pourcentage de la batterie Étape 3 Appuyez sur Activé pour afficher la puissance sous forme de pourcentage ou appuyez sur Désactivé pour afficher la puissance en tant qu’icône. Sujets connexes Icônes d’en-tête, à la page 16 Accès aux paramètres Bluetooth Vous pouvez connecter des casques Bluetooth et des haut-parleurs Bluetooth à votre téléphone. Le téléphone ne prend en charge aucun autre appareil Bluetooth.Pour pouvoir utiliser un casque ou un haut-parleur Bluetooth, vous devez configurer votre téléphone pour Bluetooth. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth. Sujets connexes Casques Bluetooth, à la page 105 Bluetooth et votre téléphone, à la page 20 Activation de Bluetooth Pour pouvoir utiliser Bluetooth, vous devez activer la capacité du téléphone à utiliser Bluetooth. Remarque Quand vous utilisez Bluetooth, la batterie du téléphone est davantage sollicitée et le temps de parole est réduit. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth > Bluetooth. Étape 3 Appuyez sur Activé . Ajout d’un nouveau casque Bluetooth Vous pouvez ajouter jusqu'à 5 casques Bluetooth. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 99 Paramètres Accès aux paramètres Bluetooth Avant de commencer Bluetooth doit être activé. Procédure Étape 1 Assurez-vous que votre casque Bluetooth est détectable. Étape 2 Ouvrez l'application Paramètres. Étape 3 Sélectionnez Bluetooth. Étape 4 Sélectionnez Ajouter périphérique Bluetooth. Le téléphone recherche les accessoires Bluetooth qui sont dans la portée. Cette recherche peut durer quelques minutes. Étape 5 Sélectionnez un périphérique dans la liste, puis appuyez sur Jumeler. Étape 6 (Facultatif) Saisissez la clé d’accès du périphérique. Connexion d’un casque Bluetooth Un fois que vous avez jumelé et connecté un casque Bluetooth à votre téléphone, le casque se connecte automatiquement lorsqu’il est activé et près de votre téléphone. Un seul casque Bluetooth peut être connecté au téléphone. Cependant, si deux casques Bluetooth sont activés, le téléphone utilise celui qui s’est connecté le plus récemment. Vous pouvez changer le casque qui est utilisé par le téléphone. Avant de commencer Bluetooth doit être activé et le casque doit déjà avoir été ajouté à la liste des périphériques Bluetooth. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth. Étape 3 Sélectionnez un périphérique dans la liste. Étape 4 Obligatoire : Appuyez sur Autres et sélectionnez Connecter. Changement du nom d’un casque Bluetooth Si plusieurs entrées de la liste des périphérique Bluetooth sont identiques, vous pouvez renommer les entrées. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth. Étape 3 Sélectionnez un périphérique dans la liste. Étape 4 Obligatoire : Appuyez sur Autres et sélectionnez Renommer. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 100 Paramètres Connexion d’un casque Bluetooth Étape 5 À l'aide du clavier, saisissez un nom. Déconnexion d'un casque Bluetooth Si un casque Bluetooth est connecté à votre téléphone etsi vous voulez utiliser ce casque avec votre ordinateur ou votre téléphone portable, vous pouvez déconnecter le casque Bluetooth. Le casque apparaît toujours dans la liste des périphériques Bluetooth et vous pouvez le reconnecter. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth. Étape 3 Sélectionnez un périphérique dans la liste. Étape 4 Obligatoire : Appuyez sur Autres et sélectionnez Déconnecter. Suppression d’un casque Bluetooth Si vous ne voulez pas qu’un casque Bluetooth figure dans la liste des périphériques disponibles, vous pouvez le supprimer. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Bluetooth. Étape 3 Sélectionnez un périphérique dans la liste. Étape 4 Obligatoire : Appuyez sur Autres et sélectionnez Supprimer. Accès aux paramètres d’administration Votre administrateur peut restreindre l'accès à ce menu. Pour obtenir des informations sur ce menu, reportez-vous à Guide d'administration des téléphones IP sans fil Cisco 8821 et 8821-EX pour Cisco Unified Communications Manager. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres admin. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 101 Paramètres Déconnexion d'un casque Bluetooth Réglage du volume lors d'un appel Si le volume du combiné, du casque ou du haut-parleur est trop élevé ou trop bas, vous pouvez le régler pendant que vous écoutez l'autre personne. Lorsque vousréglez le volume lors d’un appel, le réglage n’affecte que le haut-parleur que vous utilisez. Par exemple, si vous réglez le volume alors que vous utilisez un casque, le volume du combiné ne change pas. Procédure Appuyez en haut ou en bas du bouton Volume pour régler le volume pendant un appel. Réglage du volume de la sonnerie du téléphone Si le volume de la sonnerie est trop élevé ou trop bas lors d'un appel entrant, vous pouvez régler le volume de la sonnerie. Les modifications apportées au volume de la sonnerie n'affectent pas le volume de l'appel que vous entendez lorsque vous êtes en communication. Procédure Appuyez en haut ou en bas du bouton Volume pour régler le volume de la sonnerie lorsque le téléphone n’est pas en cours d'utilisation. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 102 Paramètres Réglage du volume lors d'un appel CHAPITRE 8 Accessoires • Accessoires pris en charge, à la page 103 • Casques, à la page 104 • Chargeurs de bureau, à la page 105 • Chargeurs multiples, à la page 109 • Sécurisation du chargeur à l’aide d’un câble de verrouillage, à la page 114 Accessoires pris en charge Vous pouvez plusieurs accessoires avec votre téléphone. • Casques : • Casques standard utilisant une prise de 3,5 mm • Casques Bluetooth • Chargeur de bureau pour téléphone IP sans fil Cisco 8821: charge le Téléphone IP sans fil Cisco 8821 uniquement • Chargeur de bureau pour Téléphone IP sans fil Cisco 8821-EX: charge le Téléphone IP sans fil Cisco 8821-EX uniquement • Multi chargeur pour Téléphone IP sans fil Cisco 8821: charge le Téléphone IP sans fil Cisco 8821 uniquement • Multichargeur pour Téléphone IPsansfil Cisco 8821-EX: charge le Téléphone IPsansfil Cisco 8821-EX uniquement Le Téléphone IP sans fil Cisco 8821-EX n’a pas été testé ou certifié pour l’utilisation avec des accessoires dans une atmosphère potentiellement explosive. Remarque Les téléphones ne peuvent se connecter qu’à des haut-parleurs et des casques Bluetooth. Ils ne prennent en charge aucun autre type de périphérique Bluetooth. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 103 Pour plus d’informations sur les accessoires, reportez-vous au Guide des accessoires pour les téléphones IP sans fil Cisco série 882x à l'adresse http://www.cisco.com/c/en/us/support/collaboration-endpoints/ unified-ip-phone-8800-series/products-user-guide-list.html. Casques Vous pouvez utiliser des casques filaires et Bluetooth avec votre téléphone. Pour obtenir des informations sur les casques pris en charge, reportez-vous au Guide des accessoires pour les téléphones IP sans fil Cisco série 882x . Bien que des tests internes soient effectués sur des casques filaires et Bluetooth sans fil de fabricants tiers pouvant être utilisés avec le Téléphones IP sans fil Cisco 8821 et 8821-EX, nous ne certifions pas et ne promouvons pas les produits des fournisseurs de casques ou de combinés. En raison des contraintes environnementales et matérielles inhérentes aux différents sites de déploiement des téléphones, il n'existe pas de solution « optimale » unique convenant à tous les environnements. Il est recommandé aux clients de tester les casques qui sont le mieux adaptés à leur environnement avant de déployer un grand nombre d'unités dans leur réseau. Le Téléphone IP sans fil Cisco 8821-EX n’a pas été testé pour l’utilisation de casques filaires et Bluetooth en environnement dangereux. Remarque Il est recommandé d'utiliser des périphériques externes de bonne qualité, par exemple des casques blindés contre les interférences produites par les signaux de fréquences radio (FR) ou audio (FA). En fonction de la qualité de ces périphériques et de leur proximité par rapport à d'autres appareils, comme lestéléphones portables et les radios bidirectionnelles, des parasites sonores peuvent toujours se produire. Pour déterminer si un casque donné convient au téléphone, vérifiez avant tout qu'il ne provoque pas de ronflement sonore. Ce ronflement peut être audible soit uniquement par votre interlocuteur, soit par votre interlocuteur et par vous, l'utilisateur du téléphone. Certainsronflements ou bourdonnements potentiels peuvent être dus à de nombreuses causes extérieures, par exemple l'éclairage électrique, les moteurs électriques ou de grands moniteurs d’ordinateur. Dans certains cas, les pièces mécaniques ou les composants électroniques de différents casques peuvent provoquer un écho sur le poste des interlocuteurs des utilisateurs des téléphones. Sujets connexes Passage d'un appel avec un casque, à la page 54 Informations importantes relatives à la sécurité des casques Pression sonore élevée : évitez d'écouter à des niveaux de volume élevés pendant de longues périodes pour éviter d'éventuels dommages auditifs. Lors du branchement de votre casque, baissez le volume de son haut-parleur avant de le placer sur votre tête. Si vous pensez à baisser le volume avant d’ôter le casque, le volume sera à un niveau faible lorsque vous rebrancherez votre casque. N’oubliez pas votre environnement. L’utilisation de votre casque risque de vous empêcher d’entendre des sons externes importants, en particulier en cas d’urgence ou dans des environnements bruyants. N’utilisez pas le casque pendant que vous conduisez. Ne laissez pas votre casque ou vos câbles dans un endroit où des Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 104 Accessoires Casques personnes ou des animaux peuvent trébucher dessus.Surveillez toujoursles enfants quise trouvent à proximité de votre casque ou de vos câbles. Casques standard Vous pouvez utiliser un casque avec fil avec votre téléphone. Le casque nécessite une prise de 3,5 mm à 4 connecteurs et 3 bandes. Si vous branchez un casque dans le téléphone alors que vous êtes en communication, le chemin audio est automatiquement redirigé vers le casque. Casques Bluetooth Vous pouvez utiliser un casque Bluetooth avec votre téléphone. Lorsque vous utilisez un casque sans fil Bluetooth, ce dernier augmente généralement la consommation de la batterie de votre téléphone et peut entraîner une réduction de la durée de vie de la batterie. Pour qu'un casque sans fil Bluetooth fonctionne correctement, il n'est pas nécessaire de se trouver dans le champ direct du téléphone. Certains obstacles, comme les murs et les portes, ainsi que les interférences issues d'autres appareils électroniques, peuvent toutefois affecter la connexion. Sujets connexes Accès aux paramètres Bluetooth, à la page 99 Bluetooth et votre téléphone, à la page 20 Conseils relatifs au casque Si votre casque dispose d'un bouton de contrôle, vous pouvez utiliser le casque (mode casque) et le microphone du téléphone pour écouter votre voix. Il suffit d'appuyer sur le bouton de contrôle lorsque vous branchez le casque du téléphone. Si vous utilisez ce mode, le microphone du téléphone filtre automatiquement le bruit de fond. Sujets connexes Régler le filtre de bruit de fond, à la page 93 Chargeurs de bureau Vous pouvez utiliser le Chargeur de bureau pour téléphone IPsansfil Cisco 8821 pour charger votre Téléphone IP sans fil Cisco 8821 et la batterie de rechange. Le chargeur fonctionne sur secteur ou sur une batterie de rechange chargée. Il peut être fixé à l'aide d’un verrouillage de câble standard. Ce chargeur comporte une étiquette au dos indiquant la tension maximale (4,35 V). Vous pouvez utiliser le Chargeur de bureau pour Téléphone IP sans fil Cisco 8821-EX pour charger votre Téléphone IP sans fil Cisco 8821-EX et la batterie de rechange. Le chargeur fonctionne sur secteur ou sur une batterie de rechange chargée. Il peut être fixé à l'aide d’un verrouillage de câble standard. Le chargeur a le même aspect que le Chargeur de bureau pour téléphone IP sans fil Cisco 8821 sauf su'il affiche le graphique du Téléphone IP sans fil Cisco 8821-EX et ne comporte pas d'étiquette indiquant la tension. La figure suivante illustre le chargeur avec un téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 105 Accessoires Casques standard Illustration 5 : Téléphone IP sans fil Cisco 8821 et Chargeur de bureau pour téléphone IP sans fil Cisco 8821 Le Chargeur de bureau pour téléphone IP sans fil Cisco 8821 peut seulement charger le Téléphone IP sans fil Cisco 8821 et une batterie de rechange pour ce téléphone. Vous ne pouvez pas charger le Téléphone IP sans fil Cisco 8821-EX ou ses batteries de rechange dans le Chargeur de bureau pour téléphone IP sans fil Cisco 8821. Mise en garde Dans ce document, le terme chargeur de bureau fait référence aux deux chargeurs. Si votre téléphone est dans un étui de protection, il n’est pas nécessaire de le retirer de l’étui avant de le charger à l'aide du chargeur de bureau. Vous devez adapter le chargeur à la taille du téléphone. Vous pouvez utiliser un adaptateur USB vers Ethernet (clé) pour connecter le chargeur de bureau à l'Ethernet uniquement pour obtenir une mise à disposition automatique du profil Wifi et d'inscription automatique du certificat. Vous ne pouvez pas utiliser la clé pour passer des appels vocaux sur Ethernet. Pour plus d’informations sur le port USB, reportez-vous au Guide d'administration des téléphones IP sans fil Cisco 8821 et 8821-EX. N’utilisez pas le chargeur ou le mode mains libres dans une atmosphère potentiellement explosive. Ne chargez pas le téléphone s'il est humide. Mise en garde Haut-parleur intégré Le chargeur comporte un haut-parleur que vous pouvez utiliser pendant que le téléphone est connecté à sa station d'accueil. Utilisez les boutons de volume du téléphone pour contrôler le volume du haut-parleur, et le bouton Mise en sourdine sur le chargeur lui-même. Lorsque le son du haut-parleur est coupé, le bouton Silence est allumé en rouge. Indications de recharge de téléphone Lorsque vous placez le téléphone dans le chargeur, le téléphone indique que la batterie est en cours de chargement à l'aide d'un voyant lumineux rouge situé en haut du téléphone. Si le téléphone est allumé lorsque vous le placez dans le chargeur, un message apparaît sur l’écran. Si le téléphone est éteint ou si la batterie est trop faible, une icône s'affiche à l'écran. Lorsque la batterie est chargée, le voyant s'allume en vert. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 106 Accessoires Chargeurs de bureau Indications de chargement de la batterie de rechange Vous pouvez charger une batterie de rechange dans le port de charge supplémentaire situé derrrière le port de charge principal du téléphone. Lorsque vous placez une batterie de rechange dans le chargeur, le voyant de la batterie (à droite du téléphone) s'allume pour indiquer l'état de la charge : • Rouge : la batterie de rechange est en cours de chargement. • Vert : la batterie de rechange est complètement chargée. Sujets connexes Passage d'un appel à l'aide du haut-parleur du téléphone, à la page 55 Configuration du chargeur de bureau Posez le chargeur de bureau sur une surface de travail stable. Avant de commencer Vous aurez besoin du câble livré avec le chargeur. Ce câble est équipé d’une prise à une extrémité et d’un connecteur USB à l’autre. Vous aurez besoin du câble d’alimentation livré avec votre téléphone. Procédure Étape 1 Branchez la prise du câble dans le chargeur de bureau. Étape 2 Branchez le connecteur USB du câble dans l’adaptateur d’alimentation et branchez l’adaptateur dans une prise électrique. Chargement du téléphone avec le chargeur de bureau Lorsque le téléphone est en charge dans le chargeur, le voyant du téléphone s'allume en rouge et un message ou une icône s’affiche sur l’écran du téléphone. Lorsque la batterie est complètement chargée, le voyant s'allume en vert. Le chargement du téléphone peut nécessiter jusqu'à 3 heures. Si votre téléphone est dans un étui de protection, il n’est pas nécessaire de le retirer de l’étui avant de le charger à l'aide du chargeur de bureau. Vous devez adapter le chargeur à la taille du téléphone. Lorsque vous placez le téléphone dans le chargeur, prenez soin d’aligner les broches de chargement situées sous le téléphone sur le connecteur du chargeur. Lorsque le téléphone est correctement placé dans le chargeur, il est maintenu en place par des aimants. Si le voyant ne s'allume pas, les broches sont mal alignées. Ne chargez pas le téléphone dans un environnement dangereux. Ne chargez pas le téléphone s'il est humide. Mise en garde Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 107 Accessoires Configuration du chargeur de bureau Procédure Étape 1 (Facultatif) Adaptez le chargeur à un téléphone dans un étui : tournez le chargeur de manière à ce que le dos soit face à vous, placez trois doigts au 3/4 dansle module, appuyez et décrochez. Le module devraitse détacher. Remarque Vous devrez peut-être utiliser les deux mains pour enlever le module la première fois. Étape 2 Placez le téléphone dans le logement de recharge, de manière à ce que l’écran soit face à vous. Si votre téléphone se trouve dans un étui, appuyez le téléphone dans le logement de chargement pour vous assurer que le téléphone est relié aux contacts. Vérifiez que le voyant du téléphone s’allume en rouge. Si le voyant ne s'allume pas, retirez le téléphone et insérez-le de nouveau dans le chargeur. Si votre téléphone est dans un étui, le téléphone et l'étui s'inclineront vers l'extérieur à cause de l'étui. Étape 3 Lorsque vousle retirez du chargeur, inclinez le téléphone versl'avant etsoulevez-le pour dégager le connecteur des aimants. Étape 4 (Facultatif) Faites glisser le module de chargement dans le chargeur. Assurez-vous que le module soit aligné avec l'avant et le haut du chargeur. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 108 Accessoires Chargement du téléphone avec le chargeur de bureau Chargez la batterie de rechange avec le chargeur de bureau Vous pouvez charger une batterie de rechange dans le chargeur de bureau. Le chargement de la batterie peut nécessiter jusqu'à 3 heures. Mise en garde Ne chargez pas la batterie dans un environnement dangereux. Lorsque la batterie est en charge, le voyant du chargeur qui correspond à la batterie de rechange s'allume en rouge. Lorsque la batterie est chargée, le voyant du chargeur qui correspond à la batterie de rechange s'allume en vert. Procédure Étape 1 Tenez la batterie de telle façon que l’étiquette Cisco soit face à vous et que les flèches figurant sur la batterie pointent vers le bas. Étape 2 Placez la batterie de rechange dans le logement situé derrière le socle du téléphone et appuyez fermement dessus. Chargeurs multiples Vous pouvez charger simultanément jusqu’à six Téléphone IP sans fil Cisco 8821 et six batteries de rechange à l’aide du Multi chargeur pour Téléphone IP sans fil Cisco 8821. Si votre téléphone se trouve dans un étui de protection, vous pouvez le charger sans le retirer de l’étui. Ce chargeur comporte une étiquette au dos indiquant la tension maximale (4,35 V). Vous pouvez charger simultanément jusqu’à six Téléphone IP sans fil Cisco 8821-EX et six batteries de rechange à l’aide du Multichargeur pour Téléphone IP sans fil Cisco 8821-EX. Si votre téléphone se trouve dans un étui de protection, vous pouvez le charger sans le retirer de l’étui. Le chargeur a le même aspect que le Multi chargeur pour Téléphone IP sans fil Cisco 8821 sauf su'il affiche le graphique du Téléphone IP sans fil Cisco 8821-EX et ne comporte pas d'étiquette indiquant la tension. La figure suivante montre le chargeur multiple. Les téléphones sont placés dans les emplacements de charge à gauche et à droite, et les batteries de rechange sont placées au centre. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 109 Accessoires Chargez la batterie de rechange avec le chargeur de bureau Illustration 6 : Téléphone IP sans fil Cisco 8821 et Multi chargeur pour Téléphone IP sans fil Cisco 8821 Vous pouvez placer le chargeur multiple sur une surface de travail, ou le fixer sur un mur à l'aide du kit de fixation murale. Vous pouvez aussi fixer le chargeur multiple à l'aide d’un verrouillage de câble standard pour ordinateur portable. Le Multi chargeur pour Téléphone IP sans fil Cisco 8821 peut seulement charger le Téléphone IP sans fil Cisco 8821 et une batterie de rechange pour ce téléphone. Vous ne pouvez pas charger le Téléphone IP sans fil Cisco 8821-EX ou ses batteries de rechange dans le Multi chargeur pour Téléphone IP sans fil Cisco 8821. Mise en garde Dans ce document, le terme Chargeur multiple fait référence aux deux chargeurs. Le voyant du téléphone indique l'état de charge. Lorsque la batterie est en cours de charge, le voyant s'allume en rouge. Lorsque la batterie est chargée, le voyant s'allume en vert. Le voyant situé à côté de la batterie de rechange indique l'état de chargement. Lorsque la batterie est en cours de charge, le voyant s'allume en rouge. Lorsque la batterie est chargée, le voyant s'allume en vert. Les voyants d'emplacement de la batterie peuvent mettre plusieurs minutes pour indiquer que la batterie est complètement chargée. Si vous déplacez une batterie entièrement chargée vers un autre emplacement, le voyant risque de s'allumer initialement en rouge avant de s'allumer en vert. N’utilisez pas le chargeur dans une atmosphère potentiellement explosive. Ne chargez pas le téléphone s'il est humide. Mise en garde Configuration du chargeur multiple La prise d'alimentation est située sur le côté droit du chargeur multiple. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 110 Accessoires Configuration du chargeur multiple Procédure Étape 1 Branchez la prise du cordon d'alimentation dans le chargeur multiple. Étape 2 Branchez l'autre extrémité du cordon d'alimentation dans l’adaptateur d'alimentation. Étape 3 Branchez l'adaptateur d'alimentation dans la prise secteur. Étape 4 Posez le chargeur multiple sur une surface de travail stable. Installation du kit de fixation murale pour chargeur multiple Le kit de fixation murale est constitué des composants suivants : • Support • Paquet de 5 vis et 5 ancrages muraux auto-taraudeurs Avant de commencer Les outils suivants vous sont nécessaires : • Perceuse et mèche de 0,63 cm • Crayon • Niveau • Tournevis à tête cruciforme n° 1 et n° 2 Vous aurez besoin du câble d’alimentation et de l’adaptateur d’alimentation. Procédure Étape 1 Trouvez un emplacement pour le support. Le coin inférieur droit du support doit être situé à moins de 127 cm d’une prise électrique. Étape 2 Fixez le support mural. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 111 Accessoires Installation du kit de fixation murale pour chargeur multiple a) Tenez le support contre le mur, comme illustré. b) Utilisez le niveau pour vérifier que le support est à niveau, puis tracez l’emplacement des orifices de fixation à l'aide du crayon. c) Fixez les ancrages à l’aide de la perceuse et de la mèche. d) Vissez le support dans le mur. Étape 3 Localisez les récepteurs de tenons du chargeur multiple. Étape 4 Tenez le chargeur multiple de telle façon que les récepteurs de tenons soient alignés sur les tenons du support, placez le chargeur contre le mur, puis poussez-le vers le bas afin d’insérer les tenons dans les récepteurs. Voici un gros plan du support de tenons. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 112 Accessoires Installation du kit de fixation murale pour chargeur multiple Étape 5 Branchez la prise du cordon d'alimentation dans le chargeur multiple. Étape 6 Branchez l'autre extrémité du cordon d'alimentation dans l’adaptateur d'alimentation. Étape 7 Branchez l'adaptateur d'alimentation dans la prise secteur. Chargement du téléphone avec le chargeur multiple Lorsque le téléphone est en charge dansle chargeur multiple, le voyant du téléphone s'allume en rouge. Lorsque la batterie est complètement chargée, le voyant s'allume en vert. Le chargement du téléphone peut nécessiter jusqu'à 3 heures. Si votre téléphone est dans un étui de protection, il n’est pas nécessaire de le retirer de l’étui avant de le charger à l'aide du chargeur multiple. Vous devez adapter le chargeur multiple à la taille du téléphone. Lorsque vous placez le téléphone dans le chargeur multiple, prenez soin d’aligner les broches de chargement situées sous le téléphone sur le connecteur du chargeur multiple. Si le voyant ne s'allume pas, les broches sont mal alignées. Ne chargez pas le téléphone dans un environnement dangereux. Ne chargez pas le téléphone s'il est humide. Mise en garde Procédure Étape 1 (Facultatif) Adaptez le chargeur à un téléphone dans un étui : mettez trois doigts dansl'emplacement de charge, localisez les fentes à l'intérieur du module et utilisez les fentes pour retirer le module. Étape 2 Placez le téléphone dans le logement de chargement vide. Si votre téléphone se trouve dans un étui, appuyez le téléphone dans le logement de chargement pour vous assurer que le téléphone est relié aux contacts. Vérifiez que le voyant du téléphone s’allume en rouge. Si le voyant ne s'allume pas, retirez le téléphone et insérez-le de nouveau dans le chargeur multiple. Étape 3 (Facultatif) Faites glisser le module de chargement dans le chargeur multiple, et appuyez sur le module pour le mettre en place, de façon qu'il soit au même niveau que le chargeur multiple. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 113 Accessoires Chargement du téléphone avec le chargeur multiple Chargez la batterie de rechange avec le chargeur multiple Vous pouvez charger une batterie de rechange dans le chargeur multiple. Le chargement de la batterie peut nécessiter jusqu'à 3 heures. Mise en garde Ne chargez pas la batterie dans un environnement dangereux. Lorsque la batterie est en charge, le voyant du chargeur qui correspond à la batterie et qui est situé près de la batterie s'allume en rouge. Lorsque la batterie est chargée, le voyant qui correspond à la batterie s'allume en vert. Procédure Placez la batterie dans un logement vide, en alignant les contacts de la batterie sur le connecteur du chargeur. Si le voyant correspondant à la batterie ne s'allume pas en rouge, retirez la batterie et insérez-la de nouveau dans le logement de batterie. Sécurisation du chargeur à l’aide d’un câble de verrouillage Vous pouvez fixer le chargeur de bureau ou le chargeur multiple à l'aide d'un câble de verrouillage d'ordinateur portable d'une largeur maximum de 20 mm. Procédure Étape 1 Tenez l'extrémité en boucle du câble de verrouillage et entourez-la autour de l'objet sur lequel vous voulez fixer votre téléphone. Étape 2 Passez le verrou dans l'extrémité en boucle du câble. Étape 3 Déverrouillez le verrou du câble. Étape 4 Appuyez sur le bouton de verrouillage et maintenez la pression pour aligner les dents de verrouillage. Étape 5 Insérez le verrou du câble dans le logement de verrouillage de votre chargeur et relâchez le bouton de verrouillage. Étape 6 Verrouillez le verrou du câble. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 114 Accessoires Chargez la batterie de rechange avec le chargeur multiple CHAPITRE 9 Dépannage • Informations générales de dépannage, à la page 115 • Recherche d’informations relatives à votre téléphone, à la page 117 • Diagnostics du matériel, à la page 117 • Créer un rapport de problème à partir du téléphone, à la page 120 Informations générales de dépannage Vous pouvez résoudre certains problèmes généraux sur votre téléphone. Si votre problème n’est pas abordé ci-après, communiquez avec votre administrateur. Symptôme Explication Cela peut être dû à une ou à plusieurs des raisons ci-dessous : • Votre téléphone est en dehors de la zone de service du point d'accès au réseau sans fil. Lorsque vous vous déplacez avec votre téléphone, un témoin lumineux de couleur verte indique que l'appareil se trouve toujours dans la zone de couverture de services sans fil. Remarque • Vous devez vous connecter au service de mobilité de poste. • Vous devez entrer un code d'affaire client ou un code d'autorisation forcée après avoir composé un numéro. • Votre téléphone est soumis à des restrictions horaires qui vous empêchent d'utiliser certaines fonctions à certaines heures de la journée. Vous n'arrivez pas à passer un appel Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 115 Symptôme Explication L'un des messages ci-dessous s'affiche sur la ligne d'état : • Réseau occupé : la bande passante du réseau sans fil est insuffisante pour pouvoir passer l'appel. Réessayez ultérieurement. • Sortie de la zone de service : le téléphone est hors de portée du point d'accès et du réseau sans fil qui lui sont associés. • Localisation de services réseau : le téléphone recherche un point d'accès au réseau sans fil. • Échec de l'authentification : les informations de sécurité n'ont pas été acceptées par le serveur d'authentification. • Configuration IP : le téléphone attend qu'une adresse IP soit affectée par DHCP. L'écran principal n'est pas actif Votre administrateur a peut-être désactivé l'accès à l’application Paramètres de votre téléphone. Le menu Paramètres ne répond pas Plusieurs appels doivent être sélectionnés pour établir une conférence. Vérifiez que vous avez sélectionné au moins un appel en plus de l'appel actif, qui est sélectionné automatiquement. L'option Conférence nécessite également que les appels sélectionnés se trouvent sur la même ligne. Si nécessaire, transférez les appels vers une ligne avant de les joindre. Échec de la conférence Cela peut être dû à une ou à plusieurs des raisons ci-dessous : • Vous devez appuyersur Autres pour afficher des fonctions supplémentaires. • Vous devez changer l'état de la ligne (par exemple, passez un appel ou connectez-vous à un appel). • Votre téléphone n'est pas configuré pour prendre en charge la fonction associée à cette touche dynamique. La touche que vous voulez utiliser ne s'affiche pas. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 116 Dépannage Informations générales de dépannage Symptôme Explication Cela peut être dû à une ou à plusieurs des raisons ci-dessous : • Vous ne pouvez pas vous connecter à un appel chiffré si le téléphone que vous utilisez n'est pas configuré pour le chiffrement. Si votre tentative d'insertion échoue pour cette raison, le téléphone émet une tonalité occupé rapide. • Vous ne pouvez pas vous connecter à un appel sur un autre téléphone IP sans fil Cisco. La fonction d'insertion échoue et déclenche une tonalité d'occupation rapide. Lorsque vous vous connectez à un appel à l'aide de la touche Insertion, vous en êtes déconnecté s'il est mis en garde, transféré ou transformé en conférence. Vous êtes déconnecté d'un appel auquel vous avez accédé via la fonction Insertion. Votre interlocuteur a peut-être activé la fonction de renvoi d'appels. Échec du rappel Il est possible que votre tentative de configuration du renvoi de tous les appels directement sur le téléphone soit refusée parce que le numéro cible saisi a pour effet de créer une boucle de renvoi de tous les appels ou de dépasser le nombre maximal de liens autorisés dans une chaîne de renvoi de tous les appels (également appelé nombre maximum de sauts). Le téléphone affiche un message d'erreur lorsque vous tentez de configurer le renvoi de tous les appels. Recherche d’informations relatives à votre téléphone Il peut arriver que votre administrateur vous demande des informations sur votre téléphone. Ces informations permettent d’identifier le téléphone de façon unique etsont utileslors d’un éventuel dépannage. Lesinformations de ce menu sont en lecture seule.Pour plus d’informationssur le menu, reportez-vous au Guide d'administration des téléphones IP sans fil Cisco 8821 et 8821-EX pour Cisco Unified Communications Manager. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Informations sur le téléphone. Diagnostics du matériel Vous pouvez exécuter des tests de diagnostics sur votre téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 117 Dépannage Recherche d’informations relatives à votre téléphone Exécution des diagnostics audio Vous pouvez vérifier le bon fonctionnement de l’audio de votre téléphone. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres admin > Diagnostics > Audio. Étape 3 Écoutez la tonalité sur le haut-parleur du combiné. Étape 4 Appuyez sur le bouton Haut-parleur ) pour activer le mode mains libres et écouter la tonalité. Étape 5 Branchez un casque filaire et écoutez la tonalité. Exécution de diagnostics WLAN Vous pouvez vérifier la connexion Wi-Fi de votre téléphone. Le téléphone répertorie les points d'accès dans l’ordre, du signal le plus puissant au signal le plus faible ou au point d'accès désactivé. Vous pouvez alors afficher les détails du point d'accès sans fil. Procédure Étape 1 Ouvrez l'application Paramètres. Étape 2 Sélectionnez Paramètres admin > Diagnostics > WLAN. Étape 3 Appuyez sur Continuer. Étape 4 Allez jusqu’à un point d'accès et appuyez sur Sélect. pour afficher des informations détaillées sur le point d'accès. Champs Diagnostics WLAN Le tableau suivant décrit les champs de l’écran Diagnostics WLAN. Champ Description Nom du point d’accès Nom du point d’accès auquel le téléphone est associé. BSSID Adresse MAC radio du point d'accès Identifiant SSID (Service Set Identifier) utilisé par le téléphone SSID Fréquence Fréquence utilisée par le téléphone Canal actuel Canal utilisé par le téléphone Dernier indicateur de puissance de signal (RSSI) reçu par le téléphone. Dernier RSSI Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 118 Dépannage Exécution des diagnostics audio Champ Description Nombre d'unités de temps entre les balises. Une unité de temps correspond à 1,024 millisecondes. Intervalle de balise Capacité Fonctionnalités 802.11 Débits de donnéesrequis par le point d'accès, auxquels la station doit être capable de fonctionner. Taux de base Débits de taux de données pris en charge par le point d'accès, qui sont facultatifs et auxquels la station peut fonctionner. Taux facultatifs HT MCS pris en charge Débits de données 802.11n Taux VHT (rx) pris en charge Débits de réception de données 802.11ac Taux VHT (tx) pris en charge Débits de données de transmission 802.11ac Informations sur la carte d’indication de trafic de remise Période de DTIM Indicatif du pays à deux chiffres. Il est possible que les informations relatives au pays ne soient pas affichéessi l'élément d’informations(IE, information element) du pays n'est pas présent dans la balise. Indicatif du pays Canaux Liste des canaux pris en charge (depuis l'IE du pays). Décalage de contrainte pour l'alimentation 802.11h, en dB Exigence relative à l’alimentation Valeur du contrôle de l’alimentation pour la transmission dynamique (DTCP, Transmit Power Control) publiée par le point d'accès. Restriction relative à l’alimentation Pourcentage de temps, normalisé à 255, pendant lequel le point d'accès a détecté que le support était occupé, comme indiqué par le mécanisme CS (carrier sense) physique ou virtuel. Utilisation canal Nombre total d’algorithmes Spanning Tree (STA) actuellement associés à ce point d'accès. Nombre de stations Entier non signé qui précise la durée de support restante disponible via le contrôle d'accès explicite, en unités de 32 microsecondes par seconde. Capacité d’admission WMM pris en charge Prise en charge de Wi-Fi Multimedia Extensions. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 119 Dépannage Champs Diagnostics WLAN Champ Description Le mode de livraison d’économie d'énergie automatique non programmée (UAPSD) est pris en charge par le point d'accès. Il est possible que cette fonctionnalité ne soit disponible que si WMM est pris en charge. Cette fonctionnalité est essentielle pour le temps de parole et pour atteindre une densité d'appel maximale sur le téléphone IP sans fil. UAPSD pris en charge Les points d'accèsrépondant à la norme CCX prennent en charge la réponse aux requêtes ARP IP au nom de la station associée. Cette fonction est essentielle au temps de veille sur le téléphone IP sans fil. Proxy ARP Version de CCX si le point d'accès est compatible CCX. Version CCX Informations pour chaque catégorie d'accès (AC, Access Category). Il y a un jeu de données pour chacune des catégories suivantes : qualité de service, arrière-plan, vidéo et audio. • Contrôle d'accès : s’il est activé, le contrôle d’accès doit être utilisé avant la transmission utilisant les paramètres d'accès spécifiques à la catégorie d’accès. • AIFSN : nombre d’intervalles après la durée SIFS qu’un STA qui n’est pas un point d'accès doit respecter avant d’invoquer une temporisation ou de commencer une transmission. • ECWMin : encode la valeur de CWmin sous forme d’exposant, pour fournir le minimum de temps lors d’une temporisation aléatoire. • ECWMax : encode la valeur de CWmax sous forme d’exposant, pour fournir le maximum de temps lors d’une temporisation aléatoire. • TXOpLimit : intervalle de temps pendant lequel une station de qualité de service (QoS) donnée a le droit d’initier Qualité de service AC, Arrière-plan AC, Vidéo AC et Voix AC • Contrôle d’accès • AIFSN • ECWMin • ECWMax • TXOpLimit Créer un rapport de problème à partir du téléphone Si vous rencontrez un problème avec votre téléphone, vous pouvez générer un rapport de problème à partir du téléphone. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 120 Dépannage Créer un rapport de problème à partir du téléphone Procédure Étape 1 Ouvrez l’application Paramètres. Étape 2 Sélectionnez Informations sur le téléphone > Signaler prob. Étape 3 Appuyez sur Soum. Étape 4 Lorsque le message de réussite s’affiche, avertissez votre administrateur qu’un rapport de problème est disponible. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 121 Dépannage Créer un rapport de problème à partir du téléphone Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 122 Dépannage Créer un rapport de problème à partir du téléphone CHAPITRE 10 Sûreté et sécurité du produit • Consignes de sécurité et renseignements relatifs aux performances, à la page 123 • Déclarations de conformité, à la page 128 • Présentation de la sécurité des produits Cisco, à la page 134 • Informations importantes en ligne, à la page 134 Consignes de sécurité et renseignements relatifs aux performances Lisez attentivement les consignes de sécurité ci-dessous avant d'installer ou d'utiliser votre téléphone IP. INSTRUCTIONS IMPORTANTES RELATIVES À LA SÉCURITÉ Un symbole d’avertissement indique un danger. Vous êtes dans une situation qui pourrait causer des blessures corporelles. Avant de travaillersur l’appareil, prenez connaissance desrisquesinhérents aux circuits électriques et lisez les pratiques de sécurité standard visant à éviter les accidents. Utilisez le numéro d’énoncé fourni à la fin de chaque avertissement afin de localiser sa traduction parmi les traductions d’avertissement de sécurité qui accompagnent ce dispositif. Énoncé 1071 CONSERVEZ CES INSTRUCTIONS Avertissement Pour consulter les traductions des avertissements de cette publication, reportez-vous au numéro correspondant du document Conformité réglementaire et renseignements sur la sécurité—Téléphone IP sans fil Cisco série 882x, disponible à l'adresse suivante : http://www.cisco.com/c/dam/en/us/td/docs/voice_ip_comm/cuipph/ 882x/english/RCSI/RCSI-0266-book.pdf Veuillez lire les instructions d’installation avant d'utiliser, d’installer ou de brancher le système dans la source d'alimentation. Énoncé 1004 Avertissement Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 123 Les services de voix sur IP (VoIP) et d'appel d'urgence ne fonctionnent pas en cas de défaillance ou d'interruption de l'alimentation. Après la coupure, vous devrez peut-être réinitialiser ou reconfigurer votre téléphone pour pouvoir accéder à nouveau aux services de VoIP et d'appel d'urgence. Aux États-Unis, le numéro d'urgence est le 911. Vous devez connaître le numéro d'urgence de votre pays. Énoncé 361 Avertissement La mise au rebut de ce produit doit être effectuée conformément à touteslesréglementations et lois nationales. Énoncé 1040 Avertissement L’ensemble de raccordement fiche-prise doit être accessible à tout moment, étant donné qu’il fait office de dispositif de déconnexion principal. Énoncé 1019 Avertissement Consignes de sécurité Les consignes de sécurité concernant l'utilisation du Téléphones IP sans fil Cisco 8821 et 8821-EX dans des environnements spécifiques sont les suivantes : • N'utilisez pas ce produit comme outil de communication principal dans un environnement médical, car il peut utiliser une plage de fréquences non réglementée susceptible d'interférer avec les autres périphériques et équipements. • L'utilisation de périphériques sans fil en milieu hospitalier est définie par les limites imposées par chaque hôpital. • L'utilisation de périphériques sans fil dans des endroits dangereux est soumise aux contraintes imposées par les directives de sécurité relatives à de tels environnements. • L'utilisation de périphériques sans fil en avion est régie par la FAA (Federal Aviation Administration, administration fédérale de l'aviation). Avis de sécurité relatifs à la batterie Ces consignes de sécurité s'appliquent aux batteries approuvées pour le Téléphones IP sans fil Cisco 8821 et 8821-EX. Il y a un risque d'explosion si vous n'utilisez pas les bonnes batteries. Utilisez uniquement le type de batterie recommandé par le fabricant, ou des batteries équivalentes. La mise au rebut des batteries usagées doit être effectuée conformément aux instructions du fabricant. Énoncé 1015 Avertissement Ne touchez pas les contacts métalliques de la batterie et ne les laissez pas toucher un autre objet métallique. Les fuites accidentelles de batterie peuvent provoquer des brûlures graves. Énoncé 341 Avertissement Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 124 Sûreté et sécurité du produit Consignes de sécurité Risque d’explosion : n'utilisez pas la batterie du téléphone dans un environnement susceptible de présenter un risque d’explosion. Énoncé 431 Avertissement Les batteries au lithium-ion ont une durée de vie limitée. Toute batterie au lithium ion qui présente des signes de détérioration, y compris un gonflement, doit être immédiatement mise au rebut de façon appropriée. Avertissement • Ne jetez pas la batterie au feu ou dans l'eau. La batterie pourrait exploser si vous la jetez au feu. • Elle ne doit pas être démontée, broyée, percée ou incinérée. • Une batterie endommagée ou qui fuit doit être manipulée avec précaution.Si vous avez touché l'électrolyte, lavez la partie du corps concernée avec de l'eau et du savon. Si vous en avez eu dans les yeux, rincez-les pendant 15 minutes et appelez un médecin. • Ne rechargez pas la batterie si la température ambiante dépasse 40 degrés Celsius. • N'exposez pas le bloc batterie à des températures de stockage élevées (supérieures à 60 degrés Celsius). • Lorsque vous souhaitez jeter le bloc batterie, mettez-vous d'abord en rapport avec le responsable d'élimination des déchets le plus proche de chez vous pour connaître les restrictions locales en matière de mise au rebut ou de recyclage des batteries. Mise en garde Adressez-vous à votre revendeur pour vous procurer une batterie. Utilisez uniquement les batteries portant un numéro de référence Cisco. Batterie CP-BATT-8821= N'utilisez qu'une batterie Cisco compatible avec votre téléphone.Pour commander une alimentation électrique, adressez-vous à votre revendeur et consultez la liste des références Cisco. Argentine CP-PWR-8821-AR= Australie CP-PWR-8821-AU= Brésil CP-PWR-8821-BZ= Europe CP-PWR-8821-CE= Corée CP-PWR-8821-KR= Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 125 Sûreté et sécurité du produit Avis de sécurité relatifs à la batterie Japon CP-PWR-8821-JP= Suisse CP-PWR-8821-SW= Amérique du Nord CP-PWR-8821-NA= Royaume Uni CP-PWR-8821-UK= Ni la batterie ni l'alimentation électrique ne sont fournies avec votre téléphone. Pour commander la batterie et le bloc d'alimentation, communiquez avec votre revendeur local. Remarque Environnements dangereux Le Téléphone IP sans fil Cisco 8821-EX est un appareil certifié ATEX catégorie I zone 2 et CSA catégorie I division 2/zone 2. Le téléphone peut donc fonctionner dans un endroit peu susceptible de présenter une atmosphère gazeuse explosive lors d'un fonctionnement normal et dans une atmosphère gazeuse explosive si elle est exceptionnelle et de courte durée. Risque d’explosion : n'utilisez pas la batterie du téléphone dans une atmosphère potentiellement explosive. Énoncé 431 Avertissement Risque d'explosion : le remplacement des composants peut affecter la conformité à la Classe 1, Division 2/Zone 2. Énoncé 1083 Avertissement Panne d’électricité L'accessibilité des services d'urgence via le téléphone dépend de l'alimentation du point d'accès sans fil. Si l'alimentation est coupée, le service d'appel d'urgence et de réparation est indisponible pendant toute la durée de la coupure. En cas de panne électrique, il est possible que vous deviez réinitialiser ou reconfigurer votre téléphone pour pouvoir utiliser le service d'appel d'urgence et de réparation. Domaines réglementaires La fréquence radio (FR) de ce téléphone est configurée pour un domaine de réglementation spécifique. Si vous sortez de ce domaine de réglementation, le téléphone ne fonctionnera pas correctement et vous risquez de violer des réglementations locales. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 126 Sûreté et sécurité du produit Environnements dangereux Environnements médicaux Ce produit, qui n'est pas un appareil médical, utilise une bande de fréquence non soumise à licence etsusceptible d'interférer avec d'autres appareils ou équipements. Utilisation de périphériques externes Les informations suivantes s'appliquent lorsque vous utilisez des périphériques externes avec le téléphone sans fil. Cisco recommande d'utiliser des périphériques externes (par exemple, des casques) de bonne qualité, blindés contre les interférences produites par les signaux de fréquences radio et audio. Selon la qualité de ces périphériques et leur proximité par rapport à d'autres appareils, tels que des téléphones portables ou des radios bidirectionnelles, des parasites sonores sont toujours susceptibles de se produire. Dans ce cas, Cisco vous recommande de prendre une ou plusieurs des mesures ci-dessous : • Éloignez l'appareil externe de la source des signaux RF ou AF. • Maintenir les câbles du périphérique externe éloignés de la source émettrice des signaux de fréquences radio ou audio. • Utiliser des câbles blindés pour le périphérique externe ou des câbles dotés d'un blindage supérieur et d'un meilleur connecteur. • Raccourcir le câble du périphérique externe. • Appliquez des ferrites ou d'autres dispositifs similaires sur les câbles de l'appareil externe. La société Cisco ne peut garantir les performances du système car elle ne dispose d'aucun moyen de contrôle sur la qualité des périphériques externes, des câbles et des connecteurs utilisés. Le système fonctionne de manière adéquate lorsque les périphériques appropriés sont connectés à l'aide de câbles et de connecteurs de bonne qualité. Dans les pays de l'Union européenne, utilisez uniquement des casques externes conformes à la Directive [89/336/CE] sur la compatibilité électromagnétique (CEM). Mise en garde Comportement du téléphone en cas d’encombrement du réseau Tout élémentsusceptible de dégrader les performances du réseau risque d’affecter la qualité audio du téléphone et, dans certains cas, d’entraîner l'interruption d’un appel.Parmi lessources de dégradation du réseau figurent, de manière non exhaustive, les activités suivantes : • Les tâches administratives telles qu’une analyse de port interne ou une analyse de sécurité • Les attaques se produisant sur le réseau, telles que les attaques de déni de service Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 127 Sûreté et sécurité du produit Environnements médicaux DAS La valeur de DAS de ce produit est conforme aux limites nationales applicables de 1,6 W/kg. Les valeurs SAR maximales spécifiques peuvent être trouvées dans Déclarations de conformité, à la page 128. Lorsque le produit est porté ou utilisé près du corps, il est recommandé d’utiliser un accessoire agréé comme un étui, ou de tenir le produit à une distance de 5 mm du corps, pour assurer la conformité aux exigences relatives à l’exposition aux rayonnements RF. Notez que le produit peut émettre des rayonnements même si aucun appel n’est en cours. Déclarations de conformité Déclarations de conformité pour l'Union européenne Marquage CE Le marquage CE suivant est apposé sur l’équipement et son emballage. Déclaration sur l’exposition aux fréquences radio de l’Union européenne Cet appareil a été évalué et déclaré conforme à la directive 2014/53/EU de l'Union Européenne relative aux champs électromagnétiques. Déclarations de conformité pour les États-Unis Déclaration relative au DAS Les combinés des téléphones IP sans fil Cisco 882x Series ont été testés pour la conformité aux limites de débit d’absorption spécifique (DAS) pour les appareils portés près du corps, lors de l’utilisation du clip de ceinture ou de l’étuispécifique livré avec le combiné. LaFCC a défini les exigences de DASpour les appareils portés près du corps, et a établi que ces exigences ont été respectées lors de leur utilisation avec le clip de ceinture ou l’étui livré avec le combiné. Les autres clips de ceinture ou étuis ou accessoires similaires n'ayant pas été testés risquent de ne pas être conformes et ne doivent pas être utilisés. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 128 Sûreté et sécurité du produit DAS Informations relatives à l'exposition aux fréquences radio Le module radio a été évalué et déclaré conforme aux exigences stipulées aux sections 2.1091, 2.1093 et 15.247 (b) (4) du document 47 CFR, relatif à l’exposition aux fréquences radio émanant de dispositifs RF. Ce modèle respecte les exigences du gouvernement concernant l’exposition à des ondes de radiofréquence. CE PÉRIPHÉRIQUERESPECTE LES LIMITES DÉCRITESPARLA NORMERSS-102R5 D’EXPOSITION À DES ONDES RADIO Votre périphérique téképhone IPsans fil Cisco série 882x inclut un émetteur et un récepteur radio. Il est conçu pour ne pas dépasser les limites applicables à la population générale (ne faisant pas l’objet de contrôles périodiques) d’exposition à des ondesradio (champs électromagnétiques de fréquencesradio) comme indiqué dans la norme RSS-102 qui sert de référence au règlement de sécurité n°6 sur l’état de santé du Canada et inclut une marge de sécurité importantes conçue pour garantir la sécurité de toutes les personnes, quels que soient leur âge et état de santé. En tant que tels, lessystèmessont conçus pour être utilisés en évitant le contact avec les antennes par l’utilisateur final. Il est recommandé de positionner le système à un endroit où les antennes peuvent demeurer à au moins une distance minimum préconisée de l’utilisateur, conformément aux instructions des réglementations qui sont conçues pour réduire l’exposition globale de l’utilisateur ou de l’opérateur. Le périphérique a été testé et déclaré conforme aux réglementations applicables dans le cadre du processus de certification radio. DAS maximal pour ce modèle et conditions dans lesquelles il a été enregistré DAS au niveau de la tête WLAN 5 GHz 0,63 W/kg DAS près du corps WLAN 5 GHz 0,67 W/kg Ce téléphone sans fil contient un émetteur-récepteur radio. L’émetteur-récepteur radio et l’antenne ont été conçus pour respecter les exigences relatives à l’exposition humaine aux émissions RF, comme stipulé par la FCC et par certaines agences d'autres pays. Ces directives ont été développées par l’industrie selon les recommandations de l’Organisation Mondiale de la Santé (OMS). Ces normes de l’industrie incluent des marges de sécurité supplémentaires, pour garantir que l’utilisateursoit exposé à un minimum de rayonnements RF. L’émetteur-récepteur utilise un type de rayonnement non ionisant, contrairement aux rayonnements ionisants des ondes de radiographie. La norme d'exposition relative à ces appareils utilise l'unité de mesure DAS (Débit d’absorption spécifique). La limite définie par la FCC est 1,6 W/kg. Les tests concernant ce niveau d’émission sont effectués par un laboratoire indépendant qui emploie des méthodes de test et des conditions de fonctionnement révisées par la FCC et par d'autres agences. Avant sa mise en marché, le téléphone a été testé et certifié conforme aux règles de la FCC permettant de vérifier qu'il ne dépasse pas les limites définies par la FCC concernant le DAS. Vous trouverez des informations supplémentaires sur le DAS et sur l’exposition aux fréquences radio sur le site Web de la FCC, à l'adresse suivante : http://www.fcc.gov/oet/rfsafety Aucune preuve concluante ne permet de démontrer que l’utilisation des téléphones mobiles présente ou non un risque pour la santé. La FDA et de nombreux chercheurs continuent leurs recherches sur les rayonnements RF et la santé. Vous trouverez des informations supplémentaires sur ce sujet sur le site Web de la FDA, à l'adresse suivante : http://www.fda.gov Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 129 Sûreté et sécurité du produit Informations relatives à l'exposition aux fréquences radio Le téléphone IP sans fil Cisco série 882x fonctionne à des niveaux de puissance 5 à 6 fois moins élevés que la plupart des téléphones cellulaires standard, PCS (Personal Communications Service), ou GSM (Global System for Mobile Communication). Cette puissance basse, associée à un faible cycle d’utilisation de l’émetteur-récepteur, réduit l’exposition de l’utilisateur aux champs RF. Plusieurs méthodes permettent de réduire l’exposition de l’utilisateur. Elles incluent les suivantes : 1. Utiliser un combiné mains libres pour augmenter la distance entre l’antenne et la tête de l’utilisateur. 2. Tenir l’antenne éloignée de l'utilisateur. Vous trouverez des informations supplémentaires dans la documentations suivante : • Livre blanc sur les radios Cisco Systems à spectre étalé et sur la sécurité de la RF, disponible sur le site suivant : http://www.cisco.com/warp/public/cc/pd/witc/ao340ap/prodlit/rfhr_wi.htm • Bulletin 56 de la FCC : Questions et réponses sur les effets biologiques et les risques potentiels des champs électromagnétiques de fréquences radio • Bulletin 65 de la FCC : Évaluation de la conformité aux directives de la FCC concernant l’exposition humaine aux champs électromagnétiques de fréquences radio Vous trouverez des informations supplémentaires auprès des organismes suivants : • Commission interne de l’OMS sur la protection contre les rayonnements non ionisants, à l’adresse http://www.who.int/emf • United Kingdom National Radiological Protection Board, à l’adresse http://www.nrpb.org.uk • Cellular Telecommunications Association, à l’adresse http://www.wow-com.com Informations générales sur la conformité des appareils RF Cet appareil a été évalué et déclaré conforme aux limites fixées par l’ICNIRP (Commission internationale de protection contre les rayonnements non ionisants) concernant l’exposition humaine aux rayonnements RF. Appareil radio conforme à l’article 15 Cet appareil radio conforme à l'article 15 des règlements de la FCC, fonctionne sans générer d’interférence avec d'autres appareils fonctionnant à cette fréquence. Toute modification du produit non expressément agréée par Cisco, notamment l'utilisation d'antennes de fabricants tiers, risque d'annuler le droit de l'utilisateur à utiliser cet appareil. Mise en garde Déclarations de conformité pour le Canada Cet appareil est conforme aux normes RSS d’exemption de licence d’Industrie Canada. Son utilisation est soumise aux deux conditions suivantes : (1) il ne doit pas produire de brouillage et (2) il doit tolérer les brouillages reçus, y compris ceux susceptibles de perturber son fonctionnement. La confidentialité des communications peut ne pas être garantie lors de l’utilisation de ce téléphone. Ce produit est conforme aux spécifications techniques applicables au Canada d’Innovation, Sciences et Développement économique. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 130 Sûreté et sécurité du produit Informations générales sur la conformité des appareils RF Déclaration de Conformité Canadienne Cet appareil est conforme aux normes RSS exemptes de licence RSS d’Industry Canada. Le fonctionnement de cet appareil est soumis à deux conditions : (1) ce périphérique ne doit pas causer d'interférence et (2) ce périphérique doit supporter les interférences, y compris celles susceptibles d'entraîner un fonctionnement non souhaitable de l'appareil. La protection des communications ne peut pas être assurée lors de l'utilisation de ce téléphone. Le présent produit est conforme aux spécifications techniques applicables d'Innovation, Sciences et Développement économique Canada. Déclaration de conformité pour le Canada CE PÉRIPHÉRIQUERESPECTE LES LIMITES DÉCRITESPARLA NORMERSS-102R5 D’EXPOSITION À DES ONDES RADIO Votre périphérique inclut un émetteur et un récepteur radio. Il est conçu pour ne pas dépasser les limites applicables à la population générale (ne faisant pas l’objet de contrôles périodiques) d’exposition à des ondes radio (champs électromagnétiques de fréquences radio) comme indiqué dans la norme RSS-102 qui sert de référence au règlement de sécurité n°6 sur l’état de santé du Canada et inclut une marge de sécurité importantes conçue pour garantir la sécurité de toutes les personnes, quels que soient leur âge et état de santé. En tant que tels, lessystèmessont conçus pour être utilisés en évitant le contact avec les antennes par l’utilisateur final. Il est recommandé de positionner le système à un endroit où les antennes peuvent demeurer à au moins une distance minimum préconisée de l’utilisateur, conformément aux instructions des réglementations qui sont conçues pour réduire l’exposition globale de l’utilisateur ou de l’opérateur. Le périphérique a été testé et déclaré conforme aux réglementations applicables dans le cadre du processus de certification radio. DAS maximal pour ce modèle et conditions dans lesquelles il a été enregistré DAS au niveau de la tête WLAN 5 GHz 0,63 W/kg DAS près du corps WLAN 5 GHz 0,67 W/kg Déclaration d’exposition aux RF pour le Canada CE PÉRIPHÉRIQUERESPECTE LES LIMITES DÉCRITESPARLA NORMERSS-102R5 D’EXPOSITION À DES ONDES RADIO Votre appareil comprend un émetteur et un récepteur radio. Il est conçu pour ne pas dépasser les limites applicables à la population générale (ne faisant pas l’objet de contrôles périodiques) d’exposition à des ondes radio (champs électromagnétiques de fréquences radio) comme indiqué dans la norme RSS-102 qui sert de référence au règlement de sécurité n°6 sur l’état de santé du Canada et inclut une marge de sécurité importantes conçue pour garantir la sécurité de toutes les personnes, quels que soient leur âge et état de santé. En tant que tels, lessystèmessont conçus pour être utilisés en évitant le contact avec les antennes par l’utilisateur final. Il est recommandé de positionner le système à un endroit où les antennes peuvent demeurer à au moins une distance minimum préconisée de l’utilisateur, conformément aux instructions des réglementations qui sont conçues pour réduire l’exposition globale de l’utilisateur ou de l’opérateur. Le périphérique a été testé et déclaré conforme aux réglementations applicables dans le cadre du processus de certification radio. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 131 Sûreté et sécurité du produit Déclaration de conformité pour le Canada DAS maximal pour ce modèle et conditions dans lesquelles il a été enregistré DAS au niveau de la tête WLAN 5 GHz 0,63 W/kg DAS près du corps WLAN 5 GHz 0,67 W/kg Déclarations de conformité pour la Nouvelle-Zélande Avertissement général relatif à Permit to Connect (PTC) L’octroi d’une licence Telepermit pour tout élément du matériel terminal indique uniquement que le fournisseur de télécommunications a accepté que l’élément soit conforme aux conditions minimales pour une connexion à son réseau. Cela ne signifie en aucun cas que le fournisseur de télécommunications cautionne le produit, ou qu’il fournit une quelconque garantie. Avant tout, cela ne garantit pas qu’un élément fonctionnera correctement, à tous égards, avec un autre élément de matériel doté d’une licence Telepermit d’une autre marque ou d’un autre modèle, ou qu’un quelconque produit est compatible avec l’ensemble des services réseau du fournisseur de télécommunications. Utilisation de réseaux IP avec PSTN Le protocole Internet (IP) introduit un retard des signaux de voix à mesure que chaque paquet de données est formulé et adressé. L’organisme Telecom Access Standards recommande aux fournisseurs, concepteurs et installateurs qui utilisent cette technologie pour les appels à destination ou en provenance du PSTN, de se référer aux exigences du Modèle E de l’UIT lors de la conception de leurs réseaux. Le but ultime est de minimiser le retard, la distorsion et les autres problèmes de transmission, en particulier pour les appels sur des réseaux cellulaires et internationaux, qui subissent déjà un retard considérable. Utilisation de la compression vocale par le biais de PSTN Les appels de réseaux cellulaires et internationaux subissent un retard considérable, partiellement dû au fait qu’ils utilisent des technologies de compression vocale. L’organisme Telecom Access Standards n’approuve que la technologie vocale G711 pour l’utilisation sur le réseau PSTN. G711 est une « technique instantanée de codage de la parole », alors que G729 et toutes ses variantes sont considérés comme étant « quasi-instantanés » et introduisent un retard supplémentaire dans le signal vocal. Annulation d'écho Normalement, l’utilisation d’annulateurs d’écho n’est pas requise dans le réseau PSTN du fournisseur de télécommunications, car les retards géographiques sont acceptables lorsque la perte en retour de l’appareil CPE est maintenue dans les limites définies par la licence Telepermit.. Cependant, les réseaux privés qui utilisent la technologie Voix sur IP (VoIP) doivent fournir l’annulation d’écho pour tous les appels vocaux. L’effet combiné du délai de conversion audio/VoIP et du délai de routage IP risque d’entraîner une durée d’annulation d’écho de 64 ms. Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 132 Sûreté et sécurité du produit Déclarations de conformité pour la Nouvelle-Zélande Déclarations de conformité pour Taïwan Déclaration d’avertissement DGT Déclarations de conformité pour l'Argentine Advertencia No utilizar una fuente de alimentación con caracteristícas distintas a las expresadas ya que podría ser peligroso. Déclaration de conformité pour le Brésil Art. 6º - 506 Cet appareil est un appareil de type secondaire et n’est pas protégé contre les interférences nuisibles, même celles émanant d’appareils du même type, et il ne peut pas générer d’interférences avec les appareils principaux. Pour plus d’informations, visitez le site suivant : http://www.anatel.gov.br Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 133 Sûreté et sécurité du produit Déclarations de conformité pour Taïwan Este equipamento opera em carátersecundário, isto é, não tem direito a proteção contra interferência prejudicial, mesmo de estações do mesmo tipo, e não pode causar interferência a sistemas operando em caráter primário. Site Anatel : http://www.anatel.gov.br Résolution n º 303/2002 e n º 533/2009 Ce produit est approuvé par ANATEL, conformément aux procédures réglementées par la résolution n° 242/2000 et répond aux exigencestechniques appliquées, y comprisleslimites d’exposition du taux d’absorption spécifique pour les produits électriques, magnétiques et électromagnétiques domaines de radiofréquence, conformément aux résolutions nº 303/2002 et nº 533/2009. Resoluções no. 303/2002 e no. 533/2009 Este produto está homologado pela Anatel, de acordo com os procedimentos regulamentados pela Resolução no. 242/2000 e atende aosrequisitostécnicos aplicados, incluindo oslimites de exposição da Taxa de Absorção Específica referente a campos elétricos, magnéticos e eletromagnéticos de radiofrequência, de acordo com as Resoluções no. 303/2002 e no. 533/2009. Déclaration de conformité pour Singapour Présentation de la sécurité des produits Cisco Ce produit, qui contient des fonctions cryptographiques, est soumis aux lois des États-Unis et d'autres pays, qui en régissent l'importation, l'exportation, le transfert et l'utilisation. La fourniture de produits cryptographiques Cisco n’implique pasle droit d’un tiers à importer, exporter, distribuer ou utiliser le cryptage. Lesimportateurs, exportateurs, distributeurs et utilisateurs sont responsables du respect des lois des États-Unis et des autres pays. En utilisant ce produit, vous acceptez de vous conformer aux lois et aux réglementations en vigueur. Si vous n’êtes pas en mesure de vous conformer aux lois locales et à celles des États-Unis, retournez immédiatement ce produit. Pour en savoir plus sur les réglementations américaines sur les exportations, reportez-vous à l'adresse https://www.bis.doc.gov/policiesandregulations/ear/index.htm. Informations importantes en ligne Contrat de licence de l’utilisateur final Le contrat de licence utilisateur final (CLUF) est disponible à l'adresse suivante : https://www.cisco.com/go/ eula Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 134 Sûreté et sécurité du produit Déclaration de conformité pour Singapour Information sur la conformité réglementaire et la sécurité Les informations sur la sécurité et la conformité à la réglementation sont disponibles à l'adresse suivante : Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 135 Sûreté et sécurité du produit Informations importantes en ligne Guide de l’utilisateur des téléphones IP sans fil Cisco 8821 et 8821-EX 136 Sûreté et sécurité du produit Informations importantes en ligne 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 Cisco IOS Configuration Fundamentals Command Reference April 2010 Text Part Number: 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 Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, 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 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. (1002R) 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. Cisco IOS Configuration Fundamentals Command Reference © 2010 Cisco Systems, Inc. All rights reserved. iii Cisco IOS Configuration Fundamentals Command Reference April 2010 CONTENTS About Cisco IOS Software Documentation xxi Documentation Objectives xxi Audience xxi Documentation Conventions xxi Typographic Conventions xxii Command Syntax Conventions xxii Software Conventions xxiii Reader Alert Conventions xxiii Documentation Organization xxiii Cisco IOS Documentation Set xxiv Cisco IOS Documentation on Cisco.com xxiv Configuration Guides, Command References, and Supplementary Resources xxv Additional Resources and Documentation Feedback xxxi Using the Command-Line Interface in Cisco IOS Software xxxiii Initially Configuring a Device xxxiii Using the CLI xxxiv Understanding Command Modes xxxiv Using the Interactive Help Feature xxxvii Understanding Command Syntax xxxviii Understanding Enable and Enable Secret Passwords xxxix Using the Command History Feature xl Abbreviating Commands xli Using Aliases for CLI Commands xli Using the no and default Forms of Commands xlii Using the debug Command xlii Filtering Output Using Output Modifiers xlii Understanding CLI Error Messages xliii Saving Changes to a Configuration xliv Additional Information xliv Introduction CF-1 Cisco IOS IFS Command Syntax CF-2 Obtaining Documentation, Obtaining Support, and Security Guidelines CF-3 Contents iv Cisco IOS Configuration Fundamentals Command Reference April 2010 Configuration Fundamentals Commands CF-5 activation-character CF-6 alias CF-7 archive CF-11 archive config CF-12 archive log config persistent save CF-14 archive tar CF-15 async-bootp CF-18 attach CF-20 autobaud CF-23 auto-sync CF-24 autoupgrade disk-cleanup CF-26 autoupgrade ida url CF-27 autoupgrade status email CF-28 banner exec CF-29 banner incoming CF-31 banner login CF-33 banner motd CF-35 banner slip-ppp CF-37 boot CF-39 boot bootldr CF-43 boot bootstrap CF-45 boot config CF-47 boot host CF-50 boot network CF-53 boot system CF-56 boot-end-marker CF-62 boot-start-marker CF-64 cd CF-66 clear archive log config CF-68 clear catalyst6000 traffic-meter CF-69 clear configuration lock CF-70 clear ip http client cache CF-72 clear logging CF-73 clear logging system CF-74 Contents v Cisco IOS Configuration Fundamentals Command Reference April 2010 clear logging xml CF-76 clear mls statistics CF-77 clear parser cache CF-78 clear platform netint CF-79 clear processes interrupt mask CF-80 clear tcp CF-81 clear vlan counters CF-83 clock CF-84 clock initialize nvram CF-86 config-register CF-87 configuration mode exclusive CF-89 configure confirm CF-95 configure memory CF-97 configure network CF-99 configure overwrite-network CF-100 configure replace CF-101 configure revert CF-105 configure terminal CF-107 confreg CF-109 continue (ROM monitor) CF-111 copy CF-112 copy erase flash CF-130 copy http:// CF-131 copy https:// CF-132 copy logging system CF-133 copy xmodem: CF-135 copy ymodem: CF-136 copy /noverify CF-137 databits CF-141 data-character-bits CF-143 default-value exec-character-bits CF-144 default-value special-character-bits CF-145 define interface-range CF-146 delete CF-148 diag CF-150 Contents vi Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic bootup level CF-153 diagnostic cns CF-155 diagnostic event-log size CF-157 diagnostic level CF-158 diagnostic monitor CF-160 diagnostic ondemand CF-164 diagnostic schedule test CF-166 diagnostic start CF-169 diagnostic stop CF-173 dir CF-175 disable CF-177 disconnect-character CF-178 dispatch-character CF-179 dispatch-machine CF-181 dispatch-timeout CF-183 do CF-185 downward-compatible-config CF-187 editing CF-188 enable CF-191 end CF-194 environment-monitor shutdown temperature CF-195 environment temperature-controlled CF-196 erase CF-197 erase bootflash CF-200 errdisable detect cause CF-201 errdisable recovery CF-203 escape-character CF-205 exec CF-207 exec-banner CF-208 exec-character-bits CF-210 exec-timeout CF-212 execute-on CF-213 exit (EXEC) CF-216 exit (global) CF-217 file prompt CF-218 Contents vii Cisco IOS Configuration Fundamentals Command Reference April 2010 file verify auto CF-219 format CF-221 fsck CF-225 full-help CF-231 help CF-233 hidekeys CF-235 history CF-237 history size CF-239 hold-character CF-240 hostname CF-241 hw-module reset CF-243 hw-module shutdown CF-244 insecure CF-245 international CF-246 ip bootp server CF-247 ip finger CF-249 ip ftp passive CF-251 ip ftp password CF-252 ip ftp source-interface CF-253 ip ftp username CF-255 ip rarp-server CF-256 ip rcmd domain-lookup CF-258 ip rcmd rcp-enable CF-260 ip rcmd remote-host CF-261 ip rcmd remote-username CF-264 ip rcmd rsh-enable CF-266 ip rcmd source-interface CF-267 ip telnet source-interface CF-269 ip tftp source-interface CF-270 ip wccp web-cache accelerated CF-272 length CF-274 load-interval CF-275 location CF-277 lock CF-278 lockable CF-280 Contents viii Cisco IOS Configuration Fundamentals Command Reference April 2010 log config CF-281 logging enable CF-282 logging event bundle-status CF-283 logging event link-status (global configuration) CF-285 logging event link-status (interface configuration) CF-287 logging event subif-link-status CF-289 logging event trunk-status CF-291 logging ip access-list cache (global configuration) CF-292 logging ip access-list cache (interface configuration) CF-294 logging persistent (config-archive-log-cfg) CF-296 logging persistent reload (config-archive-log-cfg) CF-298 logging size CF-299 logging synchronous CF-301 logging system CF-304 logout CF-305 logout-warning CF-306 macro (global configuration) CF-307 macro (interface configuration) CF-309 maximum CF-311 memory free low-watermark CF-313 memory lite CF-315 memory reserve critical CF-316 memory sanity CF-318 memory scan CF-319 memory-size iomem CF-320 menu (EXEC) CF-322 menu single-space CF-324 menu clear-screen CF-325 menu command CF-327 menu default CF-329 menu line-mode CF-330 menu options CF-332 menu prompt CF-333 menu status-line CF-334 menu text CF-335 Contents ix Cisco IOS Configuration Fundamentals Command Reference April 2010 menu title CF-337 microcode (12000) CF-339 microcode (7000/7500) CF-341 microcode (7200) CF-343 microcode reload (12000) CF-345 microcode reload (7000/7500) CF-347 microcode reload (7200) CF-348 mkdir CF-349 mkdir disk0: CF-351 mode CF-352 CF-355 monitor event-trace (EXEC) CF-356 monitor event-trace (global) CF-359 monitor event-trace dump-traces CF-362 monitor permit-list CF-363 monitor session egress replication-mode CF-365 monitor session type CF-367 mop device-code CF-375 mop retransmit-timer CF-376 mop retries CF-377 more CF-378 more begin CF-381 more exclude CF-383 more include CF-385 more flh:logfile CF-387 motd-banner CF-389 name-connection CF-391 no menu CF-392 notify CF-393 notify syslog CF-394 padding CF-396 parity CF-397 parser cache CF-399 parser command serializer CF-400 parser config cache interface CF-401 Contents x Cisco IOS Configuration Fundamentals Command Reference April 2010 parser config partition CF-403 partition CF-405 path (archive configuration) CF-407 periodic CF-411 ping CF-414 ping (privileged) CF-418 ping ip CF-421 ping vrf CF-425 platform shell CF-428 power enable CF-429 power redundancy-mode CF-430 printer CF-431 private CF-433 privilege CF-434 process cpu statistics limit entry-percentage CF-439 process cpu threshold type CF-440 process-max-time CF-442 prompt CF-443 pwd CF-445 refuse-message CF-446 reload CF-447 remote command CF-451 remote login CF-453 remote-span CF-455 rename CF-456 request platform software package describe file CF-457 request platform software package expand file CF-463 request platform software package install commit CF-466 request platform software package install file CF-468 request platform software package install rollback CF-477 request platform software package install snapshot CF-479 request platform software process release CF-481 request platform software system shell CF-483 request platform software shell session output format CF-484 request platform software vty attach CF-487 Contents xi Cisco IOS Configuration Fundamentals Command Reference April 2010 revision CF-488 rmdir CF-490 rommon-pref CF-492 route-converge-interval CF-494 rsh CF-496 scheduler allocate CF-498 scheduler heapcheck process CF-500 scheduler interrupt mask profile CF-502 scheduler interrupt mask size CF-503 scheduler interrupt mask time CF-504 scheduler interval CF-505 send CF-506 service compress-config CF-508 service config CF-510 service counters max age CF-512 service decimal-tty CF-514 service exec-wait CF-515 service finger CF-516 service hide-telnet-address CF-517 service linenumber CF-518 service nagle CF-520 service prompt config CF-521 service sequence-numbers CF-522 service slave-log CF-523 service tcp-keepalives-in CF-524 service tcp-keepalives-out CF-525 service tcp-small-servers CF-526 service telnet-zero-idle CF-527 service timestamps CF-528 service udp-small-servers CF-533 service-module apa traffic-management CF-534 service-module wlan-ap bootimage CF-536 service-module wlan-ap reload CF-538 service-module wlan-ap reset CF-540 service-module wlan-ap session CF-542 Contents xii Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap statistics CF-544 service-module wlan-ap status CF-545 session slot CF-546 set memory debug incremental starting-time CF-547 setup CF-548 show CF-555 show append CF-557 show begin CF-558 show exclude CF-560 show include CF-562 show redirect CF-564 show section CF-565 show tee CF-567 show (Flash file system) CF-569 show aliases CF-578 show alignment CF-579 show archive CF-582 show archive config differences CF-584 show archive config incremental-diffs CF-587 show archive config rollback timer CF-589 show archive log config CF-591 show async bootp CF-595 show autoupgrade configuration unknown CF-596 show bootflash: CF-598 show bootvar CF-600 show buffers CF-603 show buffers summary CF-609 show c2600 CF-611 show c7200 CF-614 show catalyst6000 CF-615 show cls CF-617 show config id CF-619 show configuration lock CF-621 show context CF-625 show controllers (GRP image) CF-628 Contents xiii Cisco IOS Configuration Fundamentals Command Reference April 2010 show controllers (line card image) CF-630 show controllers logging CF-638 show controllers tech-support CF-640 show coverage history CF-642 show data-corruption CF-643 show debugging CF-644 show declassify CF-646 show derived-config CF-648 show diagnostic cns CF-651 show diagnostic sanity CF-652 show disk CF-657 show disk0: CF-659 show disk1: CF-662 show environment CF-665 show environment alarm CF-691 show environment cooling CF-694 show environment status CF-695 show environment temperature CF-698 show errdisable detect CF-701 show errdisable recovery CF-702 show fastblk CF-703 show file descriptors CF-705 show file information CF-706 show file systems CF-708 show flh-log CF-710 show fm inspect CF-711 show fm interface CF-713 show fm reflexive CF-716 show fm summary CF-717 show funi CF-718 show identity policy CF-722 show identity profile CF-723 show gsr CF-724 show gt64010 (7200) CF-725 show hardware CF-727 Contents xiv Cisco IOS Configuration Fundamentals Command Reference April 2010 show health-monitor CF-729 show history CF-730 show history all CF-732 show hosts CF-735 show html CF-738 show idb CF-740 show idprom CF-741 show inventory CF-747 show logging CF-750 show logging count CF-756 show logging history CF-758 show logging system CF-760 show logging xml CF-763 show memory CF-765 show memory allocating-process CF-770 show memory dead CF-773 show memory debug incremental CF-775 show memory debug leaks CF-778 show memory debug references CF-783 show memory debug unused CF-785 show memory ecc CF-787 show memory events CF-789 show memory failures alloc CF-791 show memory fast CF-792 show memory fragment CF-795 show memory multibus CF-798 show memory pci CF-800 show memory processor CF-802 show memory scan CF-806 show memory statistics history table CF-808 show memory traceback CF-811 show memory transient CF-813 show microcode CF-815 show mls statistics CF-817 show module CF-820 Contents xv Cisco IOS Configuration Fundamentals Command Reference April 2010 show monitor event-trace CF-823 CF-829 show monitor permit-list CF-830 show monitor session CF-831 show msfc CF-836 show pagp CF-840 show parser dump CF-842 show parser macro CF-854 show parser statistics CF-856 show pci CF-859 show pci hardware CF-861 show perf-meas CF-863 show platform CF-865 show platform bridge CF-876 show platform cfm CF-878 show platform diag CF-880 show platform hardware capacity CF-883 show platform isg CF-890 show platform oam CF-891 show platform redundancy CF-892 show platform software filesystem CF-894 show platform software memory CF-897 show platform software mount CF-903 show platform software process list CF-907 show platform software tech-support CF-914 show platform supervisor CF-916 show power CF-917 show processes CF-921 show processes cpu CF-928 show processes interrupt mask buffer CF-936 show processes interrupt mask detail CF-938 show processes memory CF-940 CF-950 show protocols CF-951 show region CF-954 Contents xvi Cisco IOS Configuration Fundamentals Command Reference April 2010 show registry CF-957 show reload CF-960 show resource-pool queue CF-961 show rom-monitor CF-963 show rom-monitor slot CF-966 show running identity policy CF-968 show running identity profile CF-969 show running-config CF-970 show running-config control-plane CF-976 show running-config map-class CF-977 show running-config partition CF-980 show scp CF-983 show slot CF-985 show slot0: CF-988 show slot1: CF-991 show software authenticity file CF-994 show software authenticity keys CF-996 show software authenticity running CF-998 show software authenticity upgrade-status CF-1000 show stacks CF-1002 show startup-config CF-1004 show subsys CF-1005 show sup-bootflash CF-1007 show sysctrl CF-1010 show system jumbomtu CF-1013 show tech-support CF-1014 show template CF-1021 show usb controllers CF-1022 show usb device CF-1024 show usb driver CF-1027 show usb port CF-1029 show usb tree CF-1030 show usbtoken CF-1031 show version CF-1033 show warm-reboot CF-1052 Contents xvii Cisco IOS Configuration Fundamentals Command Reference April 2010 show whoami CF-1053 showmon CF-1054 slave auto-sync config CF-1056 slave default-slot CF-1058 slave image CF-1060 slave reload CF-1062 slave sync config CF-1063 slave terminal CF-1065 special-character-bits CF-1066 squeeze CF-1067 stack-mib portname CF-1070 state-machine CF-1071 stopbits CF-1073 storm-control level CF-1074 sync-restart-delay CF-1076 system flowcontrol bus CF-1077 system jumbomtu CF-1078 tdm clock priority CF-1080 terminal databits CF-1082 terminal data-character-bits CF-1083 terminal dispatch-character CF-1084 terminal dispatch-timeout CF-1085 terminal download CF-1086 terminal editing CF-1087 terminal escape-character CF-1088 terminal exec-character-bits CF-1089 terminal flowcontrol CF-1090 terminal full-help CF-1091 terminal history CF-1093 terminal history size CF-1095 terminal hold-character CF-1097 terminal international CF-1099 terminal keymap-type CF-1100 terminal length CF-1101 terminal monitor CF-1102 Contents xviii Cisco IOS Configuration Fundamentals Command Reference April 2010 terminal notify CF-1103 terminal padding CF-1104 terminal parity CF-1105 terminal rxspeed CF-1106 terminal special-character-bits CF-1107 terminal speed CF-1109 terminal start-character CF-1110 terminal stopbits CF-1111 terminal stop-character CF-1112 terminal telnet break-on-ip CF-1113 terminal telnet refuse-negotiations CF-1114 terminal telnet speed CF-1115 terminal telnet sync-on-break CF-1116 terminal telnet transparent CF-1117 terminal terminal-type CF-1118 terminal txspeed CF-1119 terminal width CF-1120 terminal-queue entry-retry-interval CF-1121 terminal-type CF-1122 test cable-diagnostics CF-1123 test flash CF-1125 test interfaces CF-1126 test memory CF-1127 test memory destroy CF-1128 test platform police get CF-1129 test platform police set CF-1130 tftp-server CF-1132 tftp-server system CF-1135 time-period CF-1136 trace (privileged) CF-1138 trace (user) CF-1142 traceroute CF-1145 traceroute mac CF-1148 undelete CF-1152 upgrade automatic abortversion CF-1154 Contents xix Cisco IOS Configuration Fundamentals Command Reference April 2010 upgrade automatic getversion CF-1156 upgrade automatic runversion CF-1159 upgrade filesystem monlib CF-1161 upgrade rom-monitor CF-1162 upgrade rom-monitor file CF-1167 upgrade rom-monitor preference CF-1171 vacant-message CF-1172 verify CF-1174 vtp CF-1179 warm-reboot CF-1182 where CF-1184 width CF-1185 write core CF-1186 write erase CF-1188 write memory CF-1189 write terminal CF-1190 xmodem CF-1191 ASCII Character Set and Hexadecimal Values CF-1193 Contents xx Cisco IOS Configuration Fundamentals Command Reference April 2010 xxi Cisco IOS Configuration Fundamentals Command Reference April 2010 About Cisco IOS Software Documentation Last Updated: March 26, 2010 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 xxi • Audience, page xxi • Documentation Conventions, page xxi • Documentation Organization, page xxiii • Additional Resources and Documentation Feedback, page xxxi 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. About Cisco IOS Software Documentation Documentation Conventions xxii Cisco IOS Configuration Fundamentals Command Reference April 2010 This section contains the following topics: • Typographic Conventions, page xxii • Command Syntax Conventions, page xxii • Software Conventions, page xxiii • Reader Alert Conventions, page xxiii Typographic Conventions Cisco IOS documentation uses the following typographic conventions: Command Syntax Conventions Cisco IOS documentation uses the following command syntax 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, do not use quotation marks around the string; otherwise, the string will include the quotation marks. 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 xxiii Cisco IOS Configuration Fundamentals Command Reference April 2010 Software Conventions Cisco IOS software uses the following program code conventions: Reader Alert Conventions Cisco IOS documentation uses the following conventions for reader alerts: Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual. Timesaver 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 xxiv • Cisco IOS Documentation on Cisco.com, page xxiv • Configuration Guides, Command References, and Supplementary Resources, page xxv 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. About Cisco IOS Software Documentation Documentation Organization xxiv Cisco IOS Configuration Fundamentals Command Reference April 2010 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 1 (catastrophic), severity 2 (severe), and select severity 3 (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. 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. 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. About Cisco IOS Software Documentation Documentation Organization xxv Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco IOS Supplementary Documents and Resources Supplementary documents and resources are listed in Table 2 on page xxxi. Configuration Guides, Command References, and Supplementary Resources Table 1 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 2 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 1 Cisco IOS Configuration Guides and Command References Configuration Guide and Command Reference Titles Features/Protocols/Technologies • Cisco IOS AppleTalk Configuration Guide • Cisco IOS AppleTalk Command Reference AppleTalk protocol. • Cisco IOS Asynchronous Transfer Mode Configuration Guide • Cisco IOS Asynchronous Transfer Mode Command Reference LAN ATM, multiprotocol over ATM (MPoA), and WAN ATM. • Cisco IOS Bridging and IBM Networking Configuration Guide • Cisco IOS Bridging Command Reference • Cisco IOS IBM Networking Command Reference 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 2 (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. • Cisco IOS Broadband Access Aggregation and DSL Configuration Guide • Cisco IOS Broadband Access Aggregation and DSL Command Reference PPP over ATM (PPPoA) and PPP over Ethernet (PPPoE). About Cisco IOS Software Documentation Documentation Organization xxvi Cisco IOS Configuration Fundamentals Command Reference April 2010 • Cisco IOS Carrier Ethernet Configuration Guide • Cisco IOS Carrier Ethernet Command Reference 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). • Cisco IOS Configuration Fundamentals Configuration Guide • Cisco IOS Configuration Fundamentals Command Reference 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. • Cisco IOS DECnet Configuration Guide • Cisco IOS DECnet Command Reference DECnet protocol. • Cisco IOS Dial Technologies Configuration Guide • Cisco IOS Dial Technologies Command Reference 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). • Cisco IOS Flexible NetFlow Configuration Guide • Cisco IOS Flexible NetFlow Command Reference Flexible NetFlow. • Cisco IOS High Availability Configuration Guide • Cisco IOS High Availability 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. • 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 • Cisco IOS Interface and Hardware Component Command Reference LAN interfaces, logical interfaces, serial interfaces, virtual interfaces, and interface configuration. • Cisco IOS IP Addressing Services Configuration Guide • Cisco IOS IP Addressing Services Command Reference Address Resolution Protocol (ARP), Network Address Translation (NAT), Domain Name System (DNS), Dynamic Host Configuration Protocol (DHCP), and Next Hop Address Resolution Protocol (NHRP). Table 1 Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies About Cisco IOS Software Documentation Documentation Organization xxvii Cisco IOS Configuration Fundamentals Command Reference April 2010 • Cisco IOS IP Application Services Configuration Guide • Cisco IOS IP Application Services Command Reference 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). • Cisco IOS IP Mobility Configuration Guide • Cisco IOS IP Mobility Command Reference Mobile ad hoc networks (MANet) and Cisco mobile networks. • Cisco IOS IP Multicast Configuration Guide • Cisco IOS IP Multicast Command Reference 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). • 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 • Cisco IOS IP Routing: EIGRP Command Reference Enhanced Interior Gateway Routing Protocol (EIGRP). • Cisco IOS IP Routing: ISIS Configuration Guide • Cisco IOS IP Routing: ISIS Command Reference Intermediate System-to-Intermediate System (IS-IS). • Cisco IOS IP Routing: ODR Configuration Guide • Cisco IOS IP Routing: ODR Command Reference On-Demand Routing (ODR). • Cisco IOS IP Routing: OSPF Configuration Guide • Cisco IOS IP Routing: OSPF Command Reference Open Shortest Path First (OSPF). • Cisco IOS IP Routing: Protocol-Independent Configuration Guide • Cisco IOS IP Routing: Protocol-Independent Command Reference IP routing protocol-independent features and commands. Generic policy-based routing (PBR) features and commands are included. • Cisco IOS IP Routing: RIP Configuration Guide • Cisco IOS IP Routing: RIP Command Reference Routing Information Protocol (RIP). • Cisco IOS IP SLAs Configuration Guide • Cisco IOS IP SLAs Command Reference Cisco IOS IP Service Level Agreements (IP SLAs). • Cisco IOS IP Switching Configuration Guide • Cisco IOS IP Switching Command Reference Cisco Express Forwarding, fast switching, and Multicast Distributed Switching (MDS). • 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 • Cisco IOS ISO CLNS Command Reference ISO Connectionless Network Service (CLNS). Table 1 Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies About Cisco IOS Software Documentation Documentation Organization xxviii Cisco IOS Configuration Fundamentals Command Reference April 2010 • Cisco IOS LAN Switching Configuration Guide • Cisco IOS LAN Switching Command Reference VLANs, Inter-Switch Link (ISL) encapsulation, IEEE 802.10 encapsulation, IEEE 802.1Q encapsulation, and multilayer switching (MLS). • Cisco IOS Mobile Wireless Gateway GPRS Support Node Configuration Guide • Cisco IOS Mobile Wireless Gateway GPRS Support Node Command Reference 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 IOS Mobile Wireless Home Agent Configuration Guide • Cisco IOS Mobile Wireless Home Agent Command Reference 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 Configuration Guide • Cisco IOS Mobile Wireless Packet Data Serving Node Command Reference Cisco Packet Data Serving Node (PDSN), a wireless gateway that is between the mobile infrastructure and standard IP networks and that enables packet data services in a code division multiple access (CDMA) environment. • Cisco IOS Mobile Wireless Radio Access Networking Configuration Guide • Cisco IOS Mobile Wireless Radio Access Networking Command Reference Cisco IOS radio access network products. • Cisco IOS Multiprotocol Label Switching Configuration Guide • Cisco IOS Multiprotocol Label Switching Command Reference MPLS Label Distribution Protocol (LDP), MPLS Layer 2 VPNs, MPLS Layer 3 VPNs, MPLS traffic engineering (TE), and MPLS Embedded Management (EM) and MIBs. • Cisco IOS Multi-Topology Routing Configuration Guide • Cisco IOS Multi-Topology Routing Command Reference Unicast and multicast topology configurations, traffic classification, routing protocol support, and network management support. • Cisco IOS NetFlow Configuration Guide • Cisco IOS NetFlow Command Reference Network traffic data analysis, aggregation caches, and export features. • Cisco IOS Network Management Configuration Guide • Cisco IOS Network Management Command Reference Basic system management; system monitoring and logging; troubleshooting, logging, and fault management; Cisco Discovery Protocol; Cisco IOS Scripting with Tool Control Language (Tcl); Cisco networking services (CNS); DistributedDirector; Embedded Event Manager (EEM); Embedded Resource Manager (ERM); Embedded Syslog Manager (ESM); HTTP; Remote Monitoring (RMON); SNMP; and VPN Device Manager Client for Cisco IOS software (XSM Configuration). • Cisco IOS Novell IPX Configuration Guide • Cisco IOS Novell IPX Command Reference Novell Internetwork Packet Exchange (IPX) protocol. Table 1 Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies About Cisco IOS Software Documentation Documentation Organization xxix Cisco IOS Configuration Fundamentals Command Reference April 2010 • Cisco IOS Optimized Edge Routing Command Reference Optimized edge routing (OER) monitoring and automatic route optimization and load distribution for multiple connections between networks. • Cisco IOS Performance Routing Configuration Guide Performance Routing (PfR) provides additional intelligence to classic routing technologies to track the performance of, or verify the quality of, a path between two devices over a WAN infrastructure in order to determine the best egress or ingress path for application traffic. • Cisco IOS Quality of Service Solutions Configuration Guide • Cisco IOS Quality of Service Solutions Command Reference Traffic queueing, traffic policing, traffic shaping, Modular QoS CLI (MQC), Network-Based Application Recognition (NBAR), Multilink PPP (MLP) for QoS, header compression, AutoQoS, Resource Reservation Protocol (RSVP), and weighted random early detection (WRED). • Cisco IOS Security Command Reference Access control lists (ACLs); authentication, authorization, and accounting (AAA); firewalls; IP security and encryption; neighbor router authentication; network access security; network data encryption with router authentication; public key infrastructure (PKI); RADIUS; TACACS+; terminal access security; and traffic filters. • Cisco IOS Security Configuration Guide: Securing the Data Plane Access Control Lists (ACLs); Firewalls: Context-Based Access Control (CBAC) and Zone-Based Firewall; Cisco IOS Intrusion Prevention System (IPS); Flexible Packet Matching; Unicast Reverse Path Forwarding (uRPF); Threat Information Distribution Protocol (TIDP) and TMS. • Cisco IOS Security Configuration Guide: Securing the Control Plane Control Plane Policing, Neighborhood Router Authentication. • Cisco IOS Security Configuration Guide: Securing User Services AAA (includes 802.1x authentication and Network Admission Control [NAC]); Security Server Protocols (RADIUS and TACACS+); Secure Shell (SSH); Secure Access for Networking Devices (includes Autosecure and Role-Based CLI access); Lawful Intercept. • Cisco IOS Security Configuration Guide: Secure Connectivity Internet Key Exchange (IKE) for IPsec VPNs; IPsec Data Plane features; IPsec Management features; Public Key Infrastructure (PKI); Dynamic Multipoint VPN (DMVPN); Easy VPN; Cisco Group Encrypted Transport VPN (GETVPN); SSL VPN. • Cisco IOS Service Advertisement Framework Configuration Guide • Cisco IOS Service Advertisement Framework Command Reference Cisco Service Advertisement Framework. • Cisco IOS Service Selection Gateway Configuration Guide • Cisco IOS Service Selection Gateway Command Reference Subscriber authentication, service access, and accounting. Table 1 Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies About Cisco IOS Software Documentation Documentation Organization xxx Cisco IOS Configuration Fundamentals Command Reference April 2010 • Cisco IOS Software Activation Configuration Guide • Cisco IOS Software Activation Command Reference An orchestrated collection of processes and components to activate Cisco IOS software feature sets by obtaining and validating Cisco software licenses. • Cisco IOS Software Modularity Installation and Configuration Guide • Cisco IOS Software Modularity Command Reference Installation and basic configuration of software modularity images, including installations on single and dual route processors, installation rollbacks, software modularity binding, software modularity processes, and patches. • Cisco IOS Terminal Services Configuration Guide • Cisco IOS Terminal Services Command Reference DEC, local-area transport (LAT), and X.25 packet assembler/disassembler (PAD). • Cisco IOS Virtual Switch Command Reference Virtual switch redundancy, high availability, and packet handling; converting between standalone and virtual switch modes; virtual switch link (VSL); Virtual Switch Link Protocol (VSLP). Note For information about virtual switch configuration, see the product-specific software configuration information for the Cisco Catalyst 6500 series switch or for the Metro Ethernet 6500 series switch. • Cisco IOS Voice Configuration Library • Cisco IOS Voice Command Reference Cisco IOS support for voice call control protocols, interoperability, physical and virtual interface management, and troubleshooting. The library includes documentation for IP telephony applications. • Cisco IOS VPDN Configuration Guide • Cisco IOS VPDN Command Reference Layer 2 Tunneling Protocol (L2TP) dial-out load balancing and redundancy; L2TP extended failover; L2TP security VPDN; multihop by Dialed Number Identification Service (DNIS); timer and retry enhancements for L2TP and Layer 2 Forwarding (L2F); RADIUS Attribute 82 (tunnel assignment ID); shell-based authentication of VPDN users; tunnel authentication via RADIUS on tunnel terminator. • Cisco IOS Wide-Area Networking Configuration Guide • Cisco IOS Wide-Area Networking Command Reference Frame Relay; Layer 2 Tunnel Protocol Version 3 (L2TPv3); L2VPN Pseudowire Redundancy; L2VPN Interworking; Layer 2 Local Switching; Link Access Procedure, Balanced (LAPB); and X.25. • Cisco IOS Wireless LAN Configuration Guide • Cisco IOS Wireless LAN Command Reference Broadcast key rotation, IEEE 802.11x support, IEEE 802.1x authenticator, IEEE 802.1x local authentication service for Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling (EAP-FAST), Multiple Basic Service Set ID (BSSID), Wi-Fi Multimedia (WMM) required elements, and Wi-Fi Protected Access (WPA). Table 1 Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies About Cisco IOS Software Documentation Additional Resources and Documentation Feedback xxxi Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 2 lists documents and resources that supplement the Cisco IOS software configuration guides and command references. Additional Resources and Documentation Feedback What’s New in Cisco Product Documentation is released monthly and describes all new and revised Cisco technical documentation. The What’s New in Cisco Product Documentation publication also provides information about obtaining the following resources: • Technical documentation • Cisco product security overview • Product alerts and field notices • Technical assistance Cisco IOS technical documentation includes embedded feedback forms where you can rate documents and provide suggestions for improvement. Your feedback helps us improve our documentation. Table 2 Cisco IOS Supplementary Documents and Resources Document Title or Resource Description Cisco IOS Master Command List, All Releases Alphabetical list of all the commands documented in all Cisco IOS releases. Cisco IOS New, Modified, Removed, and Replaced Commands List of all the new, modified, removed, and replaced commands for a Cisco IOS release. Cisco IOS System Message Guide List of Cisco IOS system messages and descriptions. System messages may indicate problems with your system, may be informational only, or may help diagnose problems with communications lines, internal hardware, or system software. Cisco IOS Debug Command Reference Alphabetical list of debug commands including brief descriptions of use, command syntax, and usage guidelines. Release Notes and Caveats Information about new and changed features, system requirements, and other useful information about specific software releases; information about defects in specific Cisco IOS software releases. MIBs Files used for network monitoring. To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator. RFCs Standards documents maintained by the Internet Engineering Task Force (IETF) that Cisco IOS documentation references where applicable. The full text of referenced RFCs may be obtained at the following URL: http://www.rfc-editor.org/ About Cisco IOS Software Documentation Additional Resources and Documentation Feedback xxxii Cisco IOS Configuration Fundamentals Command Reference April 2010 CCDE, CCENT, CCSI, Cisco Eos, Cisco Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, 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 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. (1002R) 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. © 2008–2010 Cisco Systems, Inc. All rights reserved. xxxiii Cisco IOS Configuration Fundamentals Command Reference April 2010 Using the Command-Line Interface in Cisco IOS Software Last Updated: February 24, 2010 This document provides basic information about the command-line interface (CLI) in Cisco IOS software and how you can use some of the CLI features. This document contains the following sections: • Initially Configuring a Device, page xxxiii • Using the CLI, page xxxiv • Saving Changes to a Configuration, page xliv • Additional Information, page xliv For more information about using the CLI, see the “Using the Cisco IOS Command-Line Interface” section of the Cisco IOS Configuration Fundamentals Configuration Guide. For information about the software documentation set, see the “About Cisco IOS Software Documentation” document. Initially Configuring a Device Initially configuring a device varies by platform. For information about performing an initial configuration, see the hardware installation documentation that is provided with the original packaging of the product or go to the Product/Technologies Support area of Cisco.com at http://www.cisco.com/go/techdocs. After you have performed the initial configuration and connected the device to your network, you can configure the device by using the console port or a remote access method, such as Telnet or Secure Shell (SSH), to access the CLI or by using the configuration method provided on the device, such as Security Device Manager. Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxiv Cisco IOS Configuration Fundamentals Command Reference April 2010 Changing the Default Settings for a Console or AUX Port There are only two changes that you can make to a console port and an AUX port: • Change the port speed with the config-register 0x command. Changing the port speed is not recommended. The well-known default speed is 9600. • Change the behavior of the port; for example, by adding a password or changing the timeout value. Note The AUX port on the Route Processor (RP) installed in a Cisco ASR 1000 series router does not serve any useful customer purpose and should be accessed only under the advisement of a customer support representative. Using the CLI This section describes the following topics: • Understanding Command Modes, page xxxiv • Using the Interactive Help Feature, page xxxvii • Understanding Command Syntax, page xxxviii • Understanding Enable and Enable Secret Passwords, page xxxix • Using the Command History Feature, page xl • Abbreviating Commands, page xli • Using Aliases for CLI Commands, page xli • Using the no and default Forms of Commands, page xlii • Using the debug Command, page xlii • Filtering Output Using Output Modifiers, page xlii • Understanding CLI Error Messages, page xliii Understanding Command Modes The CLI command mode structure is hierarchical, and each mode supports a set of specific commands. This section describes the most common of the many modes that exist. Table 3 lists common command modes with associated CLI prompts, access and exit methods, and a brief description of how each mode is used. Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxv Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 3 CLI Command Modes Command Mode Access Method Prompt Exit Method Mode Usage User EXEC Log in. Router> Issue the logout or exit command. • Change terminal settings. • Perform basic tests. • Display device status. Privileged EXEC From user EXEC mode, issue the enable command. Router# Issue the disable command or the exit command to return to user EXEC mode. • Issue show and debug commands. • Copy images to the device. • Reload the device. • Manage device configuration files. • Manage device file systems. Global configuration From privileged EXEC mode, issue the configure terminal command. Router(config)# Issue the exit command or the end command to return to privileged EXEC mode. Configure the device. Interface configuration From global configuration mode, issue the interface command. Router(config-if)# Issue the exit command to return to global configuration mode or the end command to return to privileged EXEC mode. Configure individual interfaces. Line configuration From global configuration mode, issue the line vty or line console command. Router(config-line)# Issue the exit command to return to global configuration mode or the end command to return to privileged EXEC mode. Configure individual terminal lines. Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxvi Cisco IOS Configuration Fundamentals Command Reference April 2010 ROM monitor From privileged EXEC mode, issue the reload command. Press the Break key during the first 60 seconds while the system is booting. rommon # > The # symbol represents the line number and increments at each prompt. Issue the continue command. • Run as the default operating mode when a valid image cannot be loaded. • Access the fall-back procedure for loading an image when the device lacks a valid image and cannot be booted. • Perform password recovery when a Ctrl-Break sequence is issued within 60 seconds of a power-on or reload event. Diagnostic (available only on Cisco ASR 1000 series routers) The router boots or enters diagnostic mode in the following scenarios. When a Cisco IOS process or processes fail, in most scenarios the router will reload. • A user-configured access policy was configured using the transport-map command, which directed the user into diagnostic mode. • The router was accessed using an RP auxiliary port. • A break signal (Ctrl-C, Ctrl-Shift-6, or the send break command) was entered, and the router was configured to enter diagnostic mode when the break signal was received. Router(diag)# If a Cisco IOS process failure is the reason for entering diagnostic mode, the failure must be resolved and the router must be rebooted to exit diagnostic mode. If the router is in diagnostic mode because of a transport-map configuration, access the router through another port or use a method that is configured to connect to the Cisco IOS CLI. If the RP auxiliary port was used to access the router, use another port for access. Accessing the router through the auxiliary port is not useful for customer purposes. • Inspect various states on the router, including the Cisco IOS state. • Replace or roll back the configuration. • Provide methods of restarting the Cisco IOS software or other processes. • Reboot hardware (such as the entire router, an RP, an ESP, a SIP, a SPA) or other hardware components. • Transfer files into or off of the router using remote access methods such as FTP, TFTP, and SCP. Table 3 CLI Command Modes (continued) Command Mode Access Method Prompt Exit Method Mode Usage Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxvii Cisco IOS Configuration Fundamentals Command Reference April 2010 EXEC commands are not saved when the software reboots. Commands that you issue in a configuration mode can be saved to the startup configuration. If you save the running configuration to the startup configuration, these commands will execute when the software is rebooted. Global configuration mode is the highest level of configuration mode. From global configuration mode, you can enter a variety of other configuration modes, including protocol-specific modes. ROM monitor mode is a separate mode that is used when the software cannot load properly. If a valid software image is not found when the software boots or if the configuration file is corrupted at startup, the software might enter ROM monitor mode. Use the question symbol (?) to view the commands that you can use while the device is in ROM monitor mode. rommon 1 > ? alias set and display aliases command boot boot up an external process confreg configuration register utility cont continue executing a downloaded image context display the context of a loaded image cookie display contents of cookie PROM in hex . . . rommon 2 > The following example shows how the command prompt changes to indicate a different command mode: Router> enable Router# configure terminal Router(config)# interface ethernet 1/1 Router(config-if)# ethernet Router(config-line)# exit Router(config)# end Router# Note A keyboard alternative to the end command is Ctrl-Z. Using the Interactive Help Feature The CLI includes an interactive Help feature. Table 4 describes the purpose of the CLI interactive Help commands. Table 4 CLI Interactive Help Commands Command Purpose help Provides a brief description of the Help feature in any command mode. ? Lists all commands available for a particular command mode. partial command? Provides a list of commands that begin with the character string (no space between the command and the question mark). partial command Completes a partial command name (no space between the command and ). command ? Lists the keywords, arguments, or both associated with the command (space between the command and the question mark). command keyword ? Lists the arguments that are associated with the keyword (space between the keyword and the question mark). Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxviii Cisco IOS Configuration Fundamentals Command Reference April 2010 The following examples show how to use the help commands: help Router> help Help may be requested at any point in a command by entering a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options. Two styles of help are provided: 1. Full help is available when you are ready to enter a command argument (e.g. 'show ?') and describes each possible argument. 2. Partial help is provided when an abbreviated argument is entered and you want to know what arguments match the input (e.g. 'show pr?'.) ? Router# ? Exec commands: access-enable Create a temporary access-List entry access-profile Apply user-profile to interface access-template Create a temporary access-List entry alps ALPS exec commands archive manage archive files partial command? Router(config)# zo? zone zone-pair partial command Router(config)# we webvpn command ? Router(config-if)# pppoe ? enable Enable pppoe max-sessions Maximum PPPOE sessions command keyword ? Router(config-if)# pppoe enable ? group attach a BBA group Understanding Command Syntax Command syntax is the format in which a command should be entered in the CLI. Commands include the name of the command, keywords, and arguments. Keywords are alphanumeric strings that are used literally. Arguments are placeholders for values that a user must supply. Keywords and arguments may be required or optional. Specific conventions convey information about syntax and command elements. Table 5 describes these conventions. Using the Command-Line Interface in Cisco IOS Software Using the CLI xxxix Cisco IOS Configuration Fundamentals Command Reference April 2010 The following examples show syntax conventions: Router(config)# ethernet cfm domain ? WORD domain name Router(config)# ethernet cfm domain dname ? level Router(config)# ethernet cfm domain dname level ? <0-7> maintenance level number Router(config)# ethernet cfm domain dname level 7 ? Router(config)# snmp-server file-transfer access-group 10 ? protocol protocol options Router(config)# logging host ? Hostname or A.B.C.D IP address of the syslog server ipv6 Configure IPv6 syslog server Understanding Enable and Enable Secret Passwords Some privileged EXEC commands are used for actions that impact the system, and it is recommended that you set a password for these commands to prevent unauthorized use. Two types of passwords, enable (not encrypted) and enable secret (encrypted), can be set. The following commands set these passwords and are issued in global configuration mode: • enable password • enable secret password Table 5 CLI Syntax Conventions Symbol/Text Function Notes < > (angle brackets) Indicate that the option is an argument. Sometimes arguments are displayed without angle brackets. A.B.C.D. Indicates that you must enter a dotted decimal IP address. Angle brackets (< >) are not always used to indicate that an IP address is an argument. WORD (all capital letters) Indicates that you must enter one word. Angle brackets (< >) are not always used to indicate that a WORD is an argument. LINE (all capital letters) Indicates that you must enter more than one word. Angle brackets (< >) are not always used to indicate that a LINE is an argument. (carriage return) Indicates the end of the list of available keywords and arguments, and also indicates when keywords and arguments are optional. When is the only option, you have reached the end of the branch or the end of the command if the command has only one branch. — Using the Command-Line Interface in Cisco IOS Software Using the CLI xl Cisco IOS Configuration Fundamentals Command Reference April 2010 Using an enable secret password is recommended because it is encrypted and more secure than the enable password. When you use an enable secret password, text is encrypted (unreadable) before it is written to the config.text file. When you use an enable password, the text is written as entered (readable) to the config.text file. Each type of password is case sensitive, can contain from 1 to 25 uppercase and lowercase alphanumeric characters, and can start with a numeral. Spaces are also valid password characters; for example, “two words” is a valid password. Leading spaces are ignored, but trailing spaces are recognized. Note Both password commands have numeric keywords that are single integer values. If you choose a numeral for the first character of your password followed by a space, the system will read the number as if it were the numeric keyword and not as part of your password. When both passwords are set, the enable secret password takes precedence over the enable password. To remove a password, use the no form of the commands: no enable password or no enable secret password. For more information about password recovery procedures for Cisco products, see the following: http://www.cisco.com/en/US/products/sw/iosswrel/ps1831/ products_tech_note09186a00801746e6.shtml Using the Command History Feature The command history feature saves, in a command history buffer, the commands that you enter during a session. The default number of saved commands is 10, but the number is configurable within the range of 0 to 256. This command history feature is particularly useful for recalling long or complex commands. To change the number of commands saved in the history buffer for a terminal session, issue the terminal history size command: Router# terminal history size num A command history buffer is also available in line configuration mode with the same default and configuration options. To set the command history buffer size for a terminal session in line configuration mode, issue the history command: Router(config-line)# history [size num] To recall commands from the history buffer, use the following methods: • Press Ctrl-P or the Up Arrow key—Recalls commands beginning with the most recent command. Repeat the key sequence to recall successively older commands. • Press Ctrl-N or the Down Arrow key—Recalls the most recent commands in the history buffer after they have been recalled using Ctrl-P or the Up Arrow key. Repeat the key sequence to recall successively more recent commands. Note The arrow keys function only on ANSI-compatible terminals such as the VT100. • Issue the show history command in user EXEC or privileged EXEC mode—Lists the most recent commands that you entered. The number of commands that are displayed is determined by the setting of the terminal history size and history commands. Using the Command-Line Interface in Cisco IOS Software Using the CLI xli Cisco IOS Configuration Fundamentals Command Reference April 2010 The command history feature is enabled by default. To disable this feature for a terminal session, issue the terminal no history command in user EXEC or privileged EXEC mode or the no history command in line configuration mode. Abbreviating Commands Typing a complete command name is not always required for the command to execute. The CLI recognizes an abbreviated command when the abbreviation contains enough characters to uniquely identify the command. For example, the show version command can be abbreviated as sh ver. It cannot be abbreviated as s ver because s could mean show, set, or systat. The sh v abbreviation also is not valid because the show command has vrrp as a keyword in addition to version. (Command and keyword examples are from Cisco IOS Release 12.4(13)T.) Using Aliases for CLI Commands To save time and the repetition of entering the same command multiple times, you can use a command alias. An alias can be configured to do anything that can be done at the command line, but an alias cannot move between modes, type in passwords, or perform any interactive functions. Table 6 shows the default command aliases. To create a command alias, issue the alias command in global configuration mode. The syntax of the command is alias mode command-alias original-command. Following are some examples: • Router(config)# alias exec prt partition—privileged EXEC mode • Router(config)# alias configure sb source-bridge—global configuration mode • Router(config)# alias interface rl rate-limit—interface configuration mode To view both default and user-created aliases, issue the show alias command. For more information about the alias command, see the following: http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_a1.html Table 6 Default Command Aliases Command Alias Original Command h help lo logout p ping s show u or un undebug w where Using the Command-Line Interface in Cisco IOS Software Using the CLI xlii Cisco IOS Configuration Fundamentals Command Reference April 2010 Using the no and default Forms of Commands Most configuration commands have a no form that is used to reset a command to its default value or to disable a feature or function. For example, the ip routing command is enabled by default. To disable this command, you would issue the no ip routing command. To re-enable IP routing, you would issue the ip routing command. Configuration commands may also have a default form, which returns the command settings to their default values. For commands that are disabled by default, using the default form has the same effect as using the no form of the command. For commands that are enabled by default and have default settings, the default form enables the command and returns the settings to their default values. To see what default commands are available on your system, enter default ? in the appropriate command mode of the command-line interface. The no form is documented in the command pages of Cisco IOS command references. The default form is generally documented in the command pages only when the default form performs a function different than that of the plain and no forms of the command. Command pages often include a “Command Default” section as well. The “Command Default” section documents the state of the configuration if the command is not used (for configuration commands) or the outcome of using the command if none of the optional keywords or arguments is specified (for EXEC commands). Using the debug Command A debug command produces extensive output that helps you troubleshoot problems in your network. These commands are available for many features and functions within Cisco IOS software. Some debug commands are debug all, debug aaa accounting, and debug mpls packets. To use debug commands during a Telnet session with a device, you must first enter the terminal monitor command. To turn off debugging completely, you must enter the undebug all command. For more information about debug commands, see the Cisco IOS Debug Command Reference: http://www.cisco.com/en/US/docs/ios/debug/command/reference/db_book.html Caution Debugging is a high priority and high CPU utilization process that can render your device unusable. Use debug commands only to troubleshoot specific problems. The best times to run debugging are during periods of low network traffic and when few users are interacting with the network. Debugging during these periods decreases the likelihood that the debug command processing overhead will affect network performance or user access or response times. Filtering Output Using Output Modifiers Many commands produce lengthy output that may use several screens to display. Using output modifiers, you can filter this output to show only the information that you want to see. Using the Command-Line Interface in Cisco IOS Software Using the CLI xliii Cisco IOS Configuration Fundamentals Command Reference April 2010 The following three output modifiers are available: • begin regular-expression—Displays the first line in which a match of the regular expression is found and all lines that follow. • include regular-expression—Displays all lines in which a match of the regular expression is found. • exclude regular-expression—Displays all lines except those in which a match of the regular expression is found. To use one of these output modifiers, type the command followed by the pipe symbol (|), the modifier, and the regular expression that you want to search for or filter. A regular expression is a case-sensitive alphanumeric pattern. It can be a single character or number, a phrase, or a more complex string. The following example illustrates how to filter output of the show interface command to display only lines that include the expression “protocol.” Router# show interface | include protocol FastEthernet0/0 is up, line protocol is up Serial4/0 is up, line protocol is up Serial4/1 is up, line protocol is up Serial4/2 is administratively down, line protocol is down Serial4/3 is administratively down, line protocol is down Understanding CLI Error Messages You may encounter some error messages while using the CLI. Table 7 shows the common CLI error messages. For more system error messages, see the Cisco IOS Release 12.4T System Message Guide. Table 7 Common CLI Error Messages Error Message Meaning How to Get Help % Ambiguous command: “show con” You did not enter enough characters for the command to be recognized. Reenter the command followed by a space and a question mark (?). The keywords that you are allowed to enter for the command appear. % Incomplete command. You did not enter all the keywords or values required by the command. Reenter the command followed by a space and a question mark (?). The keywords that you are allowed to enter for the command appear. % Invalid input detected at “^” marker. You entered the command incorrectly. The caret (^) marks the point of the error. Enter a question mark (?) to display all the commands that are available in this command mode. The keywords that you are allowed to enter for the command appear. Using the Command-Line Interface in Cisco IOS Software Saving Changes to a Configuration xliv Cisco IOS Configuration Fundamentals Command Reference April 2010 Saving Changes to a Configuration To save changes that you made to the configuration of a device, you must issue the copy running-config startup-config command or the copy system:running-config nvram:startup-config command. When you issue these commands, the configuration changes that you made are saved to the startup configuration and saved when the software reloads or power to the device is turned off or interrupted. The following example shows the syntax of the copy running-config startup-config command: Router# copy running-config startup-config Destination filename [startup-config]? You press Enter to accept the startup-config filename (the default), or type a new filename and then press Enter to accept that name. The following output is displayed indicating that the configuration was saved. Building configuration... [OK] Router# On most platforms, the configuration is saved to NVRAM. On platforms with a Class A flash file system, the configuration is saved to the location specified by the CONFIG_FILE environment variable. The CONFIG_FILE variable defaults to NVRAM. Additional Information • “Using the Cisco IOS Command-Line Interface” section of the Cisco IOS Configuration Fundamentals Configuration Guide http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/cf_cli-basics.html • Cisco Product/Technology Support http://www.cisco.com/go/techdocs • Support area on Cisco.com (also search for documentation by task or product) http://www.cisco.com/en/US/support/index.html • Software Download Center (downloads; tools; licensing, registration, advisory, and general information) (requires Cisco.com user ID and password) http://www.cisco.com/kobayashi/sw-center/ • Error Message Decoder, a tool to help you research and resolve error messages for Cisco IOS software http://www.cisco.com/pcgi-bin/Support/Errordecoder/index.cgi • Command Lookup Tool, a tool to help you find detailed descriptions of Cisco IOS commands (requires Cisco.com user ID and password) http://tools.cisco.com/Support/CLILookup • Output Interpreter, a troubleshooting tool that analyzes command output of supported show commands https://www.cisco.com/pcgi-bin/Support/OutputInterpreter/home.pl Using the Command-Line Interface in Cisco IOS Software Additional Information xlv Cisco IOS Configuration Fundamentals Command Reference April 2010 CCDE, CCENT, CCSI, Cisco Eos, Cisco Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, 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 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. (1002R) 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. © 2008–2010 Cisco Systems, Inc. All rights reserved. Using the Command-Line Interface in Cisco IOS Software Additional Information xlvi Cisco IOS Configuration Fundamentals Command Reference April 2010 CF-1 Cisco IOS Configuration Fundamentals Command Reference April 2010 Introduction The Cisco IOS Configuration Fundamentals Command Reference provides command documentation associated with the following tasks: • Using the Cisco IOS Command-Line Interface (CLI) • Configuration Using Setup and AutoInstall • Configuring Operating Characteristics for Terminals • Managing Connections, Logins, Menus, and System Banners – Configure user menus and banners • Using the Cisco Web Browser User Interface (UI) – Using the HTTP server-based UI as an alternative to the CLI • Using the Cisco IOS Integrated File System (IFS) – The basics of filesystem use and Cisco IOS software’s filesystem infrastructure • Configuring Basic File Transfer Services – Copy, move, and delete files locally or across the network • Managing Configuration Files • Loading, Maintaining, and Upgrading System Images • Rebooting For further information about performing these tasks, refer to the Cisco IOS Configuration Fundamentals Configuration Guide for your release. Note Some commands previously documented in this Command Reference have been moved to other books: Commands related to system management and network monitoring can be found in the Cisco IOS Network Management Command Reference. Command reference documentation for the Cisco IOS software feature “Service Assurance Agent (SAA)” can be found in the the Cisco IOS IP SLAs Command Reference. Introduction Cisco IOS IFS Command Syntax CF-2 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco IOS IFS Command Syntax Some commands in this book use URLs (uniform resource locators) as part of the command syntax. URLs used in the Cisco IOS Integrated File System (IFS) contain two parts: a file system or network prefix, and a file identification suffix. The following tables list URL keywords that can be used in the source-url and destination-url arguments for all commands in this book. The prefixes listed below can also be used in the filesystem arguments in this document. Table 8 lists common URL network prefixes used to indicate a device on the network. Table 9 lists the available suffix options (file indentification suffixes) for the URL prefixes used in Table 8. Table 10 lists common URL prefixes used to indicate memory locations on the system. Table 8 Network Prefixes for Cisco IFS URLs Prefix Description ftp: Specifies a File Transfer Protocol (FTP) network server. rcp: Specifies an remote copy protocol (rcp) network server. tftp: Specifies a TFTP server. Table 9 File ID Suffixes for Cisco IFS URLs Prefix Suffix Options ftp: [[//[username[:password]@]location]/directory]/filename For example: ftp://network-config (prefix://filename) ftp://user1:mypassword1@example.com/config-files rcp: rcp:[[//[username@]location]/directory]/filename tftp: tftp:[[//location]/directory]/filename Table 10 File System Prefixes for Cisco IFS URLs Prefix Description bootflash: Boot flash memory. disk0: Rotating disk media. flash: [partition-number] Flash memory. This prefix is available on all platforms. For platforms that do not have a device named flash:, the prefix flash: is aliased to slot0:. Therefore, you can use the prefix flash: to refer to the main Flash memory storage area on all platforms. flh: Flash load helper log files. null: Null destination for copies. You can copy a remote file to null to determine its size. nvram: NVRAM. This is the default location for the running-configuration file. Introduction Obtaining Documentation, Obtaining Support, and Security Guidelines CF-3 Cisco IOS Configuration Fundamentals Command Reference April 2010 For details about the Cisco IOS IFS, and for IFS configuration tasks, refer to the “Using the Cisco IOS Integrated File System (IFS)” chapter in the latest Cisco IOS Configuration Fundamentals Configuration Guide appropriate for your release version. Obtaining Documentation, Obtaining Support, and Security Guidelines For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html slavebootflash: Internal Flash memory on a slave RSP card of a router configured with Dual RSPs. slavenvram: NVRAM on a slave RSP card. slaveslot0: First PCMCIA card on a slave RSP card. slaveslot1: Second PCMCIA card on a slave RSP card. slot0: First PCMCIA Flash memory card. slot1: Second PCMCIA Flash memory card. xmodem: Obtain the file from a network machine using the Xmodem protocol. ymodem: Obtain the file from a network machine using the Ymodem protocol. Table 10 File System Prefixes for Cisco IFS URLs (continued) Prefix Description Introduction Obtaining Documentation, Obtaining Support, and Security Guidelines CF-4 Cisco IOS Configuration Fundamentals Command Reference April 2010 CF-5 Cisco IOS Configuration Fundamentals Command Reference April 2010 Configuration Fundamentals Commands Configuration Fundamentals Commands activation-character CF-6 Cisco IOS Configuration Fundamentals Command Reference April 2010 activation-character To define the character you enter at a vacant terminal to begin a terminal session, use the activation-character command in line configuration mode. To make any character activate a terminal, use the no form of this command. activation-character ascii-number no activation-character Syntax Description Defaults Return (decimal 13) Command Modes Line configuration (config-line) Command History Usage Guidelines See the “ASCII Character Set and Hexadecimal Values” document for a list of ASCII characters. Note If you are using the autoselect function, set the activation character to the default, Return, and exec-character-bits to 7. If you change these defaults, the application will not recognize the activation request. Examples The following example shows how to set the activation character for the console to Delete, which is decimal character 127: Router(config)# line console Router(config-line)# activation-character 127 ascii-number Decimal representation of the activation character. Release Modification 10.0 This command was introduced. This command is supported in all Cisco IOS software Releases. Configuration Fundamentals Commands alias CF-7 Cisco IOS Configuration Fundamentals Command Reference April 2010 alias To create a command alias, use the alias command in global configuration mode. To delete all aliases in a command mode or to delete a specific alias, and to revert to the original command syntax, use the no form of this command. alias mode command-alias original-command no alias mode [command-alias] Syntax Description Defaults A set of six basic EXEC mode aliases are enabled by default. See the “Usage Guidelines” section of this command for a list of default aliases. Command Modes Global configuration Command History Usage Guidelines You can use simple words or abbreviations as command aliases. Table 11 lists the basic EXEC mode aliases that are enabled by default. The default aliases in Table 11 are predefined. These default aliases can be disabled with the no alias exec command. mode Command mode of the original and alias commands. command-alias Command alias. original-command Original command syntax. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 11 Default Command Aliases Command Alias Original Command h help lo logout p ping r resume s show w where Configuration Fundamentals Commands alias CF-8 Cisco IOS Configuration Fundamentals Command Reference April 2010 Common keyword aliases (which cannot be disabled) include running-config (keyword alias for system:running-config) and startup-config (keyword alias for nvram:startup-config). See the description of the copy command for more information about these keyword aliases. Note that aliases can be configured for keywords instead of entire commands. You can create, for example, an alias for the first part of any command and still enter the additional keywords and arguments as normal. To determine the value for the mode argument, enter the command mode in which you would issue the original command (and in which you will issue the alias) and enter the ? command. The name of the command mode should appear at the top of the list of commands. For example, the second line in the following sample output shows the name of the command mode as “Interface configuration”: Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# interface e0 Router(config-if)# ? Interface configuration commands: access-expression Build a bridge boolean access expression . . . To match the name of the command mode to the acceptable mode keyword for the alias command, issue the alias ? command. As shown in the following sample output, the keyword needed to create a command alias for the access-expression command is interface: Router(config)# alias ? accept-dialin VPDN group accept dialin configuration mode accept-dialout VPDN group accept dialout configuration mode address-family Address Family configuration mode call-discriminator Call Discriminator Configuration cascustom Cas custom configuration mode clid-group CLID group configuration mode configure Global configuration mode congestion Frame Relay congestion configuration mode controller Controller configuration mode cptone-set custom call progress tone configuration mode customer-profile customer profile configuration mode dhcp DHCP pool configuration mode dnis-group DNIS group configuration mode exec Exec mode flow-cache Flow aggregation cache config mode fr-fr FR/FR connection configuration mode interface Interface configuration mode . . . Router(config)# alias interface express access-expression When you use online help, command aliases are indicated by an asterisk (), and displayed in the following format: command-alias=original-command For example, the lo command alias is shown here along with other EXEC mode commands that start with “lo”: Router# lo? lo=logout lock login logout When you use online help, aliases that contain multiple keyword elements separated by spaces are displayed in quotes, as shown here: Configuration Fundamentals Commands alias CF-9 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router(config)#alias exec device-mail telnet device.cisco.com 25 Router(config)#end Router#device-mail? device-mail=”telnet device.cisco.com 25" To list only commands and omit aliases, begin your input line with a space. In the following example, the alias td is not shown, because there is a space before the t? command line. Router(config)#alias exec td telnet device Router(config)#end Router# t? telnet terminal test tn3270 trace To circumvent command aliases, use a space before entering the command. In the following example, the command alias express is not recognized because a space is used before the command. Router(config-if)#exp? express=access-expression Router(config-if)# express ? % Unrecognized command As with commands, you can use online help to display the arguments and keywords that can follow a command alias. In the following example, the alias td is created to represent the command telnet device. The /debug and /line switches can be added to telnet device to modify the command: Router(config)#alias exec td telnet device Router(config)#end Router#td ? /debug Enable telnet debugging mode /line Enable telnet line mode ... whois Whois port Router# telnet device You must enter the complete syntax for the command alias. Partial syntax for aliases is not accepted. In the following example, the parser does not recognize the command t as indicating the alias td: Router# t % Ambiguous command: “t” Examples In the following example, the alias fixmyrt is configured for the clear iproute 192.168.116.16 EXEC mode command: Router(config)#alias exec fixmyrt clear ip route 192.168.116.16 In the following example, the alias express is configured for the first part of the access-expression interface configuration command: Router#configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)#interface e0 Router(config-if)#? Interface configuration commands: access-expression Build a bridge boolean access expression . . . Router(config-if)#exit Router(config)#alias ? accept-dialin VPDN group accept dialin configuration mode Configuration Fundamentals Commands alias CF-10 Cisco IOS Configuration Fundamentals Command Reference April 2010 accept-dialout VPDN group accept dialout configuration mode address-family Address Family configuration mode call-discriminator Call Discriminator Configuration cascustom Cas custom configuration mode clid-group CLID group configuration mode configure Global configuration mode congestion Frame Relay congestion configuration mode controller Controller configuration mode cptone-set custom call progress tone configuration mode customer-profile customer profile configuration mode dhcp DHCP pool configuration mode dnis-group DNIS group configuration mode exec Exec mode flow-cache Flow aggregation cache config mode fr-fr FR/FR connection configuration mode interface Interface configuration mode . . . Router(config)#alias interface express access-expression Router(config)#int e0 Router(config-if)#exp? express=access-expression Router(config-if)#express ? input Filter input packets output Filter output packets !Note that the true form of the command/keyword alias appears on the screen after issuing !the express ? command. Router(config-if)#access-expression ? input Filter input packets output Filter output packets Router(config-if)#ex? express=access-expression exit !Note that in the following line, a space is used before the ex? command !so the alias is not displayed. Router(config-if)# ex? exit !Note that in the following line, the alias cannot be recognized because !a space is used before the command. Router#(config-if)# express ? % Unrecognized command Router(config-if)# end Router# show alias interface Interface configuration mode aliases: express access-expression Related Commands Command Description show aliases Displays command aliases. Configuration Fundamentals Commands archive CF-11 Cisco IOS Configuration Fundamentals Command Reference April 2010 archive To enter archive configuration mode, use the archive command in global configuration mode. archive Syntax Description This command has no arguments or keywords. Command Default None Command Modes Global configuration Command History Examples The following example shows how to place the router in archive configuration mode: Router# configure terminal ! Router(config)# archive Router(config-archive)# Related Commands Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. Command Description log config Enters configuration change logger configuration mode. logging enable Enables the logging of configuration changes. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. Configuration Fundamentals Commands archive config CF-12 Cisco IOS Configuration Fundamentals Command Reference April 2010 archive config To save a copy of the current running configuration to the Cisco IOS configuration archive, use the archive config command in privileged EXEC mode. archive config Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines Note Before using this command, you must configure the path command in order to specify the location and filename prefix for the files in the Cisco IOS configuration archive. The Cisco IOS configuration archive is intended to provide a mechanism to store, organize, and manage an archive of Cisco IOS configuration files to enhance the configuration rollback capability provided by the configure replace command. Before this feature was introduced, you could save copies of the running configuration using the copy running-config destination-url command, storing the target file either locally or remotely. However, this method lacked any automated file management. On the other hand, the Configuration Replace and Configuration Rollback feature provides the capability to automatically save copies of the running configuration to the Cisco IOS configuration archive. These archived files serve as checkpoint configuration references and can be used by the configure replace command to revert to previous configuration states. The archive config command allows you to save Cisco IOS configurations in the configuration archive using a standard location and filename prefix that is automatically appended with an incremental version number (and optional time stamp) as each consecutive file is saved. This functionality provides a means for consistent identification of saved Cisco IOS configuration files. You can specify how many versions of the running configuration are kept in the archive. After the maximum number of files has been saved in the archive, the oldest file is automatically deleted when the next, most recent file is saved. The show archive command displays information for all configuration files saved in the Cisco IOS configuration archive. Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. Configuration Fundamentals Commands archive config CF-13 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to save the current running configuration to the Cisco IOS configuration archive using the archive config command. Before using the archive config command, you must configure the path command to specify the location and filename prefix for the files in the Cisco IOS configuration archive. In this example, the location and filename prefix are specified as disk0:myconfig as follows: configure terminal ! archive path disk0:myconfig end You then save the current running configuration in the configuration archive, as follows: archive config The show archive command displays information on the files saved in the configuration archive as shown in the following sample output: Router# show archive There are currently 1 archive configurations saved. The next archive file will be named disk0:myconfig-2 Archive # Name 0 1 disk0:myconfig-1 <- Most Recent 2 3 4 5 6 7 8 9 10 Related Commands Command Description archive Enters archive configuration mode. configure confirm Confirms replacement of the current running configuration with a saved Cisco IOS configuration file. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. Configuration Fundamentals Commands archive log config persistent save CF-14 Cisco IOS Configuration Fundamentals Command Reference April 2010 archive log config persistent save To save the persisted commands in the configuration log to the Cisco IOS secure file system, use the archive log config persistent save command in virtually any configuration mode. archive log config persistent save Syntax Description This command has no arguments or keywords. Command Default If this command is not entered, the persisted configuration commands in the archive log are not saved to the Cisco IOS secure file system. Command Modes Configuration change logger configuration mode in archive configuration mode is common for this command, but the command can be used in virtually any configuration mode. Command History Usage Guidelines This command can be entered at any time, regardless of what mode the router is in. If the router is in the persistent periodic mode, the persistent timer is restarted. Examples The following example saves the persisted commands in the archive log to the Cisco IOS secure file system: Router(config-archive-log-cfg)# archive log config persistent save Related Commands Release Modification 12.2(33)SRA This command was introduced. 12.4(11)T This command was integrated into Cisco IOS Release 12.4(11)T. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. Command Description log config Enters configuration change logger configuration mode. logging enable Enables the logging of configuration changes. logging persistent Enables the configuration logging persistent feature. Configuration Fundamentals Commands archive tar CF-15 Cisco IOS Configuration Fundamentals Command Reference April 2010 archive tar To create a TAR file, to list files in a TAR file, or to extract the files from a TAR file, use the archive tar command in privileged EXEC mode. archive tar {/create destination-url flash:/file-url | /table source-url | /xtract source-url flash:/file-url [dir/file...]} Syntax Description /create destination-url flash:/file-url Creates a new TAR file on the local or network file system. For destination-url, specify the destination URL alias for the local or network file system and the name of the TAR file to create. The following options are supported: • flash:—Syntax for the local flash file system. • ftp:[[//username[:password]@location]/directory]/tar-filename.tar— Syntax for FTP. • rcp:[[//username@location]/directory]/tar-filename.tar—Syntax for Remote Copy Protocol (RCP). • tftp:[[//location]/directory]/tar-filename.tar —Syntax for TFTP. The tar-filename.tar is the name of the TAR file to be created. For flash:/file-url, specify the location on the local flash file system from which the new TAR file is created. An optional list of files or directories within the source directory can be specified to write to the new TAR file. If none is specified, all files and directories at this level are written to the newly created TAR file. /table source-url Display the contents of an existing TAR file to the screen. For source-url, specify the source URL alias for the local or network file system. The following options are supported: • flash:—Syntax for the local flash file system. • ftp:[[//username[:password]@location]/directory]/tar-filename.tar— Syntax for FTP. • rcp:[[//username@location]/directory]/tar-filename.tar—Syntax for Remote Copy Protocol (RCP). • tftp:[[//location]/directory]/tar-filename.tar —Syntax for TFTP. The tar-filename.tar is the name of the TAR file to be created. Configuration Fundamentals Commands archive tar CF-16 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default The TAR archive file is not created. Command Modes Privileged EXEC (#) Command History Usage Guidelines Filenames, directory names, and image names are case sensitive. The TAR file is an archive file from which you can extract files by using the archive tar command. Examples The following example shows how to create a TAR file. The command writes the contents of the new-configs directory on the local flash device to a file named saved.tar on the TFTP server at 172.20.136.9. Switch# archive tar /create tftp:172.20.136.9/saved.tar flash:/new-configs The following example shows how to display the contents of the c2940-tv0-m.tar file that is in flash memory. The contents of the TAR file appear on the screen. Switch# archive tar /table flash:c2940-tv0-m.tar info (219 bytes) c2940-tv0-mz-121/ (directory) c2940-tv0-mz-121/html/ (directory) c2940-tv0-mz-121/html/foo.html (0 bytes) c2940-tv0-mz-121/vegas-tv0-mz-121.bin (610856 bytes) c2940-tv0-mz-121/info (219 bytes) info.ver (219 bytes) /xtract source-url flash:/file-url [dir/file...] Extracts files from a TAR file to the local file system. For source-url, specify the source URL alias for the local file system. These options are supported: • flash:—Syntax for the local flash file system. • ftp:[[//username[:password]@location]/directory]/tar-filename.tar— Syntax for FTP. • rcp:[[//username@location]/directory]/tar-filename.tar—Syntax for Remote Copy Protocol (RCP). • tftp:[[//location]/directory]/tar-filename.tar —Syntax for TFTP. The tar-filename.tar is the name of the TAR file to be created. Release Modification 12.1(13)AY This command was introduced. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.4(22)YB This command was integrated into Cisco IOS Release 12.4(22)YB. 12.4(24)T This command was integrated into Cisco IOS Release 12.4(24)T. Configuration Fundamentals Commands archive tar CF-17 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following example shows how to extract the contents of a TAR file on the TFTP server at 172.20.10.30. This command extracts only the new-configs directory into the root directory on the local flash file system. The remaining files in the saved.tar file are ignored. Switch# archive tar /xtract tftp:/172.20.10.30/saved.tar flash:/ new-configs Configuration Fundamentals Commands async-bootp CF-18 Cisco IOS Configuration Fundamentals Command Reference April 2010 async-bootp To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the async-bootp command in global configuration mode. To restore the default, use the no form of this command. async-bootp tag [:hostname] data no async-bootp Syntax Description tag Item being requested; expressed as filename, integer, or IP dotted decimal address. See Table 12 for possible keywords. :hostname (Optional) This entry applies only to the specified host. The :hostname argument accepts both an IP address and a logical host name. data List of IP addresses entered in dotted decimal notation or as logical host names, a number, or a quoted string. Table 12 tag Keyword Options Keyword Description bootfile Specifies use of a server boot file from which to download the boot program. Use the optional :hostname argument and the data argument to specify the filename. subnet-mask mask Dotted decimal address specifying the network and local subnetwork mask (as defined by RFC 950). time-offset offset Signed 32-bit integer specifying the time offset of the local subnetwork in seconds from Coordinated Universal Time (UTC). gateway address Dotted decimal address specifying the IP addresses of gateways for this subnetwork. A preferred gateway should be listed first. time-server address Dotted decimal address specifying the IP address of time servers (as defined by RFC 868). IEN116-server address Dotted decimal address specifying the IP address of name servers (as defined by IEN 116). nbns-server address Dotted decimal address specifying the IP address of Windows NT servers. DNS-server address Dotted decimal address specifying the IP address of domain name servers (as defined by RFC 1034). log-server address Dotted decimal address specifying the IP address of an MIT-LCS UDP log server. quote-server address Dotted decimal address specifying the IP address of Quote of the Day servers (as defined in RFC 865). lpr-server address Dotted decimal address specifying the IP address of Berkeley UNIX Version 4 BSD servers. impress-server address Dotted decimal address specifying the IP address of Impress network image servers. Configuration Fundamentals Commands async-bootp CF-19 Cisco IOS Configuration Fundamentals Command Reference April 2010 Defaults If no extended BOOTP commands are entered, the Cisco IOS software generates a gateway and subnet mask appropriate for the local network. Command Modes Global configuration Command History Usage Guidelines Use the show async-bootp EXEC command to list the configured parameters. Use the no async-bootp command to clear the list. Examples The following example illustrates how to specify different boot files: one for a PC, and one for a Macintosh. With this configuration, a BOOTP request from the host on 172.30.1.1 results in a reply listing the boot filename as pcboot. A BOOTP request from the host named “mac” results in a reply listing the boot filename as “macboot.” async-bootp bootfile :172.30.1.1 “pcboot” async-bootp bootfile :mac “macboot” The following example specifies a subnet mask of 255.255.0.0: async-bootp subnet-mask 255.255.0.0 The following example specifies a negative time offset of the local subnetwork of 3600 seconds: async-bootp time-offset -3600 The following example specifies the IP address of a time server: async-bootp time-server 172.16.1.1 Related Commands rlp-server address Dotted decimal address specifying the IP address of Resource Location Protocol (RLP) servers (as defined in RFC 887). hostname name The name of the client, which may or may not be domain qualified, depending upon the site. bootfile-size value A two-octet value specifying the number of 512-octet (byte) blocks in the default boot file. Table 12 tag Keyword Options (continued) Keyword Description Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show async bootp Displays the extended BOOTP request parameters that have been configured for asynchronous interfaces. Configuration Fundamentals Commands attach CF-20 Cisco IOS Configuration Fundamentals Command Reference April 2010 attach To connect to a specific line card or module from a remote location for the purpose of executing monitoring and maintenance commands on that line card or module, use the attach command in privileged EXEC mode. To exit from the Cisco IOS software image on the line card and return to the Cisco IOS image on the main (Supervisor) module, use the exit command. Cisco 12000 Series attach slot-number Cisco 7600 Series and Catalyst 6500 Series attach module-number Syntax Description Defaults No default behavior or values. Command Modes Privileged EXEC Command History Usage Guidelines Cisco 12000 Series You must first use the attach privileged EXEC command to access the Cisco IOS software image on a line card before using line card-specific show EXEC commands. Alternatively, you can use the execute-on privileged EXEC command to execute a show command on a specific line card. After you connect to the Cisco IOS image on the line card using the attach command, the prompt changes to LC-Slotx#, where x is the slot number of the line card. The commands executed on the line card use the Cisco IOS image on that line card. You can also use the execute-on slot privileged EXEC command to execute commands on one or all line cards. Note Do not execute the config EXEC command from the Cisco IOS software image on the line card. slot-number Slot number of the line card to which you wish to connect. If you omit the slot number, you will be prompted for it. module-number Module number; see the “Usage Guidelines” section for valid values. Release Modification 11.2GS This command was introduced on the Cisco 12000 series. 12.2(14)SX This command was implemented on the Supervisor Engine 720. 12.2(17d)SXB Support was added for the Supervisor Engine 2. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands attach CF-21 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco 7600 Series and Catalyst 6500 Series Caution After you enter the attach or remote login command to access another console from your switch, if you enter global or interface configuration mode commands, the switch might reset. The valid values for the module-number argument depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13. This command is supported on Distributed Forwarding Card (DFC)-equipped modules, FlexWan modules, and the supervisor engine only. When you execute the attach module-number command, the prompt changes to Router-dfcx# or Switch-sp#, depending on the type of module to which you are connecting. The behavior of the attach command is identical to that of the remote login module num command. There are two ways to end this session: • You can enter the exit command as follows: Router-dfc3# exit [Connection to Switch closed by foreign host] Router# • You can press Ctrl-C three times as follows: Router-dfc3# ^C Router-dfc3# ^C Router-dfc3# ^C Terminate remote login session? [confirm] y [Connection to Switch closed by local host] Router# Examples In the following example, the user connects to the Cisco IOS image running on the line card in slot 9, gets a list of valid show commands, and returns the Cisco IOS image running on the GRP: Router# attach 9 Entering Console for 4 Port Packet Over SONET OC-3c/STM-1 in Slot: 9 Type exit to end this session Press RETURN to get started! LC-Slot9# show ? cef Cisco Express Forwarding clock Display the system clock context Show context information about recent crash(s) history Display the session command history hosts IP domain-name, lookup style, nameservers, and host table ipc Interprocess communications commands location Display the system location sessions Information about Telnet connections terminal Display terminal configuration parameters users Display information about terminal lines version System hardware and software status LC-Slot9# exit Disconnecting from slot 9. Configuration Fundamentals Commands attach CF-22 Cisco IOS Configuration Fundamentals Command Reference April 2010 Connection Duration: 00:01:04 Router# Note Because not all statistics are maintained on line cards, the output from some of show commands may be inconsistent. The following example shows how to log in remotely to the DFC-equipped module: Console# attach 3 Trying Switch ... Entering CONSOLE for Switch Type "^C^C^C" to end this session Router-dfc3# Related Commands Command Description attach shelf Connects you to a specific (managed) shelf for the purpose of remotely executing commands on that shelf only. execute-on slot Executes commands remotely on a specific line card, or on all line cards simultaneously. remote login Accesses the Cisco 7600 series router console or a specific module. Configuration Fundamentals Commands autobaud CF-23 Cisco IOS Configuration Fundamentals Command Reference April 2010 autobaud To set the line for automatic baud rate detection (autobaud), use the autobaud command in line configuration mode. To disable automatic baud detection, use the no form of this command. autobaud no autobaud Syntax Description This command has no arguments or keywords. Defaults Autobaud detection is disabled. Fixed speed of 9600 bps. Command Modes Line configuration Command History Usage Guidelines The autobaud detection supports a range from 300 to 19200 baud. A line set for autobaud cannot be used for outgoing connections, nor can you set autobaud capability on a line using 19200 baud when the parity bit is set (because of hardware limitations). Note Automatic baud detection must be disabled by using the no autobaud command prior to setting the txspeed, rxspeed, or speed commands. Examples In the following example, the auxiliary port is configured for autobaud detection: Router(config)# line aux Router(config-line)# autobaud Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands auto-sync CF-24 Cisco IOS Configuration Fundamentals Command Reference April 2010 auto-sync To enable automatic synchronization of the configuration files in NVRAM, use the auto-sync command in main-cpu redundancy configuration mode. To disable automatic synchronization, use the no form of this command. auto-sync {startup-config | config-register | bootvar | running-config | standard} no auto-sync {startup-config | config-register | bootvar | standard} Syntax Description Defaults For the Performance Routing Engines (PREs) on the Cisco uBR10012 universal broadband router, the system defaults to synchronizing all system files on the (auto-sync standard). For the Supervisor Engines on the Cisco 7600 series routers, the system defaults to synchronizing the running configuration. (running-config). Command Modes Main-cpu redundancy configuration Command History Usage Guidelines Cisco 7600 Series Routers If you enter the no auto-sync standard command, no automatic synchronizations occur. If you want to enable any of the keywords, you have to enter the appropriate command for each keyword. The auto-sync command is not supported in RPR+ mode. startup-config Specifies synchronization of the startup configuration files. config-register Specifies synchronization of the configuration register values. bootvar Specifies synchronization of the following boot variables: • BOOT—Set by the boot system device:filename command. • CONFIG_FILE—Set by the boot config device:filename command. • BOOTLDR—Set by the boot bootldr device:filename command. running-config Specifies synchronization of the running configuration files. standard Specifies synchronization of all of the system files (startup configuration, boot variables, and config configuration registers). Release Modification 12.2(4)XF1 This command was introduced on the Cisco uBR10012 universal broadband router. 12.2(14)SX This command was integrated into the Supervisor Engine 720. 12.2(17d)SXB Support was added for the Supervisor Engine 2. 12.2(18)SXD Support for this command on the Cisco 7600 series routers was removed. 12.3BC This command was integrated into Cisco IOS Release 12.3BC for the Cisco uBR10012 router. 12.2(33)SCA This command is obsolete on the Cisco uBR10012 universal broadband router. Configuration Fundamentals Commands auto-sync CF-25 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco uBR10012 Universal Broadband Router By default, the system synchronizes all system files, which is the typical setting for most applications. However, you might want exclude certain files from synchronization for specialized applications. For example, if you have configured the active and standby PRE1 (or PRE2) modules to run different versions of Cisco IOS software, you might want to use different configuration files as well. In this case, you would not synchronize the startup configuration file. Examples Cisco 7600 Series Routers The following example shows how (from the default configuration) to enable automatic synchronization of the configuration register in the main CPU: Router# configure terminal Router (config)# redundancy Router (config-r)# main-cpu Router (config-r-mc)# no auto-sync standard Router (config-r-mc)# auto-sync config-register Cisco uBR10012 Universal Broadband Router The following example shows the system being configured to synchronize only the startup configuration file: router(config)# redundancy router(config-r)# main-cpu router(config-r-mc)# auto-sync startup-config router(config-r-mc)# exit router(config-r)# exit The following example shows how to configure the system to synchronize all system files except for the startup configuration file. This typically is done when the two PRE1 (or PRE2) modules are running different software images. router(config)# redundancy router(config-r)# main-cpu router(config-r-mc)# no auto-sync startup-config router(config-r-mc)# auto-sync config-register router(config-r-mc)# auto-sync bootvar router(config-r-mc)# exit router(config-r)# exit Related Commands Command Description redundancy Enters redundancy configuration mode. main-cpu Enters main CPU redundancy configuration mode. Configuration Fundamentals Commands autoupgrade disk-cleanup CF-26 Cisco IOS Configuration Fundamentals Command Reference April 2010 autoupgrade disk-cleanup To configure the Cisco IOS Auto-Upgrade Manager disk cleanup utility, use the autoupgrade disk-cleanup command in global configuration mode. To disable this configuration, use the no form of this command. autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable] no autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable] Syntax Description Command Default By default, the crashinfo files, the core files, and the Cisco IOS software images are deleted by the Cisco IOS Auto-Upgrade Manager disk cleanup utility, and the filesystems that support the undelete operation are not cleaned up. Command Modes Global configuration (config) Command History Examples The following example shows how to clean-up filesystems that support undelete operation: Router(config)# autoupgrade disk-cleanup irrecoverable The following example shows how to avoid deleting the Cisco IOS software images: Router(config)# no autoupgrade disk-cleanup image Related Commands crashinfo (Optional) Deletes crashinfo files during disk-cleanup before an image is downloaded. core (Optional) Deletes core files during disk-cleanup before an image is downloaded. image (Optional) Deletes the Cisco IOS images, except the default boot image and the current image, during disk-cleanup before an image is downloaded. irrecoverable (Optional) Deletes files irretrievably (in a file-system that supports the undelete operation) during disk-cleanup before an image is downloaded. Release Modification 12.4(15)T This command was introduced. Command Description autoupgrade ida url Configures the URL of the server on www.cisco.com where the image download requests will be sent by Auto-Upgrade Manager. autoupgrade status email Configures the address to which the status email is to be sent. upgrade automatic getversion Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server. Configuration Fundamentals Commands autoupgrade ida url CF-27 Cisco IOS Configuration Fundamentals Command Reference April 2010 autoupgrade ida url To configure the URL of the Intelligent Download Application (IDA) running on www.cisco.com, use the autoupgrade ida url command in global configuration mode. The router will send the image download requests to the configured URL. To disable this URL, use the no form of this command. autoupgrade ida url url no autoupgrade ida url url Syntax Description Command Default Default URL: https://www.cisco.com/cgi-bin/ida/locator/locator.pl Command Modes Global configuration (config) Command History Usage Guidelines Use the autoupgrade ida url command to configure a new URL for the IDA server, if it is not present in the default location. Examples The following example shows how to configure the URL for the IDA server: Router(config)# autoupgrade ida url https://www.cisco.com/cgi-bin/ida/locator/locator.pl Related Commands url URL of the IDA server. Release Modification 12.4(15)T This command was introduced. Command Description autoupgrade disk-cleanup Configures the Cisco IOS Auto-Upgrade Manager disk cleanup utility. autoupgrade status email Configures the address to which the status email is to be sent. upgrade automatic getversion Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server. Configuration Fundamentals Commands autoupgrade status email CF-28 Cisco IOS Configuration Fundamentals Command Reference April 2010 autoupgrade status email To configure the address to which status email is to be sent and the outgoing email server, use the autoupgrade status email command in global configuration mode. To disable status email, use the no form of this command. autoupgrade status email [recipient [email-address]] [smtp-server[smtp-server]] no autoupgrade status email [recipient [email-address]] [smtp-server[smtp-server]] Syntax Description Command Default Status email is not sent unless the address is configured. The recipient email address and SMTP server have to be configured in order to receive AUM status email. Command Modes Global configuration (config) Command History Usage Guidelines Use this command to configure the email-address where AUM status email can be sent. Examples The following example shows how to configure the address to which status email is to be sent: Router(config)# autoupgrade status email recipient tree@abc.com Router(config)# autoupgrade status email smtp-server smtpserver.abc.com Related Commands recipient The address to which the Cisco IOS Auto-Upgrade Manager (AUM) status is to be sent. smtp-server The outgoing email server to which the AUM email is sent. email-address The email address to which the AUM status is to be sent. Release Modification 12.4(15)T This command was introduced. Command Description autoupgrade disk-cleanup Configures the Cisco IOS Auto-Upgrade Manager disk cleanup utility. autoupgrade ida url Configures the URL of the server running on www.cisco.com to which the router sends the image download requests. upgrade automatic getversion Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server. Configuration Fundamentals Commands banner exec CF-29 Cisco IOS Configuration Fundamentals Command Reference April 2010 banner exec To specify and enable a message to be displayed when an EXEC process is created (an EXEC banner), use the banner exec command in global configuration mode. To delete the existing EXEC banner, use the no form of this command. banner exec d message d no banner exec Syntax Description Defaults Disabled (no EXEC banner is displayed). Command Modes Global configuration Command History Usage Guidelines This command specifies a message to be displayed when an EXEC process is created (a line is activated, or an incoming connection is made to a vty). Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. When a user connects to a router, the message-of-the-day (MOTD) banner appears first, followed by the login banner and prompts. After the user logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner. To disable the EXEC banner on a particular line or lines, use the no exec-banner line configuration command. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in Table 13. d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message. message Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 13. Release Modification 10.0 This command was introduced. 11.3(7.5)AA Token functionality was introduced. 12.0(3)T Token functionality was integrated into Cisco IOS Release 12.0(3)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands banner exec CF-30 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example sets an EXEC banner that uses tokens. The percent sign (%) is used as a delimiting character. Notice that the $(token) syntax is replaced by the corresponding configuration variable. Router(config)# banner exec % Enter TEXT message. End with the character '%'. Session activated on line $(line), $(line-desc). Enter commands at the prompt. % When a user logs on to the system, the following output is displayed: User Access Verification Username: joeuser Password: Session activated on line 50, vty default line. Enter commands at the prompt. Router> Related Commands Table 13 banner exec Tokens Token Information Displayed in the Banner $(hostname) Displays the host name for the router. $(domain) Displays the domain name for the router. $(line) Displays the vty or tty (asynchronous) line number. $(line-desc) Displays the description attached to the line. Command Description banner incoming Defines a customized banner to be displayed when there is an incoming connection to a terminal line from a host on the network. banner login Defines a customized banner to be displayed before the username and password login prompts. banner motd Defines a customized message-of-the-day banner. banner slip-ppp Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made. exec-banner Controls (enables or disables) the display of EXEC banners and message-of-the-day banners on a specified line or lines. Configuration Fundamentals Commands banner incoming CF-31 Cisco IOS Configuration Fundamentals Command Reference April 2010 banner incoming To define and enable a banner to be displayed when there is an incoming connection to a terminal line from a host on the network, use the banner incoming command in global configuration mode. To delete the incoming connection banner, use the no form of this command. banner incoming d message d no banner incoming Syntax Description Defaults Disabled (no incoming banner is displayed). Command Modes Global configuration Command History Usage Guidelines Follow the banner incoming command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. An incoming connection is one initiated from the network side of the router. Incoming connections are also called reverse Telnet sessions. These sessions can display MOTD banners and incoming banners, but they do not display EXEC banners. Use the no motd-banner line configuration command to disable the MOTD banner for reverse Telnet sessions on asynchronous lines. When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, before the login prompt. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner. Incoming banners cannot be suppressed. If you do not want the incoming banner to appear, you must delete it with the no banner incoming command. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in Table 14. d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message. message Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 14. Release Modification 10.0 This command was introduced. 11.3(7.5)AA Token functionality was introduced. 12.0(3)T Token functionality was integrated into Cisco IOS Release 12.0(3)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands banner incoming CF-32 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example sets an incoming connection banner. The pound sign (#) is used as a delimiting character. Router(config)# banner incoming # This is the Reuses router. # The following example sets an incoming connection banner that uses several tokens. The percent sign (%) is used as a delimiting character. darkstar(config)# banner incoming % Enter TEXT message. End with the character '%'. You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) % When the incoming connection banner is executed, the user will see the following banner. Notice that the $(token) syntax is replaced by the corresponding configuration variable. You have entered darkstar.ourdomain.com on line 5 (Dialin Modem) Related Commands Table 14 banner incoming Tokens Token Information Displayed in the Banner $(hostname) Displays the host name for the router. $(domain) Displays the domain name for the router. $(line) Displays the vty or tty (asynchronous) line number. $(line-desc) Displays the description attached to the line. Command Description banner exec Defines a customized banner to be displayed whenever the EXEC process is initiated. banner login Defines a customized banner to be displayed before the username and password login prompts. banner motd Defines a customized message-of-the-day banner. banner slip-ppp Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made. Configuration Fundamentals Commands banner login CF-33 Cisco IOS Configuration Fundamentals Command Reference April 2010 banner login To define and enable a customized banner to be displayed before the username and password login prompts, use the banner login command in global configuration mode. To disable the login banner, use no form of this command. banner login d message d no banner login Syntax Description Defaults Disabled (no login banner is displayed). Command Modes Global configuration Command History Usage Guidelines Follow the banner login command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first, followed by the login banner and prompts. After the user successfully logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in Table 15. d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message. message Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Tokens are described in Table 15. Release Modification 10.0 This command was introduced. 11.3(7.5)AA Token functionality was introduced. 12.0(3)T Token functionality was integrated into Cisco IOS Release 12.0(3)T. 12.2(14)SX This command was integrated into Cisco IOS Release 12.2(14)SX. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands banner login CF-34 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example sets a login banner. Double quotes (") are used as the delimiting character. Router# banner login " Access for authorized users only. Please enter your username and password. " The following example sets a login banner that uses several tokens. The percent sign (%) is used as the delimiting character. darkstar(config)# banner login % Enter TEXT message. End with the character '%'. You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) % When the login banner is executed, the user will see the following banner. Notice that the $(token) syntax is replaced by the corresponding configuration variable. You have entered darkstar.ourdomain.com on line 5 (Dialin Modem) Related Commands Table 15 banner login Tokens Token Information Displayed in the Banner $(hostname) Displays the host name for the router. $(domain) Displays the domain name for the router. $(line) Displays the vty or tty (asynchronous) line number. $(line-desc) Displays the description attached to the line. Command Description banner exec Defines a customized banner to be displayed whenever the EXEC process is initiated. banner incoming Defines a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network. banner motd Defines a customized message-of-the-day banner. banner slip-ppp Defines a customized banner to be displayed when a serial-line IP or point-to-point connection is made. Configuration Fundamentals Commands banner motd CF-35 Cisco IOS Configuration Fundamentals Command Reference April 2010 banner motd To define and enable a message-of-the-day (MOTD) banner, use the banner motd command in global configuration mode. To delete the MOTD banner, use the no form of this command. banner motd d message d no banner motd Syntax Description Defaults Disabled (no MOTD banner is displayed). Command Modes Global configuration Command History Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. This MOTD banner is displayed to all terminals connected and is useful for sending messages that affect all users (such as impending system shutdowns). Use the no exec-banner or no motd-banner command to disable the MOTD banner on a line. The no exec-banner command also disables the EXEC banner on the line. When a user connects to the router, the MOTD banner appears before the login prompt. After the user logs in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections, the router will display the EXEC banner. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described in Table 16. d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message. message Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Release Modification 10.0 This command was introduced. 11.3(7.5)AA Token functionality was introduced. 12.0(3)T Token functionality was integrated into Cisco IOS Release 12.0(3)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands banner motd CF-36 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example configures an MOTD banner. The pound sign (#) is used as a delimiting character. Router# banner motd # Building power will be off from 7:00 AM until 9:00 AM this coming Tuesday. # The following example configures an MOTD banner with a token. The percent sign (%) is used as a delimiting character. darkstar(config)# banner motd % Enter TEXT message. End with the character '%'. Notice: all routers in $(domain) will be upgraded beginning April 20 % When the MOTD banner is executed, the user will see the following. Notice that the $(token) syntax is replaced by the corresponding configuration variable. Notice: all routers in ourdomain.com will be upgraded beginning April 20 Related Commands Table 16 banner motd Tokens Token Information Displayed in the Banner $(hostname) Displays the host name for the router. $(domain) Displays the domain name for the router. $(line) Displays the vty or tty (asynchronous) line number. $(line-desc) Displays the description attached to the line. Command Description banner exec Defines and enables a customized banner to be displayed whenever the EXEC process is initiated. banner incoming Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network. banner login Defines and enables a customized banner to be displayed before the username and password login prompts. banner slip-ppp Defines and enables a customized banner to be displayed when a serial-line IP or point-to-point connection is made. exec-banner Controls (enables or disables) the display of EXEC banners and message-of-the-day banners on a specified line or lines. motd-banner Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines. Configuration Fundamentals Commands banner slip-ppp CF-37 Cisco IOS Configuration Fundamentals Command Reference April 2010 banner slip-ppp To customize the banner that is displayed when a Serial Line Internet Protocol (SLIP) or PPP connection is made, use the banner slip-ppp command in global configuration mode. To restore the default SLIP or PPP banner, use the no form of this command. banner slip-ppp d message d no banner slip-ppp Syntax Description Defaults The default SLIP or PPP banner message is: Entering encapsulation mode. Async interface address is unnumbered (Ethernet0) Your IP address is 10.000.0.0 MTU is 1500 bytes The banner message when using the service old-slip-prompt command is: Entering encapsulation mode. Your IP address is 10.100.0.0 MTU is 1500 bytes where encapsulation is SLIP or PPP. Command Modes Global configuration Command History Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. Use this command to define a custom SLIP or PPP connection message. This is useful when legacy client applications require a specialized connection string. To customize the banner, use tokens in the form $(token) in the message text. Tokens will display current Cisco IOS configuration variables, such as the routers host name, IP address, encapsulation type, and Maximum Transfer Unit (MTU) size. The banner tokens are described in Table 17. d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the banner message. message Message text. You can include tokens in the form $(token) in the message text. Tokens will be replaced with the corresponding configuration variable. Release Modification 12.0(3)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands banner slip-ppp CF-38 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example sets the SLIP/PPP banner using several tokens and the percent sign (%) as the delimiting character: Router(config)# banner slip-ppp % Enter TEXT message. End with the character '%'. Starting $(encap) connection from $(gate-ip) to $(peer-ip) using a maximum packet size of $(mtu) bytes... % The new SLIP/PPP banner will now be displayed when the slip EXEC command is used. Notice that the $(token) syntax is replaced by the corresponding configuration variable. Router# slip Starting SLIP connection from 172.16.69.96 to 192.168.1.200 using a maximum packet size of 1500 bytes... Related Commands Table 17 banner slip-ppp Tokens Token Information Displayed in the Banner $(hostname) Displays the host name of the router. $(domain) Displays the domain name of the router. $(peer-ip) Displays the IP address of the peer machine. $(gate-ip) Displays the IP address of the gateway machine. $(encap) Displays the encapsulation type (SLIP, PPP, and so on). $(encap-alt) Displays the encapsulation type as SL/IP instead of SLIP. $(mtu) Displays the MTU size. Command Description banner exec Defines and enables a customized banner to be displayed whenever the EXEC process is initiated. banner incoming Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network. banner motd Defines and enables a customized message-of-the-day banner. ppp Initiates a connection to a remote host using PPP. slip Initiates a connection to a remote host using SLIP. Configuration Fundamentals Commands boot CF-39 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot To boot the router manually, use the boot command in ROM monitor mode. The syntax of this command varies according to the platform and ROM monitor version. boot boot file-url boot filename [tftp-ip-address] boot flash [flash-fs:][partition-number:][filename] Cisco 7000 Series, 7200 Series, 7500 Series Routers boot flash-fs:[filename] Cisco 1600 and Cisco 3600 Series Routers boot [flash-fs:][partition-number:][filename] Cisco 1800 Series, 2800 Series, and 3800 Series Routers boot usbflash0[:filename] Syntax Description file-url URL of the image to boot (for example, boot tftp://172.16.15.112/routertest). filename When used in conjunction with the ip-address argument, the filename argument is the name of the system image file to boot from a network server. The filename is case sensitive. When used in conjunction with the flash keyword, the filename argument is the name of the system image file to boot from Flash memory. On all platforms except the Cisco 1600 series, Cisco 3600 series, and Cisco 7000 family routers, the system obtains the image file from internal Flash memory. On the Cisco 1600 series, Cisco 3600 series and Cisco 7000 family routers, the flash-fs: argument specifies the Flash memory device from which to obtain the system image. (See the flash-fs: argument later in this table for valid device values.) The filename is case sensitive. Without the filename argument, the first valid file in Flash memory is loaded. If the filename is not specified, the first file in the partition or file system is used. (A USB Flash uses the first image in (compact) Flash as the boot loader and loads the image from USB Flash.) tftp-ip-address (optional) IP address of the TFTP server on which the system image resides. If omitted, this value defaults to the IP broadcast address of 255.255.255.255. Configuration Fundamentals Commands boot CF-40 Cisco IOS Configuration Fundamentals Command Reference April 2010 Defaults For most platforms, if you enter the boot command and press Enter, the router boots from ROM by default. However, for some platforms, such as the Cisco 3600 series routers, if you enter the boot command and press Enter, the router boots the first image in Flash memory. Refer to the documentation for your platform for information about the default image. Command Modes ROM monitor Command History Usage Guidelines To determine which form of this command to use, refer to the documentation for your platform or use the CLI help (?) feature. Use this command only when your router cannot find the boot configuration information needed in NVRAM. To enter ROM monitor mode, use one of the following methods: • Enter the reload EXEC command, then press the Break key during the first 60 seconds of startup. • Set the configuration register bits 0 to 3 to zero (for example, set the configuration register to 0x0) and enter the reload command. flash Boots the router from Flash memory. Note that this keyword is required in some boot images. usbflash0 Boot the first file in USB Flash 0. If the optional filename argument is used, the router boots the specified image from USB Flash. Note This option uses the first image in (compact) Flash as the boot loader and loads the image from USB Flash. flash-fs: (Optional) Specifying the Flash file system is optional for all platforms except the Cisco 7500 series routers. Possible file systems are: • flash:—Internal Flash memory. • bootflash:—Internal Flash memory on the Cisco 7000 family. • slot0:—Flash memory card in the first PCMCIA slot on the Cisco 7000 family and Cisco 3600 series routers. • slot1:—Flash memory card in the second PCMCIA slot on the Cisco 7000 family and Cisco 3600 series routers. partition-number: (Optional) Specifies the partition number of the file system the file should be loaded from. This argument is not available on all platforms. If the partition-number is not specified, the first partition is used. Release Modification 10.3 The command was introduced. 12.3(14)T The usbflash0 keyword was added to support booting an image from an external USB Flash drive. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands boot CF-41 Cisco IOS Configuration Fundamentals Command Reference April 2010 The ROM Monitor prompt is either “>” or, for newer platforms, “rommon x>”. Enter only lowercase commands. These commands work only if there is a valid image to boot. Also, from the ROM monitor prompt, issuing a prior reset command is necessary for the boot to be consistently successful. In Cisco IOS Release 12.3(4)T, MONLIB was modified to search in media for a valid Cisco IOS image. This change prevents boot failures that result when the first file read in disk or flash is not a valid Cisco IOS image. Refer to your hardware documentation for information on correct jumper settings for your platform. Note For some platforms the flash keyword is now required. If your attempts to use the boot command are failing using the older boot flash:x:[filename] syntax, try using the boot flash flash:x:[filename] syntax. Examples In the following example, a router is manually booted from ROM: > boot F3: (ROM Monitor copyrights) In the following example, a router boots the file named routertest from a network server with the IP address 172.16.15.112 using the file-url syntax: > boot tftp://172.16.15.112/routertest F3 (ROM Monitor copyrights) The following example shows the boot flash command without the filename argument. The first valid file in Flash memory is loaded. > boot flash F3: 1858656+45204+166896 at 0x1000 Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes] F3: 1858676+45204+166896 at 0x1000 (ROM Monitor copyrights) The following example boots from Flash memory using the file named gs7-k: > boot flash gs7-k F3: 1858656+45204+166896 at 0x1000 Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR RRRRRRRRRRRRRR [OK - 1903912/13765276 bytes] F3: 1858676+45204+166896 at 0x1000 (ROM Monitor copyrights) In the following example, the boot flash flash: command boots the relocatable image file named igs-bpx-l from partition 2 in Flash memory: Configuration Fundamentals Commands boot CF-42 Cisco IOS Configuration Fundamentals Command Reference April 2010 > boot flash flash:2:igs-bpx-l F3: 3562264+98228+303632 at 0x30000B4 (ROM Monitor copyrights) In the following command, the Cisco 7000 family router accepts the flash keyword for compatibility but ignores it, and boots from slot 0: > boot flash slot0:gs7-k-mz.103-9 F3: 8468+3980384+165008 at 0x1000 In the following example, the command did not function because it must be entered in lowercase: rommon 10 > BOOT command “BOOT” not found The following example boots the first file in the first partition of internal Flash memory of a Cisco 3600 series router: > boot flash: The following example boots the first image file in the first partition of the Flash memory card in slot 0 of a Cisco 3600 series router: > boot slot0: The following example shows the ROM monitor booting the first file in the first Flash memory partition on a Cisco 1600 series router: > boot flash: Related Commands Command Description continue Returns to EXEC mode from ROM monitor mode by completing the boot process. Configuration Fundamentals Commands boot bootldr CF-43 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot bootldr To specify the location of the boot image that ROM uses for booting, use the boot bootldr command in global configuration mode. To remove this boot image specification, use the no form of this command. boot bootldr file-url no boot bootldr Syntax Description Defaults Refer to your platform documentation for the location of the default boot image. Command Modes Global configuration (config) Command History Usage Guidelines The boot bootldr command sets the BOOTLDR variable in the current running configuration. You must specify both the Flash file system and the filename. Note When you use this global configuration command, you affect only the running configuration. You must save the variable setting to your startup configuration to place the information under ROM monitor control and to have the variable function as expected. Use the copy system:running-config nvram:startup-config command to save the variable from your running configuration to your startup configuration. Note The default length of the bootstring filename is 64 characters. Depending on the platform a longer bootstring filename can be used and supported. The no form of the command sets the BOOTLDR variable to a null string. On the Cisco 7000 family routers, a null string causes the first image file in boot Flash memory to be used as the boot image that ROM uses for booting. Use the show boot command to display the current value for the BOOTLDR variable. Examples In the following example, the internal Flash memory contains the boot image: boot bootldr bootflash:boot-image file-url URL of the boot image on a Flash file system. Release Modification 11.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands boot bootldr CF-44 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following example specifies that the Flash memory card inserted in slot 0 contains the boot image: boot bootldr slot0:boot-image Related Commands Command Description copy system:running-config nvram:startup-config Copies any file from a source to a destination. show (flash file system) Displays the layout and contents of a Flash memory file system. show bootvar Displays the contents of the BOOT variable, the name of the configuration file pointed to by the CONFIG_FILE variable, the contents of the BOOTLDR variable, and the configuration register setting. Configuration Fundamentals Commands boot bootstrap CF-45 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot bootstrap To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap command in global configuration mode. To disable booting from a secondary bootstrap image, use the no form of this command. boot bootstrap file-url no boot bootstrap file-url boot bootstrap flash [filename] no boot bootstrap flash [filename] boot bootstrap [tftp] filename [ip-address] no boot bootstrap [tftp] filename [ip-address] Syntax Description Defaults No secondary bootstrap Command Modes Global configuration Command History Usage Guidelines The boot bootstrap command causes the router to load a secondary bootstrap image from the specied URL, such as from a remote server. After the bootstrap image is loaded, the bootstrap image loads the specified system image file. See the appropriate hardware installation guide for details on the setting the configuration register and secondary bootstrap filename. Use this command when you have attempted to load a system image but have run out of memory even after compressing the system image. Secondary bootstrap images allows you to load a larger system image through a smaller secondary image. file-url URL of the bootstrap image. flash Boots the router from Flash memory. filename (Optional with flash) Name of the system image to boot from a network server or from Flash memory. If you omit the filename when booting from Flash memory, the router uses the first system image stored in Flash memory. tftp (Optional) Boots the router from a system image stored on a TFTP server. ip-address (Optional) IP address of the TFTP server on which the system image resides. If omitted, this value defaults to the IP broadcast address of 255.255.255.255. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands boot bootstrap CF-46 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the system image file named sysimage-2 will be loaded by using a secondary bootstrap image: Router(config)# boot bootstrap bootflash:sysimage-2 Configuration Fundamentals Commands boot config CF-47 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot config To specify the device and filename of the configuration file from which the system configures itself during initialization (startup), use the boot config command in global configuration mode. To return to the default location for the configuration file, use the no form of this command. Platforms Other than Cisco 7600 Series Router boot config file-system-prefix:[directory/]filename [nvbypass] no boot config Cisco 7600 Series Router boot config device:filename [nvbypass] no boot config Syntax Description Command Default The default location for the configuration file is NVRAM (nvram:). Command Modes Global configuration (config) Command History Supported Platforms Other than Cisco 7600 Series Router This command is available only on Class A and Class B file system platforms. file-system-prefix: File system, followed by a colon (for example, nvram:, flash:, slot0:, usbflash[0-9]:, or usbtoken[0-9]:). The default is nvram:. directory/ (Optional) File system directory where the configuration file is located, followed by a forward slash (/). filename Name of the configuration file. device: Device identification, followed by a colon; see the “Usage Guidelines” section for a list of the valid values. nvbypass (Optional) Specifies that the distilled configuration is not written to nonvolatile random access memory (NVRAM). Release Modification 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(14)SX Support for this command was added for the Cisco 7600 Supervisor Engine 720. 12.2(17d)SXB Support for this command on the cisco 7600 Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 11.0 This command was introduced. 12.3(14)T Support for Class B file system platforms and the following file system prefix options were added: usbflash[0-9]: and usbtoken[0-9]:. Configuration Fundamentals Commands boot config CF-48 Cisco IOS Configuration Fundamentals Command Reference April 2010 You set the CONFIG_FILE environment variable in the current running memory when you use the boot config command. This variable specifies the configuration file used for initialization (startup). The configuration file must be an ASCII file located in either NVRAM or flash memory. Cisco 7600 Series Router The valid values for the device: argument and colon are as follows: • For systems that are configured with a Supervisor Engine 2, the valid values are bootflash:, const_nvram:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:. • For systems that are configured with a Supervisor Engine 720, the valid values are disk0: and disk1:. The configuration file must be an ASCII file that is located in the specified file system. The disk0: and disk1: keywords are for Class C file systems. The bootflash:, slot0:, and sup-bootflash: keywords are for Class A file systems. For Class A flash file systems, the CONFIG_FILE environment variable specifies the file system and filename of the configuration file to use for initialization (startup). You set the CONFIG_FILE environment variable in the current running memory when you use the boot config command. This variable specifies the configuration file used for initialization (startup). All Supported Platforms When you use the boot config command, you affect only the running configuration. You must save the environment variable setting to your startup configuration to place the information under ROM monitor control and to have the environment variable function as expected. Use the copy system:running-config nvram:startup-config command to save the environment variable from your running configuration to your startup configuration. The software displays an error message and does not update the CONFIG_FILE environment variable in the following situations: • You specify nvram: as the file system, and it contains only a distilled version of the configuration. (A distilled configuration is one that does not contain access lists.) • You specify a configuration file in the filename argument that does not exist or is not valid. The router uses the NVRAM configuration during initialization when the CONFIG_FILE environment variable does not exist or when it is null (such as at first-time startup). If the software detects a problem with NVRAM or the configuration it contains, the device enters setup mode. When you use the no form of this command, the router returns to using the default NVRAM configuration file as the startup configuration. You can display the contents of the BOOT, BOOTLDR, and the CONFIG_FILE environment variables using the show bootvar command. This command displays the settings for these variables as they exist in the startup configuration and in the running configuration if a running configuration setting differs from a startup configuration setting. When the boot config command is used, the distilled configuration is written into NVRAM and the system configuration is written into the file specified by the boot config command. If the distilled configuration exceeds the size of NVRAM, the system configuration gets truncated. Use the nvbypass keyword to prevent the system configuration from being truncated when the distilled configuration is larger than the size of NVRAM. Configuration Fundamentals Commands boot config CF-49 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to set the configuration file that is located in internal flash memory to configure itself during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload. Router(config)# boot config flash:router-config Router(config)# end Router# copy system:running-config nvram:startup-config The following example instructs a Cisco 7500 series router to use the configuration file named router-config located on the flash memory card inserted in the second Personal Computer Memory Card Industry Association (PCMCIA) slot of the Route Switch Processor (RSP) card during initialization. The third line copies the specification to the startup configuration, ensuring that this specification will take effect upon the next reload. Router (config)# boot config slot1:router-config Router (config)# end Router# copy system:running-config nvram:startup-config Related Commands Command Description copy system:running-config nvram:startup-config Saves the environment variable from the running configuration to the startup configuration. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. Configuration Fundamentals Commands boot host CF-50 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot host To specify the host-specific configuration file to be used at the next system startup, use the boot host command in global configuration mode. To restore the host configuration filename to the default, use the no form of this command. boot host remote-url no boot host remote-url Syntax Description Defaults If you do not specify a filename using this command, the router uses its configured host name to request a configuration file from a remote server. To form the configuration filename, the router converts its name to all lowercase letters, removes all domain information, and appends -confg or -config. Command Modes Global configuration Command History Usage Guidelines This command instructs the system to “Boot using host-specific configuration file x,” where x is the filename specified in the remote-url argument. In other words, this command specifies the remote location and filename of the host-specific configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file. Before using the boot host command, use the service config global configuration command to enable the loading of the specified configuration file at reboot time. Without this command, the router ignores the boot host command and uses the configuration information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service config command is enabled automatically. The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot network command to identify the network configuration file. The second is the host configuration file containing commands that apply to one network server in particular. Use the boot host command to identify the host configuration file. remote-url Location of the configuration file. Use the following syntax: • ftp:[[[//[username[:password]@]location]/directory]/filename] • rcp:[[[//[username@]location]/directory]/filename] • tftp:[[[//location]/directory]/filename] Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands boot host CF-51 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note Usually, the service config command is used in conjunction with the boot host or boot network command. You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active. If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg. Loading a Configuration File Using rcp The rcp software requires that a client send the remote username on each rcp request to the network server. If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username. When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list: 1. The username specified in the file-URL, if a username is specified. 2. The username set by the ip rcmd remote-username command, if the command is configured. 3. The router host name. Note An account for the username must be defined on the destination server. If the network administrator of the destination server did not establish an account for the username, this command will not execute successfully. Loading a Configuration File Using FTP The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory is associated with the username on the server. Refer to the documentation for your FTP server for more details. When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list: 1. The username specified in the boot host command, if a username is specified. 2. The username set by the ip ftp username command, if the command is configured. 3. Anonymous. The router sends the first valid password in the following list: 1. The password specified in the boot host command, if a password is specified. 2. The password set by the ip ftp password command, if the command is configured. Configuration Fundamentals Commands boot host CF-52 Cisco IOS Configuration Fundamentals Command Reference April 2010 3. The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router. Examples The following example sets the host filename to wilma-confg at address 192.168.7.19: Router(config)# boot host tftp://192.168.7.19/usr/local/tftpdir/wilma-confg Router(config)# service config Related Commands Command Description boot network Specifies the remote location and filename of the network configuration file to be used at the next system boot (startup). service config Enables autoloading of configuration files from a network server. Configuration Fundamentals Commands boot network CF-53 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot network To change the default name of the network configuration file from which to load configuration commands, use the boot network command in global configuration mode. To restore the network configuration filename to the default, use the no form of this command. boot network remote-url no boot network remote-url Syntax Description Defaults The default filename is network-config. Command Modes Global configuration Command History Usage Guidelines This command instructs the system to “Boot using network configuration file x,” where x is the filename specified in the remote-url argument. This command specifies the remote location and filename of the network configuration file to be used at the next system startup, as well as the protocol to be used to obtain the file. When booting from a network server, routers ignore routing information, static IP routes, and bridging information. As a result, intermediate routers are responsible for handling FTP, rcp, or TFTP requests. Before booting from a network server, verify that a server is available by using the ping command. Use the service config command to enable the loading of the specified configuration file at reboot time. Without this command, the router ignores the boot network command and uses the configuration information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service config command is enabled automatically. The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot network command to identify the network configuration file. The second is the host configuration file containing commands that apply to one network server in particular. Use the boot host command to identify the host configuration file. remote-url Location of the configuration file. Use the following syntax: • ftp:[[[//[username[:password]@]location]/directory]/filename] • rcp:[[[//[username@]location]/directory]/filename] • tftp:[[[//location]/directory]/filename] Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Configuration Fundamentals Commands boot network CF-54 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note Usually, the service config command is used in conjunction with the boot host or boot network command. You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active. If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg. Loading a Configuration File Using rcp The rcp software requires that a client send the remote username on each rcp request to the network server. If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the configuration files starting in the directory associated with the remote username. When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list: 1. The username specified in the file-URL, if a username is specified. 2. The username set by the ip rcmd remote-username command, if the command is configured. 3. The router host name. Note An account for the username must be defined on the destination server. If the network administrator of the destination server did not establish an account for the username, this command will not execute successfully. Loading a Configuration File Using FTP The FTP protocol requires a client to send a remote username and password on each FTP request to a server. The username and password must be associated with an account on the FTP server. If the server has a directory structure, the configuration file or image copied from the directory associated with the username on the server. Refer to the documentation for your FTP server for more details. When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid username in the following list: 1. The username specified in the boot network command, if a username is specified. 2. The username set by the ip ftp username command, if the command is configured. 3. Anonymous. The router sends the first valid password in the following list: 1. The password specified in the boot network command, if a password is specified. 2. The password set by the ip ftp password command, if the command is configured. Configuration Fundamentals Commands boot network CF-55 Cisco IOS Configuration Fundamentals Command Reference April 2010 3. The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router. Examples The following example changes the network configuration filename to bridge_9.1 and uses the default broadcast address: Router(config)# boot network tftp:bridge_9.1 Router(config)# service config The following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the network configuration file resides: Router(config)# service config Router(config)# boot network rcp://172.16.1.111/bridge_9.1 Related Commands Command Description boot host Specifies the remote location and filename of the host-specific configuration file to be used at the next system boot (startup). service config Enables autoloading of configuration files from a remote host. Configuration Fundamentals Commands boot system CF-56 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot system To specify the system image that the router loads at startup, use one of the following boot system command in global configuration mode. To remove the startup system image specification, use the no form of this command. Loading System Image from a URL or a TFTP File boot system {file-url | filename} no boot system {file-url | filename} Booting from a System Image in Internal Flash boot system flash [flash-fs:] [partition-number:] [filename] no boot system flash [flash-fs:] [partition-number:] [filename] Booting from a MOP Server boot system mop filename [mac-address] [interface] no boot system mop filename [mac-address] [interface] Booting from ROM boot system rom no boot system rom Booting a System Image from a Network, TFTP, or FTP Server boot system {rcp | tftp | ftp} filename [ip-address] no boot system {rcp | tftp | ftp} filename [ip-address] Syntax Description file-url The URL of the system image to load at system startup. filename The TFTP filename of the system image to load at system startup. flash On all platforms except the Cisco 1600 series, Cisco 3600 series, and Cisco 7000 family routers, this keyword boots the router from internal flash memory. If you omit all arguments that follow this keyword, the system searches internal Flash for the first bootable image. On the Cisco 1600 series, Cisco 3600 series, and Cisco 7000 family routers, this keyword boots the router from the flash system specified by the flash-fs: argument. On the Cisco 1600 series and Cisco 3600 series routers, if you omit all optional arguments, the router searches internal flash memory for the first bootable image. On the Cisco 7000 family routers, when you omit all arguments that follow this keyword, the system searches the Personal Computer Memory Card Industry Association (PCMCIA) slot 0 for the first bootable image. Configuration Fundamentals Commands boot system CF-57 Cisco IOS Configuration Fundamentals Command Reference April 2010 flash-fs: (Optional) Flash file system containing the system image to load at startup. The colon is required. Valid file systems are as follows: • flash:—Internal flash memory on the Cisco 1600 series and Cisco 3600 series routers. For the Cisco 1600 series and Cisco 3600 series routers, this file system is the default if you do not specify a file system. This is the only valid file system for the Cisco 1600 series. • bootflash:—Internal flash memory in the Cisco 7000 family. • slot0:—First PCMCIA slot on the Cisco 3600 series and Cisco 7000 family routers. For the Cisco 7000 family routers, this file system is the default if you do not specify a file system. • slot1:—Flash memory card in the second PCMCIA slot on the Cisco 3600 series and Cisco 7000 family routers. On the Cisco 2600 series routers, a file system should be specified. Otherwise, the router may attempt to load the Cisco IOS software twice with unexpected results. partition-number: (Optional) Number of the flash memory partition that contains the system image to boot, specified by the optional filename argument. If you do not specify a filename, the router loads the first valid file in the specified partition of flash memory. This argument is valid only on routers that can be partitioned. filename (Optional when used with the boot system flash command) Name of the system image to load at startup. This argument is case sensitive. If you do not specify a value for the filename argument, the router loads the first valid file in the following: • The specified flash file system • The specified partition of flash memory • The default flash file system if you also omitted the flash-fs: argument mop Boots the router from a system image stored on a DECNET Maintenance Operations Protocol (MOP) server. Do not use this keyword with the Cisco 3600 series or Cisco 7000 family routers. mac-address (Optional) MAC address of the MOP server containing the specified system image file. If you do not include the MAC address argument, the router sends a broadcast message to all MOP boot servers. The first MOP server to indicate that it has the specified file is the server from which the router gets the boot image. interface (Optional) Interface the router uses to send out MOP requests to the MOP server. The interface options are async, dialer, ethernet, serial, and tunnel. If you do not specify the interface argument, the router sends a request out on all interfaces that have MOP enabled. The interface that receives the first response is the interface the router uses to load the software. rom Boots the router from ROM. Do not use this keyword with the Cisco 3600 series or the Cisco 7000 family routers. rcp Boots the router from a system image stored on a network server using rcp. tftp Boots the router from a system image stored on a TFTP server. Configuration Fundamentals Commands boot system CF-58 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default If you configure the router to boot from a network server but do not specify a system image file with the boot system command, the router uses the configuration register settings to determine the default system image filename. The router forms the default boot filename by starting with the word cisco and then appending the octal equivalent of the boot field number in the configuration register, followed by a hyphen (-) and the processor type name (cisconn-cpu). Refer to the appropriate hardware installation guide for details on the configuration register and default filename. See also the config-register or confreg command. Command Modes Global configuration Command History Usage Guidelines For this command to work, the config-register command must be set properly. Enter several boot system commands to provide a fail-safe method for booting your router. The router stores and executes the boot system commands in the order in which you enter them in the configuration file. If you enter multiple boot commands of the same type—for example, if you enter two commands that instruct the router to boot from different network servers—then the router tries them in the order in which they appear in the configuration file. If a boot system command entry in the list specifies an invalid device, the router omits that entry. Use the boot system rom command to specify use of the ROM system image as a backup to other boot system commands in the configuration. For some platforms, the boot image must be loaded before the system image is loaded. However, on many platforms, the boot image is loaded only if the router is booting from a network server or if the flash file system is not specified. If the file system is specified, the router will boot faster because it need not load the boot image first. This section contains the following topics: • Changing the List of Boot System Commands • Booting Compressed Images • Understanding rcp • Understanding TFTP • Understanding FTP ftp Boots the router from a system image stored on an FTP server. ip-address (Optional) IP address of the server containing the system image file. If omitted, this value defaults to the IP broadcast address of 255.255.255.255. Release Modification 10.0 This command was introduced. 12.2(14)SX Support for this command was added for the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was integrated into Cisco IOS Release 12.2(31)SB. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. Configuration Fundamentals Commands boot system CF-59 Cisco IOS Configuration Fundamentals Command Reference April 2010 • Stopping Booting and Entering ROM Monitor Mode • Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes Changing the List of Boot System Commands To remove a single entry from the bootable image list, use the no form of the command with an argument. For example, to remove the entry that specifies a bootable image on a flash memory card inserted in the second slot, use the no boot system flash slot1:[filename] command. All other entries in the list remain. To eliminate all entries in the bootable image list, use the no boot system command. At this point, you can redefine the list of bootable images using the previous boot system commands. Remember to save your changes to your startup configuration by issuing the copy system:running-config nvram:startup-config command. Each time you write a new software image to flash memory, you must delete the existing filename in the configuration file with the no boot system flash filename command. Then add a new line in the configuration file with the boot system flash filename command. Note If you want to rearrange the order of the entries in the configuration file, you must first issue the no boot system command and then redefine the list. Booting Compressed Images You can boot the router from a compressed image on a network server. When a network server boots software, both the image being booted and the running image must be able to fit into memory. Use compressed images to ensure that enough memory is available to boot the router. You can compress a software image on any UNIX platform using the compress command. Refer to your UNIX platform’s documentation for the exact usage of the compress command. (You can also uncompress data with the UNIX uncompress command.) Understanding rcp The rcp requires that a client send the remote username in an rcp request to a server. When the router executes the boot system rcp command, the Cisco IOS software sends the hostname as both the remote and local usernames by default. Before the rcp can execute properly, an account must be defined on the network server for the remote username configured on the router. If the server has a directory structure, the rcp software searches for the system image to boot from the remote server relative to the directory of the remote username. By default, the router software sends the hostname as the remote username. You can override the default remote username by using the ip rcmd remote-username command. For example, if the system image resides in the home directory of a user on the server, you can specify that user’s name as the remote username. Understanding TFTP You need a TFTP server running to retrieve the router image from the host. Understanding FTP You need an FTP server running to retrieve the router image from the host. You also need an account on the server or anonymous file access to the server. Configuration Fundamentals Commands boot system CF-60 Cisco IOS Configuration Fundamentals Command Reference April 2010 Stopping Booting and Entering ROM Monitor Mode During the first 60 seconds of startup, you can force the router to stop booting by pressing the Break key. The router will enter ROM monitor mode, where you can change the configuration register value or boot the router manually. Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes For the Cisco 3600 series and Cisco 7000 family, the boot system command modifies the BOOT variable in the running configuration. The BOOT variable specifies a list of bootable images on various devices. Note When you use the boot system command on the Cisco 1600 series, Cisco 3600 series, Cisco 7000 family, and Cisco 7600 series, you affect only the running configuration. You must save the BOOT variable settings to your startup configuration to place the information under ROM monitor control and to have the variable function as expected. Use the copy system:running-config nvram:startup-config privileged EXEC command to save the variable from your running configuration to your startup configuration. To display the contents of the BOOT variable, use the show bootvar EXEC command. Examples The following example illustrates a configuration that specifies two possible internetwork locations for a system image, with the ROM software being used as a backup: Router(config)# boot system tftp://192.168.7.24/cs3-rx.90-1 Router(config)# boot system tftp://192.168.7.19/cs3-rx.83-2 Router(config)# boot system rom The following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of the flash device: Router(config)# boot system flash:2:igs-bpx-l The following example instructs the router to boot from an image located on the flash memory card inserted in slot 0: Router(config)# boot system slot0:new-config The following example specifies the file named new-ios-image as the system image for a Cisco 3600 series router to load at startup. This file is located in the fourth partition of the flash memory card in slot 0. Router(config)# boot system slot0:4:dirt/images/new-ios-image This example boots from the image file named c1600-y-l in partition 2 of flash memory of a Cisco 1600 series router: Router(config)# boot system flash:2:c1600-y-l Related Commands Command Description boot Boots the router manually. config-register Changes the configuration register settings. Configuration Fundamentals Commands boot system CF-61 Cisco IOS Configuration Fundamentals Command Reference April 2010 confreg Changes the configuration register settings while in ROM monitor mode. copy Copies any file from a source to a destination. copy system:running-config nvram:startup-config Copies the running configuration to the startup configuration. ip rcmd remote username Configures the remote username to be used when requesting a remote copy using rcp. show bootvar Displays the contents of the BOOT variable, the name of the configuration file pointed to by the CONFIG_FILE variable, the contents of the BOOTLDR variable, and the configuration register setting. Command Description Configuration Fundamentals Commands boot-end-marker CF-62 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot-end-marker The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software configuration files, are not CLI commands. These markers are written to configuration files automatically to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these markers allow the router to more reliably load Cisco IOS images during bootup. A boot statement is one or more lines in a configuration file that tells the router which software image to load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around any boot commands, including: • boot bootstrap • boot config • boot host • boot network • boot system Note, however, that these markers will always appear in the output of the show running-config or more system:running-config commands, regardless of whether any actual boot commands have been entered. This means that no boot commands will appear between the markers if no boot commands have been entered, or if all boot commands have been removed from the configuration, as shown in the “Examples” section. The boot-start-marker and boot-end-marker flags cannot be removed or modified using the CLI. These markers are written to the startup configuration file whenever a copy running-config startup-config command is issued. These flags were also introduced to circumvent errors in the configuration file, such as a leading space before a boot command (such as those sometimes introduced by manually edited configuration files), or the use of text strings that include the word “boot” in banners or other user-specified text. If the “boot start-marker” flag is not found in the configuration file, the system will use the traditional method to identify the boot commands. However, if you are manually creating configuration files, or copying from older Cisco IOS software releases, the addition of these markers is recommended. Command History Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file: Router# configure terminal Enter configuration commands, one per line. End with the end command. Router(config)# boot system slot0: Router(config)# end Router# copy running-config startup-config Router# show startup-config Using 1398 out of 129016 bytes ! Release Modification 12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B, The boot-start-marker and boot-end-marker flags were introduced. Configuration Fundamentals Commands boot-end-marker CF-63 Cisco IOS Configuration Fundamentals Command Reference April 2010 version 12.3 service timestamps debug uptime service timestamps log uptime no service password-encryption ! hostname C3660-2 ! boot-start-marker boot system slot0: boot-end-marker ! logging count . . . In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered: Router# show running-configuration Current configuration :3055 bytes ! ! No configuration change since last restart ! version 12.3 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption ! hostname Router ! boot-start-marker boot-end-marker ! . . . Related Commands Command Description boot bootstrap Specifies the filename and location of a secondary bootstrap image (to be used if a valid software image cannot be loaded). boot config Specifies the device and filename of the configuration file from which the router boots during startup (for Class A filesytems). boot host Specifies a remote host location for the host-specific (router-specific) configuration file to be used at the next system startup. boot network Specifies a remote location for the network (network-wide) configuration file to be used at the next system startup. boot system Specifies the system software image that the router loads at startup. Configuration Fundamentals Commands boot-start-marker CF-64 Cisco IOS Configuration Fundamentals Command Reference April 2010 boot-start-marker The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software configuration files, are not CLI commands. These markers are written to configuration files automatically to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these markers allow the router to more reliably load Cisco IOS images during bootup. A boot statement is one or more lines in a configuration file that tells the router which software image to load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around any boot commands, including: • boot bootstrap • boot config • boot host • boot network • boot system Note, however, that these markers will always appear in the output of the show running-config or more system:running-config commands, regardless of whether any actual boot commands have been entered. This means that no boot commands will appear between the markers if no boot commands have been entered, or if all boot commands have been removed from the configuration, as shown in the “Examples” section. The boot-start-marker and boot-end-marker flags cannot be removed or modified using the CLI. These markers are written to the startup configuration file whenever a copy running-config startup-config command is issued. These flags were also introduced to circumvent errors in the configuration file, such as a leading space before a boot command (such as those sometimes introduced by manually edited configuration files), or the use of text strings that include the word “boot” in banners or other user-specified text. If the “boot start-marker” flag is not found in the configuration file, the system will use the traditional method to identify the boot commands. However, if you are manually creating configuration files, or copying from older Cisco IOS software releases, the addition of these markers is recommended. Command History Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags are shown in the context of the startup configuration file: Router# configure terminal Enter configuration commands, one per line. End with the end command. Router(config)# boot system slot0: Router(config)# end Router# copy running-config startup-config Router# show startup-config Using 1398 out of 129016 bytes ! Release Modification 12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B The boot-start-marker and boot-end-marker flags were introduced. Configuration Fundamentals Commands boot-start-marker CF-65 Cisco IOS Configuration Fundamentals Command Reference April 2010 version 12.3 service timestamps debug uptime service timestamps log uptime no service password-encryption ! hostname C3660-2 ! boot-start-marker boot system slot0: boot-end-marker ! logging count . . . In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file even though no boot commands have been entered: Router# show running-configuration Current configuration :3055 bytes ! ! No configuration change since last restart ! version 12.3 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption ! hostname Router ! boot-start-marker boot-end-marker ! . . . Related Commands Command Description boot bootstrap Specifies the filename and location of a secondary bootstrap image (to be used if a valid software image cannot be loaded). boot config Specifies the device and filename of the configuration file from which the router boots during startup (for Class A filesytems). boot host Specifies a remote host location for the host-specific (router-specific) configuration file to be used at the next system startup. boot network Specifies a remote location for the network (network-wide) configuration file to be used at the next system startup. boot system Specifies the system software image that the router loads at startup. cd CF-66 Cisco IOS Configuration Fundamentals Command Reference April 2010 cd To change the default directory or file system, use the cd command in user EXEC or privileged EXEC mode. cd [filesystem:][directory] Syntax Description Defaults The initial default file system is flash:. For platforms that do not have a physical device named flash:, the keyword flash: is aliased to the default Flash device. For the Supervisor Engine, the initial default file system is disk0:. If you do not specify a directory on a file system, the default is the root directory on that file system. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The valid values for filesystem: are as follows: • For systems that are configured with a Supervisor Engine 2, valid values are bootflash:, const_nvram:, disk0:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:. • For systems that are configured with a Supervisor Engine 720, valid values are disk0: and disk1:. For all EXEC commands that have an optional filesystem argument, the system uses the file system specified by the cd command when you omit the optional filesystem argument. For example, the dir command, which displays a list of files on a file system, contains an optional filesystem argument. When you omit this argument, the system lists the files on the file system specified by the cd command. If you do not specify a directory on a file system, the default is the root directory on that file system. Examples In the following example, the cd command is used to set the default file system to the Flash memory card inserted in slot 0: Router# pwd filesystem: (Optional) The URL or alias of the directory or file systems followed by a colon. directory (Optional) Name of the directory. Release Modification 11.0 This command was introduced. 12.2(14)SX This command was integrated into Cisco IOS Release 12.2(14)SX, and support was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support was added for the Supervisor Engine 2. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. cd CF-67 Cisco IOS Configuration Fundamentals Command Reference April 2010 bootflash:/ Router# cd slot0: Router# pwd slot0:/ Cisco 7600 Series This example sets the default file system to the Flash PC card that is inserted in disk 0: Router# cd disk0: Router# pwd disk0:/ Related Commands Command Description copy Copies any file from a source to a destination. delete Deletes a file on a Flash memory device. dir Displays a list of files on a file system. mkdir disk0: Creates a new directory in a Flash file system. pwd Displays the current setting of the cd command. show file systems Lists available file systems and their alias prefix names. undelete Recovers a file marked “deleted” on a Class A or Class B Flash file system. clear archive log config CF-68 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear archive log config To purge the configuration logging database entries, use the clear archive log config command in privileged EXEC mode. clear archive log config [force | persistent] Syntax Description Command Default If this command is not used, the database entries accumulate in the archive log. Command Modes Privileged EXEC (#) Command History Usage Guidelines When the clear archive log config command is entered, only the entries in the configuration logging database file are deleted. The file itself is not deleted; it will be used in the future to log new entries as they occur. Examples The following example clears the database entries that have been saved to the config log without asking you to confirm the action before the entries are cleared: Router# clear archive log config force Related Commands force (Optional) Eliminates the confirm step before the contents of the archive log are cleared. persistent (Optional) Purges the configuration logging persistent-command database entries. Release Modification 12.2(33)SRA This command was introduced. 12.4(11)T This command was integrated into Cisco IOS Release 12.4(11)T. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. Command Description show archive log config all persistent Displays the persisted commands in configlet format. clear catalyst6000 traffic-meter CF-69 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear catalyst6000 traffic-meter To clear the traffic meter counters, use the clear catalyst6000 traffic-meter command in privileged EXEC mode. clear catalyst6000 traffic-meter Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes Privileged EXEC Command History Examples This example shows how to clear the traffic meter counters: Router# clear catalyst6000 traffic-meter Router# Release Modification 12.2(17a)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. clear configuration lock CF-70 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear configuration lock To clear the lock on the running configuration file, use the clear configuration lock command in privileged EXEC mode. clear configuration lock Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Examples The following is sample output from the clear configuration lock command when the running configuration file is not locked by the configure replace command: Router# clear configuration lock Parser Config not locked. The following is sample output from the clear configuration lock command when the running configuration file is locked by the configure replace command: Router# clear configuration lock Process <3> is holding the EXCLUSIVE lock ! Do you want to clear the lock?[confirm] y The following example shows how to use the clear configuration lock command to display the owner or process ID of the lock and prompt the user for confirmation: Router# clear configuration lock Process <46> is holding the EXCLUSIVE lock. Do you want to clear the lock?[confirm] y After the lock is cleared, a message will be sent to the terminal if the owner of the lock is a TTY user: Router(config)# The configuration lock was cleared by user from terminal <5> Release Modification 12.2(25)S This command was introduced. 12.3(14)T This command was enhanced to allow the exclusive configuration lock to be cleared during erratic or abnormal behavior. 12.0(31)S This command was integrated into Cisco IOS Release 12.0(31)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(31)SXH. clear configuration lock CF-71 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description configuration mode exclusive Enables single-user (exclusive) access functionality for the Cisco IOS CLI. debug configuration lock Enables debugging of the Cisco IOS configuration lock. show configuration lock Displays information about the lock status of the running configuration file during a configuration replace operation. clear ip http client cache CF-72 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear ip http client cache To remove information from the HTTP client cache, use the clear ip http client cache command in privileged EXEC mode. clear ip http client cache {all | session session-name | url complete-url} Syntax Description Command Default None Command Modes Privileged EXEC Command History Usage Guidelines Use this command to clear entries from the HTTP client cache pool: all the entries, all the entries owned by a specific session, or only the entry associated with a specific request from an HTTP server. Examples The following example clears all entries in the HTTP client cache: Router# clear ip http client cache all The following example removes HTTP client cache entries that belong to the HTTP Client File System (CFS) application: Router# clear ip http client cache session HTTP CFS The following example removes HTTP client cache entries at the location http://myrouter.cisco.com/flash:/: Router# clear ip http client cache url http://myrouter.cisco.com/flash:/ Related Commands cache all Removes all HTTP client cache entries. cache session session-name Removes HTTP client cache entries of the HTTP client application session specified by the session-name argument. cache url complete-url Removes the HTTP client cache entry whose location is specified by the complete-url argument, a Cisco IOS File System (IFS) Uniform Resource Locator (URL), and that consists of HTML files used by an HTTP server. Release Modification 12.2(31)SB2 This command was introduced. Command Description ip http path Specifies the base path used to locate files for use by the HTTP server. show ip http client Displays a report about the HTTP client. clear logging CF-73 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear logging To clear messages from the logging buffer, use the clear logging command in privileged EXEC mode. clear logging Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Examples In the following example, the logging buffer is cleared: Router# clear logging Clear logging buffer [confirm] Router# Related Commands Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description logging buffered Logs messages to an internal buffer. show logging Displays the state of logging (syslog). clear logging system CF-74 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear logging system To clear event records stored in the System Event Archive (SEA) log file sea_log.dat, use the clear logging system command in user EXEC mode. clear logging system [disk name] Syntax Description Command Default This command has no default settings. Command Modes User EXEC (>) Command History Usage Guidelines SEA is supported on switches that have a Supervisor Engine 32 or Supervisor Engine 720 with a compact flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine 720). Cisco Universal Broadband Router 10012 The SEA feature is used to address debug trace and system console constraints. SEA is a logging feature that allows the modules in the system to report major and critical events to the route processor (RP). The events occurring on the line card or jacket card are also sent to the RP using Inter-Process Communication (IPC) capability. Use the clear logging system command to clear the event records stored in the SEA log file. Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in compact flash adapter for PRE2. Examples This example shows how to clear the SEA: Router# clear logging system Clear logging system operation will take a while. Do you want to continue? [no]: yes Router# Related Commands disk name (Optional) Stores the system event log in the specified disk. Release Modification 12.2(33)SXH This command was introduced. 12.2(33)SCC This command was introduced for the Cisco uBR10012 router in the Cisco IOS Software Release 12.2(33)SCC. copy logging system Copies the archived system events to another location. clear logging system CF-75 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging system Enables or disables the SEA logging system. show logging system Displays the SEA logging system disk. clear logging xml CF-76 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear logging xml To clear the contents of the XML system message logging (syslog) buffer, use the clear logging xml command in User EXEC or Priviledged EXEC mode.. clear logging xml Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines This command clears the contents of the XML-formatted logging buffer, but does not clear the contents of the standard logging buffer. The system will prompt you to confirm the action before clearing the buffer. Examples In the following example, the XML-specific buffer is cleared: Router# clear logging xml Clear XML logging buffer [confirm]?y Related Commands Release Modification 12.2(15)T This command was introduced. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRE This command was integrated into Cisco IOS Release 12.2(33)SRE . Command Description logging buffered xml Enables system message logging (syslog) to the XML-specific buffer in XML format. show logging xml Displays the state of XML-formatted system message logging, followed by the contents of the XML-specific buffer. clear mls statistics CF-77 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear mls statistics To reset the Multilayer Switching (MLS) statistics counters, use the clear mls statistics command in privileged EXEC mode. clear mls statistics [module num] Syntax Description Defaults This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines This command replaces the clear mls stats command, which was introduced on the Supervisor Engine 720 in Cisco IOS Release 12.2(17a)SX, and on the Supervisor Engine 2 in Cisco IOS Release 12.2(17d)SXB. Examples This example shows how to reset the MLS statistics counters for all modules: Router# clear mls statistics Router# This example shows how to reset the MLS statistics counters for a specific module: Router# clear mls statistics module 5 Router# Related Commands module num (Optional) Specifies the module number. Release Modification 12.2(17d)SXB1 This command was introduced on the Supervisor Engine 720 and the Supervisor Engine 2. 12.2(17d)SXB5 The module num keyword and argument pair were added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show mls statistics Displays the MLS statistics for the IP, IPX, multicast, Layer 2 protocol, and QoS. clear parser cache CF-78 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear parser cache To clear the parse cache entries and hit/miss statistics stored for the Parser Cache feature, use the clear parser cache command in privileged EXEC mode. clear parser cache Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes Privileged EXEC Command History Usage Guidelines The Parser Cache feature optimizes the parsing (translation and execution) of Cisco IOS software configuration command lines by remembering how to parse recently encountered command lines, decreasing the time required to process large configuration files. The clear parser cache command will free the system memory used by the Parser Cache feature and will erase the hit/miss statistics stored for the output of the show parser statistics EXEC command. This command is only effective when the Parser Cache feature is enabled. Examples The following example shows the clearing of the parser cache: Router# show parser statistics Last configuration file parsed:Number of Commands:1484, Time:820 ms Parser cache:enabled, 1460 hits, 26 misses Router# clear parser cache Router# show parser statistics Last configuration file parsed:Number of Commands:1484, Time:820 ms Parser cache:enabled, 0 hits, 1 misses Related Commands Release Modification 12.1(5)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description parser cache Enables or disables the Parser Cache feature. show parser statistics Displays statistics about the last configuration file parsed and the status of the Parser Cache feature. clear platform netint CF-79 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear platform netint To clear the interrupt-throttling counters for the platform, use the clear platform netint command in privileged EXEC mode. clear platform netint Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes Privileged EXEC Command History Examples This example shows how to clear the interrupt-throttling counters for the platform: Router# clear platform netint Router# Related Commands Release Modification 12.2(17b)SXA Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show platform netint Displays the platform network-interrupt information. clear processes interrupt mask CF-80 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear processes interrupt mask To clear interrupt mask details for all processes in the interrupt mask buffer, use the clear processes interrupt mask detail command in privileged EXEC mode. clear processes interrupt mask detail Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines See the documentation of the scheduler interrupt mask commands (listed in the Related Commands table) for further details on process interrupt mask profiling. Examples The following example demonstrates how to the clear interrupt mask statistics from system memory for all processes: Router# clear processes interrupt mask detail Related Commands Release Modification 12.4(2)T This command was introduced as part of the Process Interrupt Mask Profiler Enhancement feature. Command Description scheduler interrupt mask profile Starts interrupt mask profiling for all processes running on the system scheduler interrupt mask size Configures the maximum number of entries that can exist in the interrupt mask buffer. scheduler interrupt mask time Configures the maximum time that a process can run with interrupts masked. show process interrupt mask buffer Displays the information stored in the interrupt mask buffer. show processes interrupt mask detail Displays interrupt masked details for the specified processes or all processes in the system. clear tcp CF-81 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear tcp To clear a TCP connection, use the clear tcp command in privileged EXEC mode. clear tcp {line line-number | local hostname port remote hostname port | tcb address} Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines The clear tcp command is particularly useful for clearing hung TCP connections. The clear tcp line line-number command terminates the TCP connection on the specified tty line. Additionally, all TCP sessions initiated from that tty line are terminated. The clear tcp local hostname port remote hostname port command terminates the specific TCP connection identified by the host name and port pair of the local and remote router. The clear tcp tcb address command terminates the specific TCP connection identified by the TCB address. Examples The following example clears a TCP connection using its tty line number. The show tcp command displays the line number (tty2) that is used in the clear tcp command. Router# show tcp tty2, virtual tty from host router20.cisco.com Connection state is ESTAB, I/O status: 1, unread input bytes: 0 Local host: 171.69.233.7, Local port: 23 Foreign host: 171.69.61.75, Foreign port: 1058 Enqueued packets for retransmit: 0, input: 0, saved: 0 Event Timers (current time is 0x36144): Timer Starts Wakeups Next Retrans 4 0 0x0 TimeWait 0 0 0x0 AckHold 7 4 0x0 SendWnd 0 0 0x0 KeepAlive 0 0 0x0 GiveUp 0 0 0x0 line line-number Line number of the TCP connection to clear. local hostname port remote hostname port Host name of the local router and port and host name of the remote router and port of the TCP connection to clear. tcb address Transmission Control Block (TCB) address of the TCP connection to clear. The TCB address is an internal identifier for the endpoint. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. clear tcp CF-82 Cisco IOS Configuration Fundamentals Command Reference April 2010 PmtuAger 0 0 0x0 iss: 4151109680 snduna: 4151109752 sndnxt: 4151109752 sndwnd: 24576 irs: 1249472001 rcvnxt: 1249472032 rcvwnd: 4258 delrcvwnd: 30 SRTT: 710 ms, RTTO: 4442 ms, RTV: 1511 ms, KRTT: 0 ms minRTT: 0 ms, maxRTT: 300 ms, ACK hold: 300 ms Router# clear tcp line 2 [confirm] [OK] The following example clears a TCP connection by specifying its local router host name and port and its remote router host name and port. The show tcp brief command displays the local (Local Address) and remote (Foreign Address) host names and ports to use in the clear tcp command. Router# show tcp brief TCB Local Address Foreign Address (state) 60A34E9C router1.cisco.com.23 router20.cisco.1055 ESTAB Router# clear tcp local router1 23 remote router20 1055 [confirm] [OK] The following example clears a TCP connection using its TCB address. The show tcp brief command displays the TCB address to use in the clear tcp command. Router# show tcp brief TCB Local Address Foreign Address (state) 60B75E48 router1.cisco.com.23 router20.cisco.1054 ESTAB Router# clear tcp tcb 60B75E48 [confirm] [OK] Related Commands Command Description show tcp Displays the status of TCP connections. show tcp brief Displays a concise description of TCP connection endpoints. clear vlan counters CF-83 Cisco IOS Configuration Fundamentals Command Reference April 2010 clear vlan counters To clear the software-cached counter values to start from zero again for a specified VLAN or all existing VLANs, use the clear vlan counters command in privileged EXEC mode. clear vlan [vlan-id] counters Syntax Description Defaults This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines If you do not specify a vlan-id; the software-cached counter values for all existing VLANs are cleared. Examples This example shows how to clear the software-cached counter values for a specific VLAN: Router# clear vlan 10 counters Clear "show vlan" counters on this vlan [confirm]y Router# Related Commands vlan-id (Optional) The ID of a specific VLAN. Range: 1 to 4094. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show vlan counters Displays the software-cached counter values. clock CF-84 Cisco IOS Configuration Fundamentals Command Reference April 2010 clock To configure the port clocking mode for the 1000BASE-T transceivers, use the clock command in interface configuration mode. To return to the default settings,use the no form of this command. clock {auto | active [prefer] | passive [prefer]} no clock Syntax Description Defaults auto Command Modes Interface configuration Command History Usage Guidelines This command is supported on the 1000BASE-T transceivers only. If the clock mode of the near end of a link does not match the clock mode of the far end, the line protocol does not come up. The active and passive clock status is determined during the auto negotiation process before the transmission link is established. The clock command supports the following configurations: • auto—Auto negotiates with the far end of the link but preference is given to the active-clock switch. • active—Uses a local clock to determine transmitter-operation timing. • passive—Recovers the clock from the received signal and uses the recovered clock to determine transmitter-operation timing. • active prefer—Auto negotiates with the far end of the link but preference is given to the active-clock switch. • passive prefer—Auto negotiates with the far end of the link but preference is given to the passive-clock switch. Enter the show running-config interface command to display the current clock mode. Enter the show interfaces command to display the clock mode that is negotiated by the firmware. auto Enables the automatic-clock configuration. active Enables the active operation. prefer (Optional) Negotiates the specified mode with the far end of the link. passive Enables the passive operation. Release Modification 12.2(17a)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. clock CF-85 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to enable the active-clock operation: Router(config-if)# clock active Router(config-if)# Related Commands Command Description show interfaces Displays traffic that is seen by a specific interface. show running-config interface Displays the status and configuration of the module or Layer 2 VLAN. clock initialize nvram CF-86 Cisco IOS Configuration Fundamentals Command Reference April 2010 clock initialize nvram To restart the system clock from the last known system clock value, use the clock initialize nvram command in global configuration mode. To disable the restart of the system clock from the last known system clock value, use the no form of this command. clock initialize nvram no clock initialize nvram Syntax Description This command has no arguments or keywords. Command Default By default, the system clock is set to restart from the last known system clock value for platforms that have no hardware calendar. Command Modes Global configuration (config) Command History Usage Guidelines For platforms that have hardware calendars, the clock initialize nvram command is not available. When the no form of the command is configured, the system clock gets initialized to default standard values. The default values can be either 1MAR1993 or 1MAR2002. Examples The following example shows how to set the system clock to restart from the last known system clock value: Router(config)# clock initialize nvram Release Modification 12.3(4)T This command was introduced. config-register CF-87 Cisco IOS Configuration Fundamentals Command Reference April 2010 config-register To change the configuration register settings, use the config-register command in global configuration mode. config-register value Syntax Description Command Default Refer to the documentation for your platform for the default configuration register value. For many newer platforms, the default is 0x2102, which causes the router to boot from Flash memory and the Break key to be ignored. Command Modes Global configuration Command History Usage Guidelines This command applies only to platforms that use a software configuration register. The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network. To change the boot field value and leave all other bits set to their default values, follow these guidelines: • If you set the configuration register boot field value to 0x0, you must boot the operating system manually with the boot command. • If you set the configuration register boot field value to 0x1, the router boots using the default ROM software. • If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot field value to form a default boot filename for booting from a network server. For more information about the configuration register bit settings and default filenames, refer to the appropriate router hardware installation guide. Note In a virtual switch application, If you have configured your config-register with a value that would skip file parsing during the bootup process, your change to either a standalone or virtual switch will not take place until you reconfigure your config-register. The config-register must be allowed to parse files in order to ensure the conversion from either a standalone or virtual switch. value Hexadecimal or decimal value that represents the 16-bit configuration register value that you want to use the next time the router is restarted. The value range is from 0x0 to 0xFFFF (0 to 65535 in decimal). Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was integrated into Cisco IOS Release 12.2(31)SB2. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(31)SXH. config-register CF-88 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the configuration register is set to boot the system image from Flash memory: config-register 0x2102 Related Commands Command Description boot system Specifies the system image that the router loads at startup. confreg Changes the configuration register settings while in ROM monitor mode. o Lists the value of the boot field (bits 0 to 3) in the configuration register. show version Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images. configuration mode exclusive CF-89 Cisco IOS Configuration Fundamentals Command Reference April 2010 configuration mode exclusive To enable single-user (exclusive) access functionality for the Cisco IOS command-line interface (CLI), use the configuration mode exclusive command in global configuration mode. To disable the single-user access (configuration locking) feature, use the no form of this command. Syntax for Releases 12.3T/12.2S: configuration mode exclusive {auto | manual} no configuration mode exclusive {auto | manual} Syntax for Release 12.0(31)S, 12.2(33)SRA, and Later Releases: configuration mode exclusive {auto | manual} [expire seconds] [lock-show] [interleave] [terminate] [config_wait seconds] [retry_wait seconds] Syntax Description auto Automatically limits configuration to single-user mode. manual Allows you to manually limit the configuration file to single-user mode. expire seconds (Optional) Specifies the number of seconds in which the configuration lock is released after the user stops making configuration changes. lock-show (Optional) Gives priority to configuration commands being executed from the exclusive configuration session, and prevents the execution of show commands. interleave (Optional) Allows show commands from sessions that are not holding the configuration lock to be executed when the user in the session holding the configuration lock is not making configuration changes. Note If you entered lock-show, you should enter this keyword. terminate (Optional) Causes the configuration command executed from the exclusive configuration session to terminate show and clear commands being executed in other sessions. config_wait seconds (Optional) Amount of time, in seconds, that a configuration command entered by a user in single user mode waits for show commands entered by other users to finish being executed. If the show command is still being executed when the timer expires and if the terminate option is set, the configuration command terminates the show command. If the configuration command completes execution before the specified number of seconds, the show command begins execution. retry_wait seconds (Optional) Specifies the amount of time, in seconds, that show and clear EXEC commands will wait for a configuration command entered by a user in exclusive configuration mode to complete execution. If the configuration command is still being executed when the specified amount of time has passed, the EXEC commands generate an error message and are terminated. If execution of the configuration command is completed before the specified number of seconds, the EXEC commands are executed. configuration mode exclusive CF-90 Cisco IOS Configuration Fundamentals Command Reference April 2010 Defaults Single-user mode is disabled. Command Modes Global configuration Command History Usage Guidelines The configuration mode exclusive command enables the exclusive configuration lock feature. The exclusive configuration lock allows single-user access to configuration modes using single-user configuration mode. While the device configuration is locked, no other users can enter configuration commands. Users accessing the device using the state-full, session-based transports (telnet, SSH) are able to enter single-user configuration mode. The user enters single-user configuration mode by acquiring the exclusive configuration lock using the configure terminal lock privileged EXEC mode command. The configuration lock is released when the user exits configuration mode by using the end or exit command, or by pressing Ctrl-Z. While a user is in single-user configuration mode, no other users can configure the device. Users accessing CLI options through stateless protocols (that is, the HTTP web-based user interface) cannot access single-user configuration mode. (However, an API allows the stateless transports to lock the configuration mode, complete its operations, and release the lock.) Examples The following example shows how to configure the configuration file for single-user autoconfiguration mode by using the configuration mode exclusive auto command. Use the configuration terminal command to enter global configuration mode and lock the configuration mode exclusively. After the Cisco IOS configuration mode is locked exclusively, you can verify this configuration by entering the show configuration lock command. Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# configuration mode exclusive auto Router(config)# end Router# show running-configuration | include config Building configuration... Current configuration : 2296 bytes configuration mode exclusive auto <========== auto policy Router# Router# configure terminal ? <======== lock option not displayed when in auto policy Router# configure terminal <======= acquires the lock Release Modification 12.3(14)T This command was introduced. 12.0(31)S This command was integrated into Cisco IOS Release 12.0(31)S. The following keywords were added: expire, lock-show, interleave, terminate, config_wait, and retry_wait. New functionality was added, including Access Session Locking. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. configuration mode exclusive CF-91 Cisco IOS Configuration Fundamentals Command Reference April 2010 The configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode by entering end or exit. Enter configuration commands, one per line. End with CNTL/Z. Router(config)# Router(config)# show configuration lock Parser Configure Lock --------------------- Owner PID : 3 User : unknown TTY : 0 Type : EXCLUSIVE State : LOCKED Class : EXPOSED Count : 1 Pending Requests : 0 User debug info : configure terminal Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 6 Lock Expiration timer (in Sec) : 593 Router(config)# Router(config)# end <========= releases the lock Router# Router# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 User debug info : Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 0 Lock Expiration timer (in Sec) : 0 Router# The following example shows how to enable the exclusive locking feature in manual mode by using the configuration mode exclusive manual command. Once you have configured manual exclusive mode, you can lock the configuration mode by using the configure terminal lock command. In this mode, the configure terminal command does not automatically lock the parser configuration mode. The lock is cleared after you exit from configuration mode by entering end or exit. Router# Router# configure terminal Configuration mode locked exclusively. The lock will be cleared once you exit out of configuration mode using end/exit configuration mode exclusive CF-92 Cisco IOS Configuration Fundamentals Command Reference April 2010 Enter configuration commands, one per line. End with CNTL/Z. Router(config)# Router(config)# configuration mode exclusive manual Router(config)# end Router# Router# show running-configuration | include configuration Building configuration... Current configuration : 2298 bytes configuration mode exclusive manual <==== 'manual' policy Router# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 User debug info : Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 0 Lock Expiration timer (in Sec) : 0 Router# Router# configure terminal ? lock Lock configuration mode <========= 'lock' option displayed in 'manual' policy Router# configure terminal <============ ‘configure terminal’ won't acquire lock automatically Enter configuration commands, one per line. End with CNTL/Z. Router(config)# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 User debug info : Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 0 Lock Expiration timer (in Sec) : 0 Router(config)# end Router# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 configuration mode exclusive CF-93 Cisco IOS Configuration Fundamentals Command Reference April 2010 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 User debug info : Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 0 Lock Expiration timer (in Sec) : 0 Router# Router# configure Router# configure terminal Router# configure terminal ? lock Lock configuration mode <======= 'lock' option displayed when in 'manual' policy Router# configure terminal lock Router# configure terminal lock <============ acquires exclusive configuration lock Configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode by entering the end or exit command. Enter configuration commands, one per line. End with CNTL/Z. Router(config)# Router(config)# show configuration lock Parser Configure Lock --------------------- Owner PID : 3 User : unknown TTY : 0 Type : EXCLUSIVE State : LOCKED Class : EXPOSED Count : 1 Pending Requests : 0 User debug info : configure terminal lock Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 5 Lock Expiration timer (in Sec) : 594 Router(config)# end <================ 'end' releases exclusive configuration lock Router# Router# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 configuration mode exclusive CF-94 Cisco IOS Configuration Fundamentals Command Reference April 2010 User debug info : Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 0 Lock Expiration timer (in Sec) : 0 Router# Related Commands Command Description configure terminal Enters global configuration mode. debug configuration lock Enables debugging of the Cisco IOS configuration lock. show configuration lock Displays information about the lock status of the running configuration file during a configuration replace operation. configure confirm CF-95 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure confirm To confirm replacement of the current running configuration with a saved Cisco IOS configuration file, use the configure confirm command in privileged EXEC mode. configure confirm Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC (#) Command History Usage Guidelines The configure confirm command is used only if the time seconds keyword and argument of the configure replace command are specified. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command). Examples The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file: Router# configure replace nvram:startup-config time 120 This will apply all necessary additions and deletions to replace the current running configuration with the contents of the specified configuration file, which is assumed to be a complete configuration, not a partial configuration. Enter Y if you are sure you want to proceed. ? [no]: Y Total number of passes: 1 Rollback Done Router# configure confirm Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2SR. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2SX. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. configure confirm CF-96 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path (config-archive) Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. configure memory CF-97 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure memory To configure the system from the system memory, use the configure memory command in privileged EXEC mode. configure memory Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines On all platforms except Class A Flash file system platforms, this command executes the commands located in the configuration file in NVRAM (the “startup configuration file”). On Class A Flash file system platforms, if you specify the configure memory command, the router executes the commands pointed to by the CONFIG_FILE environment variable. The CONFIG_FILE environment variable specifies the location of the configuration file that the router uses to configure itself during initialization. The file can be located in NVRAM or any of the Flash file systems supported by the platform. When the CONFIG_FILE environment variable specifies NVRAM, the router executes the NVRAM configuration only if it is an entire configuration, not a distilled version. A distilled configuration is one that does not contain access lists. To view the contents of the CONFIG_FILE environment variable, use the show bootvar EXEC command. To modify the CONFIG_FILE environment variable, use the boot config command and then save your changes by issuing the copy system:running-config nvram:startup-config command. Examples In the following example, a router is configured from the configuration file in the memory location pointed to by the CONFIG_FILE environment variable: Router# configure memory Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). configure memory CF-98 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy system:running-config nvram:startup-config Saves the running configuration as the startup configuration file. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. Command Description configure network CF-99 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure network The configure network command was replaced by the copy {rcp | tftp} running-config command in Cisco IOS Release 11.0. To maintain backward compatibility, the configure network command continues to function in Cisco IOS Release 12.2(11)T for most systems, but support for this command may be removed in a future release. The copy {rcp | tftp} running-config command was replaced by the copy {ftp: | rcp: | tftp:}[filename] system:running-config command in Cisco IOS Release 12.1. The copy {ftp: | rcp: | tftp:}[filename] system:running-config command specifies that a configuration file should be copied from a FTP, rcp, or TFTP source to the running configuration. See the description of the copy command in this chapter for more information. configure overwrite-network CF-100 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure overwrite-network The configure overwrite-network has been replaced by the copy {ftp-url | rcp-url | tftp-url} nvram:startup-config command. See the description of the copy command in the “Cisco IOS File System Commands” chapter for more information. configure replace CF-101 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure replace To replace the current running configuration with a saved Cisco IOS configuration file, use the configure replace command in privileged EXEC mode. configure replace target-url [nolock] [list] [force] [ignorecase] [revert trigger [error] [timer minutes] | time minutes] Syntax Description Command Modes Privileged EXEC (#) Command History target-url URL (accessible by the Cisco IOS file system) of the saved Cisco IOS configuration file that is to replace the current running configuration. nolock (Optional) Disables the locking of the running configuration file that prevents other users from changing the running configuration during a configuration replace operation. list (Optional) Displays a list of the command lines applied by the Cisco IOS software parser during each pass of the configuration replace operation. The total number of passes performed is also displayed. force (Optional) Replaces the current running configuration file with the specified saved Cisco IOS configuration file without prompting you for confirmation. ignorecase (Optional) Instructs the configuration to ignore the case of the configuration confirmation. revert trigger (Optional) Sets the triggers for reverting to the original configuration. • error—Reverts to the original configuration upon error. • timer minutes—Reverts to the original configuration if the specified time elapses. time minutes (Optional) Time (in minutes) within which you must enter the configure confirm command to confirm replacement of the current running configuration file. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command). Release Modification 12.3(7)T This command was introduced. 12.2(25)S The nolock keyword was added. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. 12.4(20)T The revert and trigger keywords were added. configure replace CF-102 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines When configuring more than one keyword option, the following rules apply: • The list keyword must be entered before the force and time keywords. • The force keyword must be entered before the time keyword. If the current running configuration is replaced with a saved Cisco IOS configuration file that contains commands unaccepted by the Cisco IOS software parser, an error message is displayed listing the commands that were unaccepted. The total number of passes performed in the configuration replace operation is also displayed. Note In Cisco IOS Release 12.2(25)S, a locking feature for the configuration replace operation was introduced. When the configure replace command is enabled, the Cisco IOS running configuration file is locked by default for the duration of the configuration replace operation. This locking mechanism prevents other users from changing the running configuration while the replace operation is taking place, which might otherwise cause the replace operation to terminate unsuccessfully. You can disable the locking of the running configuration using the configure replace nolock command. The running configuration lock is automatically cleared at the end of the configuration replace operation. It is not expected that you should need to clear the lock manually during the replace operation, but as a protection against any unforeseen circumstances, you can manually clear the lock using the clear configuration lock command. You can also display any locks that may be currently applied to the running configuration using the show configuration lock command. Examples This section contains the following examples: • Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File • Reverting to the Startup Configuration File • Performing a Configuration Replace Operation with the configure confirm Command • Performing a Configuration Rollback Operation Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File The following example shows how to replace the current running configuration with a saved Cisco IOS configuration file named disk0:myconfig. Note that the configure replace command interactively prompts you to confirm the operation. Router# configure replace disk0:myconfig This will apply all necessary additions and deletions to replace the current running configuration with the contents of the specified configuration file, which is assumed to be a complete configuration, not a partial configuration. Enter Y if you are sure you want to proceed. ? [no]: Y Total number of passes: 1 12.2(33)SRC The ignorecase keyword was added. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. Release Modification configure replace CF-103 Cisco IOS Configuration Fundamentals Command Reference April 2010 Rollback Done In the following example, the list keyword is specified to display the command lines that were applied during the configuration replace operation: Router# configure replace disk0:myconfig list This will apply all necessary additions and deletions to replace the current running configuration with the contents of the specified configuration file, which is assumed to be a complete configuration, not a partial configuration. Enter Y if you are sure you want to proceed. ? [no]: Y !Pass 1 !List of Commands: no snmp-server community public ro snmp-server community mystring ro end Total number of passes: 1 Rollback Done Reverting to the Startup Configuration File The following example shows how to revert to the Cisco IOS startup configuration file. This example also shows the use of the optional force keyword to override the interactive user prompt. Router# configure replace nvram:startup-config force Total number of passes: 1 Rollback Done Performing a Configuration Replace Operation with the configure confirm Command The following example shows the use of the configure replace command with the time seconds keyword and argument. You must enter the configure confirm command within the specified time limit to confirm replacement of the current running configuration file. If the configure confirm command is not entered within the specified time limit, the configuration replace operation is automatically reversed (in other words, the current running configuration file is restored to the configuration state that existed prior to entering the configure replace command). Router# configure replace nvram:startup-config time 120 This will apply all necessary additions and deletions to replace the current running configuration with the contents of the specified configuration file, which is assumed to be a complete configuration, not a partial configuration. Enter Y if you are sure you want to proceed. ? [no]: Y Total number of passes: 1 Rollback Done Router# configure confirm Performing a Configuration Rollback Operation The following example shows how to make changes to the current running configuration and then roll back the changes. As part of the configuration rollback operation, you must save the current running configuration before making changes to the file. In this example, the archive config command is used to save the current running configuration. Note that the generated output of the configure replace command indicates that only one pass was performed to complete the rollback operation. configure replace CF-104 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note The path command must be configured before using the archive config command. You first save the current running configuration in the configuration archive as follows: Router# archive config You then enter configuration changes as shown in the following example: Router# configure terminal Router(config)# user netops2 password rain Router(config)# user netops3 password snow Router(config)# exit After making changes to the running configuration file, you might want to roll back these changes and revert to the configuration that existed before the changes were made. The show archive command is used to verify the version of the configuration to be used as a target file. The configure replace command is then used to revert to the target configuration file as shown in the following example: Router# show archive There are currently 1 archive configurations saved. The next archive file will be named disk0:myconfig-2 Archive # Name 0 1 disk0:myconfig-1 <- Most Recent 2 3 4 5 6 7 8 9 10 Router# configure replace disk0:myconfig-1 Total number of passes: 1 Rollback Done Related Commands Command Description archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure confirm Confirms replacement of the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. configure revert CF-105 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure revert To cancel the timed rollback and trigger the rollback immediately, or to reset parameters for the timed rollback, use the configure revert command in privileged EXEC mode. configure revert {now | timer {minutes | idle minutes}} Syntax Description Command Modes Privileged EXEC (#) Command History Usage Guidelines In order to use the configure revert command to configure a timed rollback, the Configuration Archive functionality must be enable first. The Configuration Archive APIs are used to store the current configuration before applying any changes or rolling back to the previous configuration. In case of multi-user environments, only the user who enabled the timed rollback functionality will have the permission to perform the following operations: • Confirm the configuration change • Reset the timer • Cancel the timer and trigger rollback immediately Examples The following example shows how to cancel the timed rollback and revert to the saved configuration immediately: Rourter(config)# archive Router(config-archive)# path disk0:abc Router# configure revert now now Cancels the timed rollback and reverts immediately. timer Resets the confirmation timer. minutes Time in minutes (1-120). idle minutes Idle time in minutes (1-120) for which to wait before rollback. Release Modification 12.2(33)SRC This command was introduced. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. configure revert CF-106 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path (config-archive) Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. configure terminal CF-107 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure terminal To enter global configuration mode, use the configure terminal command in privileged EXEC mode. configure terminal Cisco IOS Releases 12.3(14)T and Subsequent Releases: configure terminal [lock] Cisco IOS Releases 12.2(33)SRC and Subsequent Releases: configure terminal [revert {timer minutes | idle minutes}] Syntax Description Command Modes Privileged EXEC (#) Command History Usage Guidelines Use this command to enter global configuration mode. Note that commands in this mode are written to the running configuration file as soon as you enter them (using the Enter key/Carriage Return). After you enter the configure terminal command, the system prompt changes from # to (config)#, indicating that the router is in global configuration mode. To leave global configuration mode and return to privileged EXEC mode, type exit or press Ctrl-Z. To view the changes to the configuration you have made, use the more system:running-config command or show running-config command in user EXEC or privileged EXEC mode. lock (Optional) Locks the running configuration into exclusive configuration mode for the duration of your configuration session. This keyword only functions if the configuration mode exclusive command was previously enabled. revert (Optional) Sets the parameters for reverting the configuration if confirmation of the new configuration is not received. timer minutes Time in minutes (1-120) for which to wait for confirmation. idle minutes Idle time in minutes (1-120) for which to wait for confirmation. Release Modification 10.0 This command was introduced. 12.3(14)T The lock keyword option was added. 12.0(31)S This command was integrated into Cisco IOS Release 12.0(31)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.4(20)T The revert keyword option was added, along with the timer parameters of idle and minutes. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. configure terminal CF-108 Cisco IOS Configuration Fundamentals Command Reference April 2010 Configuration Locking The first user to enter the configure terminal lock command acquires the configuration lock (exclusive configuration mode). Examples The following example shows how to enter global configuration mode and lock the Cisco IOS software in exclusive mode: Router(config)# configure terminal lock Enter configuration commands, one per line. End with CNTL/Z. Router(config)# Related Commands Command Description boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). configuration mode exclusive Enables locking of the configuration file for single user access. copy running-config startup-config or copy system:running-config nvram:startup-config Saves the running configuration as the startup configuration file. show running-config or more system:running-config Displays the currently running configuration. confreg CF-109 Cisco IOS Configuration Fundamentals Command Reference April 2010 confreg To change the configuration register settings while in ROM monitor mode, use the confreg command in ROM monitor mode. confreg [value] Syntax Description Defaults Refer to your platform documentation for the default configuration register value. Command Modes ROM monitor Command History Usage Guidelines Not all versions in the ROM monitor support this command. Refer to your platform documentation for more information on ROM monitor mode. If you use this command without specifying the configuration register value, the router prompts for each bit of the configuration register. The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network. To change the boot field value and leave all other bits set to their default values, follow these guidelines: • If you set the configuration register boot field value to 0x0, you must boot the operating system manually with the boot command. • If you set the configuration register boot field value to 0x1, the router boots using the default ROM software. • If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot field value to form a default boot filename for booting from a network server. For more information about the configuration register bit settings and default filenames, refer to the appropriate router hardware installation guide. Examples In the following example, the configuration register is set to boot the system image from Flash memory: confreg 0x210F In the following example, no configuration value is entered, so the system prompts for each bit in the register: value (Optional) Hexadecimal value that represents the 16-bit configuration register value that you want to use the next time the router is restarted. The value range is from 0x0 to 0xFFFF. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. confreg CF-110 Cisco IOS Configuration Fundamentals Command Reference April 2010 rommon 7 > confreg Configuration Summary enabled are: console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n [n]: y enable "diagnostic mode"? y/n [n]: y enable "use net in IP bcast address"? y/n [n]: enable "load rom after netboot fails"? y/n [n]: enable "use all zero broadcast"? y/n [n]: enable "break/abort has effect"? y/n [n]: enable "ignore system config info"? y/n [n]: change console baud rate? y/n [n]: y enter rate: 0 = 9600, 1 = 4800, 2 = 1200, 3 = 2400 [0]: 0 change the boot characteristics? y/n [n]: y enter to boot: 0 = ROM Monitor 1 = the boot helper image 2-15 = boot system [0]: 0 Configuration Summary enabled are: diagnostic mode console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n [n]: You must reset or power cycle for new config to take effect. rommon 8> continue (ROM monitor) CF-111 Cisco IOS Configuration Fundamentals Command Reference April 2010 continue (ROM monitor) To return to EXEC mode from ROM monitor mode, use the continue command in ROM monitor mode. continue Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes ROM monitor Command History Usage Guidelines Use this command to return to EXEC mode from ROM monitor mode, to use the system image instead of reloading. On older platforms, the angle bracket (< >) indicates that the router is in ROM monitor mode. On newer platforms, rommon number> is the default ROM monitor prompt. Typically, the router is in ROM monitor mode when you manually load a system image or perform diagnostic tests. Otherwise, the router will most likely never be in this mode. Caution While in ROM monitor mode, the Cisco IOS system software is suspended until you issue either a reset or the continue command. Examples In the following example, the continue command switches the router from ROM monitor to EXEC mode: > continue Router# Related Commands Release Modification 11.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description boot Boots the router manually. copy CF-112 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy To copy any file from a source to a destination, use the copy command in privileged EXEC or diagnostic mode. copy [/erase] [/verify | /noverify] source-url destination-url Syntax Description The exact format of the source and destination URLs varies according to the file or directory location. You may enter either an alias keyword for a particular file or a filename that follows the standard Cisco IOS file system syntax (filesystem:[/filepath][/filename]). Table 18 shows two keyword shortcuts to URLs. /erase (Optional) Erases the destination file system before copying. Note This option is typically provided on platforms with limited memory to allow for an easy way to clear local flash memory space. /verify (Optional) Verifies the digital signature of the destination file. If verification fails, the file is deleted from the destination file system. This option applies to Cisco IOS software image files only. /noverify (Optional) If the file being copied is an image file, this keyword disables the automatic image verification that occurs after an image is copied. Note This keyword is often issued if the file verify auto command is enabled, which automatically verifies the digital signature of all images that are copied. source-url The location URL (or alias) of the source file or directory to be copied. The source can be either local or remote, depending upon whether the file is being downloaded or uploaded. destination-url The destination URL (or alias) of the copied file or directory. The destination can be either local or remote, depending upon whether the file is being downloaded or uploaded. Table 18 Common Keyword Aliases to URLs Keyword Source or Destination running-config (Optional) Keyword alias for the system:running-config URL. The system:running-config keyword represents the current running configuration file. This keyword does not work in more and show file EXEC command syntaxes. startup-config (Optional) Keyword alias for the nvram:startup-config URL. The nvram:startup-config keyword represents the configuration file used during initialization (startup). This file is contained in NVRAM for all platforms except the Cisco 7000 family, which uses the CONFIG_FILE environment variable to specify the startup configuration. The Cisco 4500 series cannot use the copy running-config startup-config command. This keyword does not work in more and show file EXEC command syntaxes. copy CF-113 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following tables list URL prefix keywords by file system type. The available file systems will vary by platform. If you do not specify a URL prefix keyword, the router looks for a file in the current directory. Table 19 lists URL prefix keywords for Special (opaque) file systems. Table 20 lists them for remote file systems, and Table 21 lists them for local writable storage. Table 19 URL Prefix Keywords for Special File Systems Keyword Source or Destination cns: Source URL for Cisco Networking Services files. flh: Source URL for flash load helper log files. logging Source URL which copies messages from the logging buffer to a file. modem: Destination URL for loading modem firmware on to supported networking devices. null: Null destination for copies or files. You can copy a remote file to null to determine its size. nvram: Router NVRAM. You can copy the startup configuration to NVRAM or from NVRAM. obfl: Source or destination URL for Onboard Failure Logging files. stby-nvram: Router NVRAM on the standby hardware. You can copy the startup configuration to NVRAM or from NVRAM. stby-obfl: Source or destination URL for Onboard Failure Logging files on the standby hardware. system: Source or destination URL for system memory, which includes the running configuration. tar: Source URL for the archive file system. tmpsys: Source or destination URL for the temporary system files. xmodem: Source or destination for a file from a network machine that uses the Xmodem protocol. ymodem: Source or destination for a file from a network machine that uses the Ymodem protocol. Table 20 URL Prefix Keywords for Remote File Systems Keyword Source or Destination ftp: Source or destination URL for FTP network server. The syntax for this alias is as follows: ftp:[[[//username [:password]@]location]/directory]/filename. http:// Source or destination URL for an HTTP server (also called a web server). The syntax for this alias is as follows: http://[[username:password]@]{hostname | host-ip}[/filepath]/filename https:// Source or destination URL for a Secure HTTP (HTTPS) server. HTTPS uses Secure Socket Layer (SSL) encryption. The syntax for this alias is as follows: https://[[username:password]@]{hostname | host-ip}[/filepath]/filename copy CF-114 Cisco IOS Configuration Fundamentals Command Reference April 2010 rcp: Source or destination URL for a remote copy protocol (rcp) network server. The syntax for this alias is as follows: rcp:[[[//username@]location]/directory]/filename scp: Source or destination URL for a network server that supports Secure Shell (SSH) and accepts copies of files using the secure copy protocol (scp). The syntax for this alias is as follows: scp://username@location[/directory][/filename] tftp: Source or destination URL for a TFTP network server. The syntax for this alias is as follows: tftp:[[//location]/directory]/filename. Table 21 URL Prefix Keywords for Local Writable Storage File Systems Alias Source or Destination bootflash: Source or destination URL for boot flash memory. disk0: and disk1: Source or destination URL of disk-based media. flash: Source or destination URL for flash memory. This alias is available on all platforms. For platforms that lack a flash: device, note that flash: is aliased to slot0:, allowing you to refer to the main flash memory storage area on all platforms. harddisk: Source or destination URL of the active harddisk file system. slavebootflash: Source or destination URL for internal flash memory on the slave RSP card of a router configured for HSA. slaveram: NVRAM on a slave RSP card of a router configured for HSA. slaveslot0: Source or destination URL of the first Personal Computer Memory Card International Association (PCMCIA) card on a slave RSP card of a router configured for HSA. slaveslot1: Source or destination URL of the second PCMCIA slot on a slave RSP card of a router configured for HSA. slot0: Source or destination URL of the first PCMCIA flash memory card. slot1: Source or destination URL of the second PCMCIA flash memory card. stby-bootflash: Source or destination URL for boot flash memory in standby RP. stby-harddisk: Source or destination URL for the standby harddisk. stby-usb[0-1]: Source or destination URL for the Universal Serial Bus (USB) flash drive that has been plugged into the router and is located on the standby RP. usb[0-1]: Source or destination URL for the Universal Serial Bus (USB) flash drive that has been plugged into the router and is located on the active RP. usbflash[0-9]: Source or destination URL for the Universal Serial Bus (USB) flash drive that has been plugged into the router. usbtoken[0-9]: Source or destination URL for the USB eToken that has been plugged into the router. Table 20 URL Prefix Keywords for Remote File Systems Keyword Source or Destination copy CF-115 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines The fundamental function of the copy command is to allow you to copy a file (such as a system image or configuration file) from one location to another location. The source and destination for the file is specified using a Cisco IOS File System URL, which allows you to specify any supported local or remote file location. The file system being used (such as a local memory source, or a remote server) dictates the syntax used in the command. You can enter on the command line all necessary source- and destination-URL information and the username and password to use, or you can enter the copy command and have the router prompt you for any missing information. For local file systems, two commonly used aliases exist for the system:running-config and nvram:startup-config files; these aliases are running-config and startup-config, respectively. Timesaver Aliases are used to reduce the amount of typing you need to perform. For example, it is easier to type copy run start (the abbreviated form of the copy running-config startup-config command) than it is to type copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-config command). These aliases also allow you to continue using some of the common commands used in previous versions of Cisco IOS software. Release Modification 11.3T This command was introduced. 12.3(2)T • The http:// and https:// keywords were added as supported remote source locations (file system URL prefixes) for files. • This command was enhanced to support copying files to servers that support SSH and the scp. 12.2(14)S This command was integrated into Cisco IOS Release 12.2(14)S. 12.2(18)S The /verify and /noverify keywords were added. 12.0(26)S The /verify and /noverify keywords were integrated into Cisco IOS Release 12.0(26)S. 12.3(4)T The /verify and /noverify keywords were integrated into Cisco IOS Release 12.3(4)T. 12.3(7)T The http:// and https:// keywords were enhanced to support file uploads. 12.3(14)T The usbflash[0-9]: and usbtoken[0-9]: keywords were added to support USB storage. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(25)SG This command was integrated into Cisco IOS Release 12.2(25)SG. 12.4(11)T This command was integrated into the Cisco 7200VXR NPE-G2 platform. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. Cisco IOS XE Release 2.1 The Cisco ASR1000 series routers became available, and introduced the copy command in diagnostic mode. copy CF-116 Cisco IOS Configuration Fundamentals Command Reference April 2010 The entire copying process may take several minutes and differs from protocol to protocol and from network to network. The colon is required after the file system URL prefix keywords (such as flash). In some cases, file system prefixes that did not require colons in earlier software releases are allowed for backwards compatibility, but use of the colon is recommended. In the URL syntax for ftp:, http:, https:, rcp:, scp: and tftp:, the location is either an IP address or a host name. The filename is specified relative to the directory used for file transfers. The following sections contain usage guidelines for the following topics: • Understanding Invalid Combinations of Source and Destination, page 116 • Understanding Character Descriptions, page 116 • Understanding Partitions, page 117 • Using rcp, page 117 • Using FTP, page 118 • Using HTTP or HTTPS, page 118 • Storing Images on Servers, page 119 • Copying from a Server to Flash Memory, page 119 • Verifying Images, page 119 • Copying a Configuration File from a Server to the Running Configuration, page 120 • Copying a Configuration File from a Server to the Startup Configuration, page 120 • Storing the Running or Startup Configuration on a Server, page 120 • Saving the Running Configuration to the Startup Configuration, page 120 • Using CONFIG_FILE, BOOT, and BOOTLDR Environment Variables, page 121 • Using the Copy Command with the Dual RSP Feature, page 121 • Using the copy command with the ASR1000 Series Routers, page 121 Understanding Invalid Combinations of Source and Destination Some invalid combinations of source and destination exist. Specifically, you cannot copy: • From a running configuration to a running configuration • From a startup configuration to a startup configuration • From a device to the same device (for example, the copy flash: flash: command is invalid) Understanding Character Descriptions Table 22 describes the characters that you may see during processing of the copy command. copy CF-117 Cisco IOS Configuration Fundamentals Command Reference April 2010 Understanding Partitions You cannot copy an image or configuration file to a flash partition from which you are currently running. For example, if partition 1 is running the current system image, copy the configuration file or image to partition 2. Otherwise, the copy operation will fail. You can identify the available flash partitions by entering the show file system EXEC command. Using rcp The rcp requires a client to send a remote username upon each rcp request to a server. When you copy a configuration file or image between the router and a server using rcp, the Cisco IOS software sends the first valid username it encounters in the following sequence: 1. The remote username specified in the copy command, if a username is specified. 2. The username set by the ip rcmd remote-username global configuration command, if the command is configured. 3. The remote username associated with the current tty (terminal) process. For example, if the user is connected to the router through Telnet and was authenticated through the username command, the router software sends the Telnet username as the remote username. 4. The router host name. For the rcp copy request to process, an account must be defined on the network server for the remote username. If the network administrator of the destination server did not establish an account for the remote username, this command will not run. If the server has a directory structure, the configuration file or image is written to or copied from the directory associated with the remote username on the server. For example, if the system image resides in the home directory of a user on the server, specify that username as the remote username. If you are writing to the server, the rcp server must be properly configured to accept the rcp write request from the user on the router. For UNIX systems, add an entry to the .rhosts file for the remote user on the rcp server. Suppose the router contains the following configuration lines: hostname Rtr1 ip rcmd remote-username User0 Table 22 copy Character Descriptions Character Description ! For network transfers, an exclamation point indicates that the copy process is taking place. Each exclamation point indicates the successful transfer of ten packets (512 bytes each). . For network transfers, a period indicates that the copy process timed out. Many periods in a row typically mean that the copy process may fail. O For network transfers, an uppercase O indicates that a packet was received out of order and the copy process may fail. e For flash erasures, a lowercase e indicates that a device is being erased. E An uppercase E indicates an error. The copy process may fail. V A series of uppercase Vs indicates the progress during the verification of the image checksum. copy CF-118 Cisco IOS Configuration Fundamentals Command Reference April 2010 If the router IP address translates to Router1.company.com, then the .rhosts file for User0 on the rcp server should contain the following line: Router1.company.com Rtr1 Refer to the documentation for your rcp server for more details. If you are using a personal computer as a file server, the computer must support the remote shell protocol (rsh). Using FTP The FTP protocol requires a client to send a username and password with each FTP request to a remote FTP server. Use the ip ftp username and ip ftp password global configuration commands to specify a default username and password for all copy operations to or from an FTP server. Include the username in the copy command syntax if you want to specify a username for that copy operation only. When you copy a file from the router to a server using FTP, the Cisco IOS software sends the first valid username that it encounters in the following sequence: 1. The username specified in the copy command, if a username is specified. 2. The username set by the ip ftp username command, if the command is configured. 3. Anonymous. The router sends the first valid password in the following list: 1. The password specified in the copy command, if a password is specified. 2. The password set by the ip ftp password command, if the command is configured. 3. The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router. The username and password must be associated with an account on the FTP server. If you are writing to the server, the FTP server must be properly configured to accept the FTP write request from the user on the router. If the server has a directory structure, the configuration file or image is written to or copied from the directory associated with the username on the server. For example, if the system image resides in the home directory of a user on the server, specify that username as the remote username. Refer to the documentation for your FTP server for details on setting up the server. Using HTTP or HTTPS Copying a file to or from a remote HTTP or HTTPS server, to or from a local file system, is performed using the embedded Secure HTTP client that is integrated in Cisco IOS software. The HTTP client is enabled by default. Downloading files from a remote HTTP or HTTPS server is performed using the HTTP client integrated in Cisco IOS software. If a username and password are not specified in the copy command syntax, the system uses the default HTTP client username and password, if configured. When you copy a file from a remote HTTP or HTTPS server, the Cisco IOS software sends the first valid username that it encounters in the following sequence: 1. The username specified in the copy command, if a username is specified. 2. The username set by the ip http client username command, if the command is configured. 3. Anonymous. copy CF-119 Cisco IOS Configuration Fundamentals Command Reference April 2010 The router sends the first valid password in the following list: 1. The password specified in the copy command, if a password is specified. 2. The password set by the ip http client password command, if the command is configured. 3. The router forms the password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router. Storing Images on Servers Use the copy flash: destination-url command (for example, copy flash: tftp:) to copy a system image or boot image from flash memory to a network server. You can use the copy of the image as a backup copy. Also, you can also use the image backup file to verify that the image in flash memory is the same as that in the original file. Copying from a Server to Flash Memory Use the copy destination-url flash: command (for example, copy tftp: flash:) to copy an image from a server to flash memory. On Class B file system platforms, the system provides an option to erase existing flash memory before writing onto it. Note Verify the image in flash memory before booting the image. Verifying Images When copying a new image to your router, you should confirm that the image was not corrupted during the copy process. You can verify the integrity of the image in any of the following ways: • Depending on the destination file system type, a checksum for the image file may be displayed when the copy command completes. You can verify this checksum by comparing it to the checksum value provided for your image file on Cisco.com. Caution If the checksum values do not match, do not reboot the router. Instead, reissue the copy command and compare the checksums again. If the checksum is repeatedly wrong, copy the original image back into flash memory before you reboot the router from flash memory. If you have a corrupted image in flash memory and try to boot from flash memory, the router will start the system image contained in ROM (assuming booting from a network server is not configured). If ROM does not contain a fully functional system image, the router might not function and will need to be reconfigured through a direct console port connection. • Use the /verify keyword. • Enable automatic image verification by default by issuing the file verify auto command. This command will automatically check the integrity of each file that is copied via the copy command (without specifying the /verify option) to the router unless the /noverify keyword is specified. • Use the UNIX 'diff' command. This method can also be applied to file types other than Cisco IOS images. If you suspect that a file is corrupted, copy the suspect file and the original file to a UNIX server. (The file names may need to be modified if you try to save the files in the same directory.) Then run the UNIX 'diff' command on the two files. If there is no difference, then the file has not been corrupted. copy CF-120 Cisco IOS Configuration Fundamentals Command Reference April 2010 Copying a Configuration File from a Server to the Running Configuration Use the copy {ftp: | rcp: | scp: | tftp:} running-config command to load a configuration file from a network server to the running configuration of the router. (Note that running-config is the alias for the system:running-config keyword.) The configuration will be added to the running configuration as if the commands were typed in the command-line interface (CLI). Thus, the resulting configuration file will be a combination of the previous running configuration and the loaded configuration file, with the loaded configuration file having precedence. You can copy either a host configuration file or a network configuration file. Accept the default value of host to copy and load a host configuration file containing commands that apply to one network server in particular. Enter network to copy and load a network configuration file containing commands that apply to all network servers on a network. Copying a Configuration File from a Server to the Startup Configuration Use the copy {ftp: | rcp: | scp: | tftp:} nvram:startup-config command to copy a configuration file from a network server to the router startup configuration. These commands replace the startup configuration file with the copied configuration file. Storing the Running or Startup Configuration on a Server Use the copy system:running-config {ftp: | rcp: | scp: | tftp:} command to copy the current configuration file to a network server using FTP, rcp, scp, or TFTP. Use the copy nvram:startup-config {ftp: | rcp: | scp: | tftp:} command to copy the startup configuration file to a network server. The configuration file copy can serve as a backup copy. Saving the Running Configuration to the Startup Configuration Use the copy system:running-config nvram:startup-config command to copy the running configuration to the startup configuration. Note Some specific commands might not get saved to NVRAM. You will need to enter these commands again if you reboot the machine. These commands are noted in the documentation. We recommend that you keep a listing of these settings so you can quickly reconfigure your router after rebooting. If you issue the copy system:running-config nvram:startup-config command from a bootstrap system image, a warning will instruct you to indicate whether you want your previous NVRAM configuration to be overwritten and configuration commands to be lost. This warning does not appear if NVRAM contains an invalid configuration or if the previous configuration in NVRAM was generated by a bootstrap system image. On all platforms except Class A file system platforms, the copy system:running-config nvram:startup-config command copies the currently running configuration to NVRAM. On the Class A flash file system platforms, the copy system:running-config nvram:startup-config command copies the currently running configuration to the location specified by the CONFIG_FILE environment variable. This variable specifies the device and configuration file used for initialization. When the CONFIG_FILE environment variable points to NVRAM or when this variable does not exist (such as at first-time startup), the software writes the current configuration to NVRAM. If the current configuration is too large for NVRAM, the software displays a message and stops executing the command. copy CF-121 Cisco IOS Configuration Fundamentals Command Reference April 2010 When the CONFIG_FILE environment variable specifies a valid device other than nvram: (that is, flash:, bootflash:, slot0:, or slot1:), the software writes the current configuration to the specified device and filename, and stores a distilled version of the configuration in NVRAM. A distilled version is one that does not contain access list information. If NVRAM already contains a copy of a complete configuration, the router prompts you to confirm the copy. Using CONFIG_FILE, BOOT, and BOOTLDR Environment Variables For the Class A flash file system platforms, specifications are as follows: • The CONFIG_FILE environment variable specifies the configuration file used during router initialization. • The BOOT environment variable specifies a list of bootable images on various devices. • The BOOTLDR environment variable specifies the flash device and filename containing the rxboot image that ROM uses for booting. • Cisco 3600 routers do not use a dedicated boot helper image (rxboot), which many other routers use to help with the boot process. Instead, the BOOTLDR ROM monitor environment variable identifies the flash memory device and filename that are used as the boot helper; the default is the first system image in flash memory. To view the contents of environment variables, use the show bootvar EXEC command. To modify the CONFIG_FILE environment variable, use the boot config global configuration command. To modify the BOOTLDR environment variable, use the boot bootldr global configuration command. To modify the BOOT environment variable, use the boot system global configuration command. To save your modifications, use the copy system:running-config nvram:startup-config command. When the destination of a copy command is specified by the CONFIG_FILE or BOOTLDR environment variable, the router prompts you for confirmation before proceeding with the copy. When the destination is the only valid image in the BOOT environment variable, the router also prompts you for confirmation before proceeding with the copy. Using the Copy Command with the Dual RSP Feature The Dual RSP feature allows you to install two Route Switch Processor (RSP) cards in a single router on the Cisco 7507 and Cisco 7513 platforms. On a Cisco 7507 or Cisco 7513 router configured for Dual RSPs, if you copy a file to nvram:startup-configuration with automatic synchronization disabled, the system prompts whether you also want to copy the file to the slave startup configuration. The default answer is yes. If automatic synchronization is enabled, the system automatically copies the file to the slave startup configuration each time you use a copy command with nvram:startup-configuration as the destination. Using the copy command with the ASR1000 Series Routers The copy command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 series routers. Because the copy command is available in diagnostic mode, it can be used to copy all types of files between directories and remote locations even in the event of an IOS failure. Examples The following examples illustrate uses of the copy command: • Verifying the Integrity of the Image Before It Is Copied Example, page 122 • Copying an Image from a Server to Flash Memory Examples, page 122 • Saving a Copy of an Image on a Server Examples, page 124 • Copying a Configuration File from a Server to the Running Configuration Example, page 126 copy CF-122 Cisco IOS Configuration Fundamentals Command Reference April 2010 • Copying a Configuration File from a Server to the Startup Configuration Example, page 126 • Copying the Running Configuration to a Server Example, page 126 • Copying the Startup Configuration to a Server Example, page 127 • Saving the Current Running Configuration Example, page 127 • Moving Configuration Files to Other Locations Examples, page 127 • Copying a File from a Remote Web Server Examples, page 129 • Copying an Image from the Master RSP Card to the Slave RSP Card Example, page 129 Verifying the Integrity of the Image Before It Is Copied Example The following example shows how to specify image verification before copying an image: Router# copy /verify tftp://10.1.1.1/cisco/c7200-js-mz disk0: Destination filename [c7200-js-mz]? Accessing tftp://10.1.1.1/cisco/c7200-js-mz... Loading cisco/c7200-js-mz from 10.1.1.1 (via FastEthernet0/0):!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! [OK - 19879944 bytes] 19879944 bytes copied in 108.632 secs (183003 bytes/sec) Verifying file integrity of disk0:/c7200-js-mz ......................................................................................... .......................................................................................... .......................................................................................... ......................Done! Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCD Computed Hash MD5 :CFA258948C4ECE52085DCF428A426DCD CCO Hash MD5 :44A7B9BDDD9638128C35528466318183 Signature Verified Copying an Image from a Server to Flash Memory Examples The following examples use a copy rcp:, copy tftp:, or copy ftp: command to copy an image file from a server to flash memory: • Copying an Image from a Server to Flash Memory Example, page 122 • Copying an Image from a Server to a Flash Memory Using Flash Load Helper Example, page 123 • Copying an Image from a Server to a Flash Memory Card Partition Example, page 123 Copying an Image from a Server to Flash Memory Example The following example copies a system image named file1 from the remote rcp server with an IP address of 172.16.101.101 to flash memory. On Class B file system platforms, the Cisco IOS software allows you to first erase the contents of flash memory to ensure that enough flash memory is available to accommodate the system image. Router# copy rcp://netadmin@172.16.101.101/file1 flash:file1 Destination file name [file1]? Accessing file 'file1' on 172.16.101.101... Loading file1 from 172.16.101.101 (via Ethernet0): ! [OK] Erase flash device before writing? [confirm] Flash contains files. Are you sure you want to erase? [confirm] copy CF-123 Cisco IOS Configuration Fundamentals Command Reference April 2010 Copy 'file1' from server as 'file1' into Flash WITH erase? [yes/no] yes Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee...erased Loading file1 from 172.16.101.101 (via Ethernet0): ! [OK - 984/8388608 bytes] Verifying checksum... OK (0x14B3) Flash copy took 0:00:01 [hh:mm:ss] Copying an Image from a Server to a Flash Memory Using Flash Load Helper Example The following example copies a system image into a partition of flash memory. The system will prompt for a partition number only if there are two or more read/write partitions or one read-only and one read/write partition and dual flash bank support in boot ROMs. If the partition entered is not valid, the process terminates. You can enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (?number) for directory display of a particular partition. The default is the first read/write partition. In this case, the partition is read-only and has dual flash bank support in boot ROM, so the system uses flash Load Helper. Router# copy tftp: flash: System flash partition information: Partition Size Used Free Bank-Size State Copy-Mode 1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH 2 4096K 2048K 2048K 2048K Read/Write Direct [Type ? for partition directory; ? for full directory; q to abort] Which partition? [default = 2] NOTICE Flash load helper v1.0 This process will accept the copy options and then terminate the current system image to use the ROM based image for the copy. Routing functionality will not be available during that time. If you are logged in via telnet, this connection will terminate. Users with console access can see the results of the copy operation. ---- ---- Proceed? [confirm] System flash directory, partition 1: File Length Name/status 1 3459720 master/igs-bfpx.100-4.3 [3459784 bytes used, 734520 available, 4194304 total] Address or name of remote host [255.255.255.255]? 172.16.1.1 Source file name? master/igs-bfpx-100.4.3 Destination file name [default = source name]? Loading master/igs-bfpx.100-4.3 from 172.16.1.111: ! Erase flash device before writing? [confirm] Flash contains files. Are you sure? [confirm] Copy 'master/igs-bfpx.100-4.3' from TFTP server as 'master/igs-bfpx.100-4.3' into Flash WITH erase? [yes/no] yes Copying an Image from a Server to a Flash Memory Card Partition Example The following example copies the file c3600-i-mz from the rcp server at IP address 172.23.1.129 to the flash memory card in slot 0 of a Cisco 3600 series router, which has only one partition. As the operation progresses, the Cisco IOS software prompts you to erase the files on the flash memory PC card to accommodate the incoming file. This entire operation takes 18 seconds to perform, as indicated at the end of the example. Router# copy rcp: slot0: PCMCIA Slot0 flash copy CF-124 Cisco IOS Configuration Fundamentals Command Reference April 2010 Partition Size Used Free Bank-Size State Copy Mode 1 4096K 3068K 1027K 4096K Read/Write Direct 2 4096K 1671K 2424K 4096K Read/Write Direct 3 4096K 0K 4095K 4096K Read/Write Direct 4 4096K 3825K 270K 4096K Read/Write Direct [Type ? for partition directory; ? for full directory; q to abort] Which partition? [default = 1] PCMCIA Slot0 flash directory, partition 1: File Length Name/status 1 3142288 c3600-j-mz.test [3142352 bytes used, 1051952 available, 4194304 total] Address or name of remote host [172.23.1.129]? Source file name? /tftpboot/images/c3600-i-mz Destination file name [/tftpboot/images/c3600-i-mz]? Accessing file '/tftpboot/images/c3600-i-mz' on 172.23.1.129... Connected to 172.23.1.129 Loading 1711088 byte file c3600-i-mz: ! [OK] Erase flash device before writing? [confirm] Flash contains files. Are you sure you want to erase? [confirm] Copy '/tftpboot/images/c3600-i-mz' from server as '/tftpboot/images/c3600-i-mz' into Flash WITH erase? [yes/no] yes Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased Connected to 172.23.1.129 Loading 1711088 byte file c3600-i-mz: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Verifying checksum... OK (0xF89A) Flash device copy took 00:00:18 [hh:mm:ss] Saving a Copy of an Image on a Server Examples The following examples use copy commands to copy image files to a server for storage: • Copy an Image from Flash Memory to an rcp Server Example, page 124 • Copy an Image from Flash Memory to an SSH Server Using scp Example, page 125 • Copy an Image from a Partition of Flash Memory to a Server Example, page 125 • Copying an Image from a Flash Memory File System to an FTP Server Example, page 125 • Copying an Image from Boot Flash Memory to a TFTP Server Example, page 126 Copy an Image from Flash Memory to an rcp Server Example The following example copies a system image from flash Memory to an rcp server using the default remote username. Because the rcp server address and filename are not included in the command, the router prompts for it. Router# copy flash: rcp: IP address of remote host [255.255.255.255]? 172.16.13.110 Name of file to copy? gsxx writing gsxx - copy complete copy CF-125 Cisco IOS Configuration Fundamentals Command Reference April 2010 Copy an Image from Flash Memory to an SSH Server Using scp Example The following example shows how to use scp to copy a system image from flash memory to a server that supports SSH: Router# copy flash:c4500-ik2s-mz.scp scp://user1@host1/ Address or name of remote host [host1]? Destination username [user1]? Destination filename [c4500-ik2s-mz.scp]? Writing c4500-ik2s-mz.scp Password: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Before you can use the server-side functionality, SSH, authentication, and authorization must be properly configured so the router can determine whether a user is at the right privilege level. The scp server-side functionality is configured with the ip scp server enable command. Copy an Image from a Partition of Flash Memory to a Server Example The following example copies an image from a particular partition of flash memory to an rcp server using a remote username of netadmin1. The system will prompt if there are two or more partitions. If the partition entered is not valid, the process terminates. You have the option to enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (?number) for a directory display of a particular partition. The default is the first partition. Router# configure terminal Router# ip rcmd remote-username netadmin1 Router# end Router# copy flash: rcp: System flash partition information: Partition Size Used Free Bank-Size State Copy-Mode 1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH 2 4096K 2048K 2048K 2048K Read/Write Direct [Type ? for partition directory; ? for full directory; q to abort] Which partition? [1] 2 System flash directory, partition 2: File Length Name/status 1 3459720 master/igs-bfpx.100-4.3 [3459784 bytes used, 734520 available, 4194304 total] Address or name of remote host [ABC.CISCO.COM]? Source file name? master/igs-bfpx.100-4.3 Destination file name [master/igs-bfpx.100-4.3]? Verifying checksum for 'master/igs-bfpx.100-4.3' (file # 1)... OK Copy 'master/igs-bfpx.100-4.3' from Flash to server as 'master/igs-bfpx.100-4.3'? [yes/no] yes !!!!... Upload to server done Flash copy took 0:00:00 [hh:mm:ss] Copying an Image from a Flash Memory File System to an FTP Server Example The following example copies the file c3600-i-mz from partition 1 of the flash memory card in slot 0 to an FTP server at IP address 172.23.1.129: Router# show slot0: partition 1 PCMCIA Slot0 flash directory, partition 1: File Length Name/status 1 1711088 c3600-i-mz [1711152 bytes used, 2483152 available, 4194304 total] copy CF-126 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# copy slot0:1:c3600-i-mz ftp://myuser:mypass@172.23.1.129/c3600-i-mz Verifying checksum for '/tftpboot/cisco_rules/c3600-i-mz' (file # 1)... OK Copy '/tftpboot/cisco_rules/c3600-i-mz' from Flash to server as 'c3700-i-mz'? [yes/no] yes !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Upload to server done Flash device copy took 00:00:23 [hh:mm:ss] Copying an Image from Boot Flash Memory to a TFTP Server Example The following example copies an image from boot flash memory to a TFTP server: Router# copy bootflash:file1 tftp://192.168.117.23/file1 Verifying checksum for 'file1' (file # 1)... OK Copy 'file1' from Flash to server as 'file1'? [yes/no]y !!!!... Upload to server done Flash copy took 0:00:00 [hh:mm:ss] Copying a Configuration File from a Server to the Running Configuration Example The following example copies and runs a configuration filename host1-confg from the netadmin1 directory on the remote server with an IP address of 172.16.101.101: Router# copy rcp://netadmin1@172.16.101.101/host1-confg system:running-config Configure using host1-confg from 172.16.101.101? [confirm] Connected to 172.16.101.101 Loading 1112 byte file host1-confg:![OK] Router# %SYS-5-CONFIG: Configured from host1-config by rcp from 172.16.101.101 Copying a Configuration File from a Server to the Startup Configuration Example The following example copies a configuration file host2-confg from a remote FTP server to the startup configuration. The IP address is172.16.101.101, the remote username is netadmin1, and the remote password is ftppass. Router# copy ftp://netadmin1:ftppass@172.16.101.101/host2-confg nvram:startup-config Configure using rtr2-confg from 172.16.101.101?[confirm] Connected to 172.16.101.101 Loading 1112 byte file rtr2-confg:![OK] [OK] Router# %SYS-5-CONFIG_NV:Non-volatile store configured from rtr2-config by FTP from 172.16.101.101 Copying the Running Configuration to a Server Example The following example specifies a remote username of netadmin1. Then it copies the running configuration file named rtr2-confg to the netadmin1 directory on the remote host with an IP address of 172.16.101.101. Router# configure terminal Router(config)# ip rcmd remote-username netadmin1 Router(config)# end Router# copy system:running-config rcp: copy CF-127 Cisco IOS Configuration Fundamentals Command Reference April 2010 Remote host[]? 172.16.101.101 Name of configuration file to write [Rtr2-confg]? Write file rtr2-confg on host 172.16.101.101?[confirm] Building configuration...[OK] Connected to 172.16.101.101 Copying the Startup Configuration to a Server Example The following example copies the startup configuration to a TFTP server: Router# copy nvram:startup-config tftp: Remote host[]? 172.16.101.101 Name of configuration file to write [rtr2-confg]? Write file rtr2-confg on host 172.16.101.101?[confirm] ![OK] Saving the Current Running Configuration Example The following example copies the running configuration to the startup configuration. On a Class A flash file system platform, this command copies the running configuration to the startup configuration specified by the CONFIG_FILE variable. copy system:running-config nvram:startup-config The following example shows the warning that the system provides if you try to save configuration information from bootstrap into the system: Router(boot)# copy system:running-config nvram:startup-config Warning: Attempting to overwrite an NVRAM configuration written by a full system image. This bootstrap software does not support the full configuration command set. If you perform this command now, some configuration commands may be lost. Overwrite the previous NVRAM configuration?[confirm] Enter no to escape writing the configuration information to memory. Moving Configuration Files to Other Locations Examples On some routers, you can store copies of configuration files on a flash memory device. Five examples follow: • Copying the Startup Configuration to a Flash Memory Device Example, page 127 • Copying the Running Configuration to a Flash Memory Device Example, page 127 • Copying to the Running Configuration from a Flash Memory Device Example, page 128 • Copying to the Startup Configuration from a Flash Memory Device Example, page 128 • Copying a Configuration File from one Flash Device to Another Example, page 128 Copying the Startup Configuration to a Flash Memory Device Example The following example copies the startup configuration file (specified by the CONFIG_FILE environment variable) to a flash memory card inserted in slot 0: Router# copy nvram:startup-config slot0:router-confg Copying the Running Configuration to a Flash Memory Device Example The following example copies the running configuration from the router to the flash memory PC card in slot 0: copy CF-128 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# copy system:running-config slot0:berlin-cfg Building configuration... 5267 bytes copied in 0.720 secs Copying to the Running Configuration from a Flash Memory Device Example The following example copies the file named ios-upgrade-1 from the flash memory card in slot 0 to the running configuration: Router# copy slot0:4:ios-upgrade-1 system:running-config Copy 'ios-upgrade-1' from flash device as 'running-config' ? [yes/no] yes Copying to the Startup Configuration from a Flash Memory Device Example The following example copies the router-image file from the flash memory to the startup configuration: Router# copy flash:router-image nvram:startup-config Copying a Configuration File from one Flash Device to Another Example The following example copies the file running-config from the first partition in internal flash memory to the flash memory PC card in slot 1. The checksum of the file is verified, and its copying time of 30 seconds is displayed. Router# copy flash: slot1: System flash Partition Size Used Free Bank-Size State Copy Mode 1 4096K 3070K 1025K 4096K Read/Write Direct 2 16384K 1671K 14712K 8192K Read/Write Direct [Type ? for partition directory; ? for full directory; q to abort] Which partition? [default = 1] System flash directory, partition 1: File Length Name/status 1 3142748 dirt/images/mars-test/c3600-j-mz.latest 2 850 running-config [3143728 bytes used, 1050576 available, 4194304 total] PCMCIA Slot1 flash directory: File Length Name/status 1 1711088 dirt/images/c3600-i-mz 2 850 running-config [1712068 bytes used, 2482236 available, 4194304 total] Source file name? running-config Destination file name [running-config]? Verifying checksum for 'running-config' (file # 2)... OK Erase flash device before writing? [confirm] Flash contains files. Are you sure you want to erase? [confirm] Copy 'running-config' from flash: device as 'running-config' into slot1: device WITH erase? [yes/no] yes Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased ! [OK - 850/4194304 bytes] Flash device copy took 00:00:30 [hh:mm:ss] Verifying checksum... OK (0x16) copy CF-129 Cisco IOS Configuration Fundamentals Command Reference April 2010 Copying a File from a Remote Web Server Examples In the following example, the file config1 is copied from a remote server to flash memory using HTTP: Router# copy http://www.example.com:8080/configs/config1 flash:config1 In the following example, a default username and password for HTTP Client communications is configured, and then the file sample.scr is copied from a secure HTTP server using HTTPS: Router# configure terminal Router(config)# ip http client username joeuser Router(config)# ip http client password letmein Router(config)# end Router# copy https://www.example_secure.com/scripts/sample.scr flash: In the following example, an HTTP proxy server is specified before using the copy http:// command: Router# configure terminal Router(config)# ip http client proxy-server edge2 proxy-port 29 Router(config)# end Router# copy http://www.example.com/configs/config3 flash:/configs/config3 Copying an Image from the Master RSP Card to the Slave RSP Card Example The following example copies the router-image file from the flash memory card inserted in slot 1 of the master RSP card to slot 0 of the slave RSP card in the same router: Router# copy slot1:router-image slaveslot0: Related Commands Command Description boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). boot system Specifies the system image that the router loads at startup. cd Changes the default directory or file system. copy xmodem: flash: Copies any file from a source to a destination. copy ymodem: flash: Copies any file from a source to a destination. delete Deletes a file on a flash memory device. dir Displays a list of files on a file system. erase Erases a file system. ip rcmd remote-username Configures the remote username to be used when requesting a remote copy using rcp. ip scp server enable Enables scp server-side functionality. reload Reloads the operating system. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. show (flash file system) Displays the layout and contents of a flash memory file system. slave auto-sync config Turns on automatic synchronization of configuration files for a Cisco 7507 or Cisco 7513 router that is configured for Dual RSP Backup. verify bootflash: File system or directory containing the files to list, followed by a colon. copy erase flash CF-130 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy erase flash The copy erase flash command has been replaced by the erase flash: command. See the description of the erase command for more information. On some platforms, use can use the copy /erase source-url flash: syntax to erase the local Flash file system before copying a new file into Flash. See the desciption of the copy command for details on this option. copy http:// CF-131 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy http:// The copy http:// command is documented as part of the copy command. copy https:// CF-132 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy https:// The copy https:// command is documented as part of the copy command. copy logging system CF-133 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy logging system To copy archived system events to a destination file system, use the copy logging system command in privileged EXEC mode. To stop copying the archived system events, use the no form of the command. copy logging system target: filename no copy logging system Syntax Description Command Default This command has no default settings. Command Modes Privileged EXEC (#) Command History target: Specifies the destination file system; Valid values are as follows: • bootflash: • disk0: • disk1: • ftp: • http: • https: • rcp: • slavebootflash: • slavedisk0: • slavedisk1: • slavesup-bootdisk: • slavesup-bootflash: • sup-bootdisk: • sup-bootflash: • tftp: filename Name of the file. Release Modification 12.2(33)SXH This command was introduced. 12.2(33)SCC The command was introduced for the Cisco uBR10012 router in the Cisco IOS Software Release 12.2(33)SCC. copy logging system CF-134 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines Cisco Universal Broadband Router 10012 The System Event Archive (SEA) feature is used to address the debug trace and system console constraints. Use the copy logging system command to copy the major and critical events stored in the sea_log.dat file, to the destination file system. Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in compact flash adapter for PRE2. The following example shows how to copy the SEA to the file system of disk0: Router# copy logging system disk0: Destination filename [sea_log.dat]? The following example shows how to copy the SEA using the remote file copy function (rcp): Router# copy logging system rcp: Address or name of remote host []? 192.0.2.1 Destination username [Router]? username1 Destination filename [sea_log.dat]? /auto/tftpboot-users/username1/sea_log.dat Related Commands clear logging system Clears the event records stored in the SEA. logging system Enables or disables SEA logging system. show logging system Displays the SEA logging system disk. copy xmodem: CF-135 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy xmodem: To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Xmodem protocol, use the copy xmodem: command in EXEC mode. copy xmodem: flash-filesystem: Syntax Description Command Modes EXEC Command History Usage Guidelines This command is a form of the copy command. The copy xmodem: and copy xmodem commands are identical. See the description of the copy command for more information. Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Xmodem. Use the copy xmodem: command only if you do not have access to an FTP, TFTP, or rcp server. This copy operation is performed through the console or AUX port. The AUX port, which supports hardware flow control, is recommended. No output is displayed on the port over which the transfer is occurring. You can use the logging buffered command to log all router messages sent to the console port during the file transfer. Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash memory using the Xmodem protocol: copy xmodem: flash: Related Commands flash-filesystem: Destination of the copied file, followed by a colon. Release Modification 11.2 P This command was introduced. 12.2(15)T This command is no longer supported in Cisco IOS Mainline or Technology-based (T) releases. It may continue to appear in Cisco IOS 12.2S-family releases. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description copy Copies any file from a source to a destination. copy ymodem: Copies a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Ymodem protocol. copy ymodem: CF-136 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy ymodem: To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Ymodem protocol, use the copy ymodem: command in EXEC mode. copy ymodem: flash-filesystem: Syntax Description Command Modes EXEC Command History Usage Guidelines The copy ymodem: and copy ymodem commands are identical. See the description of the copy command for more information. Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Ymodem. Use the copy ymodem: command only if you do not have access to an FTP, rcp, or TFTP server. This copy operation is performed through the console or AUX port. The AUX port, which supports hardware flow control, is recommended. No output is displayed on the port over which the transfer is occurring. You can use the logging buffered command to log all router messages sent to the console port during the file transfer. Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash memory using the Ymodem protocol: copy ymodem: flash: Related Commands flash-filesystem: Destination of the copied file, followed by a colon. Release Modification 11.2 P This command was introduced. 12.2(15)T This command is no longer supported in Cisco IOS Mainline or Technology-based (T) releases. It may continue to appear in Cisco IOS 12.2S-family releases. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description copy xmodem: Copies a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX workstation) to Flash memory on a Cisco 3600 series router using the Xmodem protocol. copy /noverify CF-137 Cisco IOS Configuration Fundamentals Command Reference April 2010 copy /noverify To disable the automatic image verification for the current copy operation, use the copy /noverify command. copy /noverify source-url destination-url Syntax Description Defaults Verification is done automatically after completion of a copy operation. Command Modes Privileged EXEC Command History Usage Guidelines The exact format of the source and destination URLs varies according to the file or directory location. You may enter either an alias keyword for a particular file or an alias keyword for a file system type (not a file within a type). Timesaver Aliases are used to cut down on the amount of typing that you need to perform. For example, it is easier to type copy run start (the abbreviated form of the copy running-config startup-config command) than it is to type copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-config command). These aliases allow you to continue using some of the common commands that are used in previous versions of Cisco IOS software. Table 23 shows two keyword shortcuts to URLs. source-url Location URL or alias of the source file or directory to be copied; see the “Usage Guidelines” section for additional information. destination-url Destination URL or alias of the copied file or directory; see the “Usage Guidelines” section for additional information. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. copy /noverify CF-138 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 24 through Table 26 list aliases by file system type. If you do not specify an alias, the system looks for a file in the current directory. Table 24 lists the URL prefix aliases for special (opaque) file systems, Table 25 lists the URL prefix aliases for network file systems, and Table 26 lists the URL prefix aliases for local writable storage file systems. Table 23 Common Keyword Aliases to URLs Keyword Source or Destination running-config (Optional) Specifies the alias for the system:running-config URL. This keyword does not work in the more and show file command syntaxes. startup-config (Optional) Specifies the alias for the nvram:startup-config URL. The nvram:startup-config keyword represents the configuration file that is used during initialization (startup). This file is contained in NVRAM. This keyword does not work in more and show file EXEC command syntaxes. Table 24 URL Prefix Aliases for Special File Systems Alias Source or Destination flh: Source URL for Flash load helper log files. nvram: Router NVRAM. You can copy the startup configuration into or from NVRAM. You can also display the size of a private configuration file. null: Null destination for copies or files. You can copy a remote file to null to determine its size. system: Source or destination URL for system memory, which includes the running configuration. xmodem: Source destination for the file from a network device that uses the Xmodem protocol. ymodem: Source destination for the file from a network device that uses the Ymodem protocol. Table 25 URL Prefix Aliases for Network File Systems Alias Source or Destination ftp: Source or destination URL for an FTP network server. The syntax for this alias is as follows: ftp:[[[//username [:password]@]location]/directory]/filename. rcp: Source or destination URL for an rcp network server. The syntax for this alias is as follows: rcp:[[[//username@]location]/directory]/filename. tftp: Source or destination URL for a TFTP network server. The syntax for this alias is tftp:[[//location]/directory]/filename. copy /noverify CF-139 Cisco IOS Configuration Fundamentals Command Reference April 2010 You can enter on the command line all necessary source- and destination-URL information and the username and password to use, or you can enter the copy command and have the switch prompt you for any missing information. If you enter information, choose one of the following three options: running-config, startup-config, or a file system alias (see Table 23 through Table 26). The location of a file system dictates the format of the source or destination URL. The colon is required after the alias. However, earlier commands that do not require a colon remain supported but are unavailable in context-sensitive help. The entire copying process may take several minutes and differs from protocol to protocol and from network to network. In the alias syntax for ftp:, rcp:, and tftp:, the location is either an IP address or a hostname. The filename is specified for the directory that is used for file transfers. Enter the file verify auto command to set up verification globally. Examples This example shows how to disable the automatic image verification for the current copy operation: Router# copy /noverify tftp: sup-bootflash: ................................................. Table 26 URL Prefix Aliases for Local Writable Storage File Systems Alias Source or Destination bootflash: Source or destination URL for boot flash memory. disk0: and disk1: Source or destination URL of rotating media. flash: Source or destination URL for Flash memory. This alias is available on all platforms. For platforms that lack a Flash: device, note that flash: is aliased to slot0:, allowing you to refer to the main Flash memory storage area on all platforms. slavebootflas h: Source or destination URL for internal Flash memory on the slave RSP card of a device that is configured for HSA. slaveram: NVRAM on a slave RSP card of a device that is configured for HSA. slavedisk0: Source or destination URL of the first PCMCIA card on a slave RSP card of a device that is configured for HSA. slavedisk1: Source or destination URL of the second PCMCIA slot on a slave RSP card of a device that is configured for HSA. slaveslot0: Source or destination URL of the first PCMCIA card on a slave RSP card of a router configured for HSA—Available on systems that are configured with a Supervisor Engine 2. slaveslot1: Source or destination URL of the second PCMCIA slot on a slave RSP card of a router configured for HSA—Available on systems that are configured with a Supervisor Engine 2. slot0: Source or destination URL of the first PCMCIA Flash memory card—Available on systems that are configured with a Supervisor Engine 2. slot1: Source or destination URL of the second PCMCIA Flash memory card—Available on systems that are configured with a Supervisor Engine 2. copy /noverify CF-140 Cisco IOS Configuration Fundamentals Command Reference April 2010 [OK - 24301348 bytes] 24301348 bytes copied in 157.328 secs (154463 bytes/sec) Router# Related Commands Command Description file verify auto Verifies the compressed Cisco IOS image checksum. verify Verifies the checksum of a file on a Flash memory file system or compute an MD5 signature for a file. databits CF-141 Cisco IOS Configuration Fundamentals Command Reference April 2010 databits To set the number of data bits per character that are interpreted and generated by the router hardware, use the databits command in line configuration mode. To restore the default value, use the no form of the command. databits {5 | 6 | 7 | 8} no databits Syntax Description Defaults Eight data bits per character Command Modes Line configuration Command History Usage Guidelines The databits line configuration command can be used to mask the high bit on input from devices that generate 7 data bits with parity. If parity is being generated, specify 7 data bits per character. If no parity generation is in effect, specify 8 data bits per character. The other keywords are supplied for compatibility with older devices and generally are not used. Examples The following example sets the number of data bits per character to seven on line 4: Router(config)# line 4 Router(config-line)# databits 7 Related Commands 5 Five data bits per character. 6 Six data bits per character. 7 Seven data bits per character. 8 Eight data bits per character. This is the default. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description data-character-bits Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software. databits CF-142 Cisco IOS Configuration Fundamentals Command Reference April 2010 terminal databits Changes the number of data bits per character for the current terminal line for this session. terminal data-character-bits Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session. Command Description data-character-bits CF-143 Cisco IOS Configuration Fundamentals Command Reference April 2010 data-character-bits To set the number of data bits per character that are interpreted and generated by the Cisco IOS software, use the data-character-bits command in line configuration mode. To restore the default value, use the no form of this command. data-character-bits {7 | 8} no data-character-bits Syntax Description Defaults Eight data bits per character Command Modes Line configuration Command History Usage Guidelines The data-character-bits line configuration command is used primarily to strip parity from X.25 connections on routers with the protocol translation software option. The data-character-bits line configuration command does not work on hard-wired lines. Examples The following example sets the number of data bits per character to seven on virtual terminal line (vty) 1: Router(config)# line vty 1 Router(config-line)# data-character-bits 7 Related Commands 7 Seven data bits per character. 8 Eight data bits per character. This is the default. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal data-character-bits Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session. default-value exec-character-bits CF-144 Cisco IOS Configuration Fundamentals Command Reference April 2010 default-value exec-character-bits To define the EXEC character width for either 7 bits or 8 bits, use the default-value exec-character-bits command in global configuration mode. To restore the default value, use the no form of this command. default-value exec-character-bits {7 | 8} no default-value exec-character-bits Syntax Description Defaults 7-bit ASCII character set Command Modes Global configuration Command History Usage Guidelines Configuring the EXEC character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can also cause failures. If a user on a terminal that is sending parity enters the help command, an “unrecognized command” message appears because the system is reading all 8 bits, although the eighth bit is not needed for the help command. Examples The following example selects the full 8-bit ASCII character set for EXEC banners and prompts: Router(config)# default-value exec-character-bits 8 Related Commands 7 Selects the 7-bit ASCII character set. This is the default. 8 Selects the full 8-bit ASCII character set. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description default-value special-character-bits Configures the flow control default value from a 7-bit width to an 8-bit width. exec-character-bits Configures the character widths of EXEC and configuration command characters. length Sets the terminal screen length. terminal exec-character-bits Locally changes the ASCII character set used in EXEC and configuration command characters for the current session. terminal special-character-bits Changes the ASCII character widths to accept special characters for the current terminal line and session. default-value special-character-bits CF-145 Cisco IOS Configuration Fundamentals Command Reference April 2010 default-value special-character-bits To configure the flow control default value from a 7-bit width to an 8-bit width, use the default-value special-character-bits command in global configuration mode. To restore the default value, use the no form of this command. default-value special-character-bits {7 | 8} no default-value special-character-bits Syntax Description Defaults 7-bit character set Command Modes Global configuration Command History Usage Guidelines Configuring the special character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on. Examples The following example selects the full 8-bit special character set: Router(config)# default-value special-character-bits 8 Related Commands 7 Selects the 7-bit character set. This is the default. 8 Selects the full 8-bit character set. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description default-value exec-character-bits Defines the EXEC character width for either 7 bits or 8 bits. exec-character-bits Configures the character widths of EXEC and configuration command characters. length Sets the terminal screen length. terminal exec-character-bits Locally changes the ASCII character set used in EXEC and configuration command characters for the current session. terminal special-character-bits Changes the ASCII character widths to accept special characters for the current terminal line and session. define interface-range CF-146 Cisco IOS Configuration Fundamentals Command Reference April 2010 define interface-range To create an interface-range macro, use the define interface-range command in global configuration mode. define interface-range macro-name interface-range Syntax Description Defaults This command has no default settings. Command Modes Global configuration Command History Usage Guidelines The macro name is a 32-character maximum character string. Amn interface range for a macro can contain up to five ranges. An interface range cannot span slots. Use this format when entering the interface-range: • interface-type slot/first-interface - last-interface Valid values for card-type are as follows: • ethernet • fastethernet • gigabitethernet • loopback • tengigabitethernet • tunnel • vlan vlan-id (valid values are from 1 to 4094) • port-channel interface-number (valid values are from 1 to 256) • ge-wan—supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2 • pos—supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2 • atm—supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2 macro-name Name of the interface range macro; the macro name can contain up to 32 characters. interface-range Interface range. For a list of valid values for interface ranges, see the “Usage Guidelines” section. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. define interface-range CF-147 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to create a multiple-interface macro: Router(config)# define interface-range macro1 ethernet 1/2 - 5, fastethernet 5/5 - 10 Router(config)# Related Commands Command Description interface range Executes a command on multiple ports at the same time. delete CF-148 Cisco IOS Configuration Fundamentals Command Reference April 2010 delete To delete a file on a Flash memory device or NVRAM, use the delete command in EXEC, privileged EXEC, or diagnostic mode. delete url [/force | /recursive] Syntax Description Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines If you attempt to delete the configuration file or image specified by the CONFIG_FILE or BOOTLDR environment variable, the system prompts you to confirm the deletion. Also, if you attempt to delete the last valid system image specified in the BOOT environment variable, the system prompts you to confirm the deletion. When you delete a file in Flash memory, the software simply marks the file as deleted, but it does not erase the file. To later recover a “deleted” file in Flash memory, use the undelete EXEC command. You can delete and undelete a file up to 15 times. url Cisco IOS File System URL of the file to be deleted. Include the file system prefix, followed by a colon, and, optionally, the name of a file or directory. See Table 27 for list of supported URLs. /force (Optional) Deletes the specified file or directory without prompting you for verification. Note Use this keyword with caution: the system will not ask you to confirm the file deletion. /recursive (Optional) Deletes all files in the specified directory, as well as the directory itself. Release Modification 11.0 This command was introduced. 12.3(14)T The usbflash[0-9]: and usbtoken[0-9]: options were added to the list of Cisco IOS File System URLs. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Routers and the following enhancements were introduced: • This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR1000 Series Routers. • The harddisk:, obfl:, stby-bootflash:, stby-harddisk:, stby-nvram:, stby-obfl:, stby-usb[0-1]:, and usb[0-1]: url options were introduced. delete CF-149 Cisco IOS Configuration Fundamentals Command Reference April 2010 To permanently delete all files marked “deleted” on a linear Flash memory device, use the squeeze EXEC command. Table 27 contains a list of Cisco IOS File System URLs. Examples The following example deletes the file named test from the Flash card inserted in slot 0: Router# delete slot0:test Delete slot0:test? [confirm] Related Commands Table 27 URL File System Prefix Keywords Prefix Filesystem bootflash: Delete the file from boot Flash memory. flash: Delete the file from Flash memory. harddisk: Delete the file from the harddisk file system. nvram: Delete the from the router NVRAM. obfl: Delete the file from the onboard failure logging file system. slot0: Delete the file from the first PCMCIA Flash memory card. stby-bootflash: Delete the file from the standby bootflash file system. stby-harddisk: Delete the file from the standby harddisk file system. stby-nvram: Delete the from the router NVRAM on the standby hardware. stby-obfl: Delete the file from the onboard failure logging file system on the standby hardware. stby-usb[0-1]: Delete the file from the standby USB Flash drive. usb[0-1]; Delete the file from the USB Flash drive. usbflash[0-9]: Delete the file from the USB Flash drive. usbtoken[0-9]: Delete the file from the USB eToken. Command Description cd Changes the default directory or file system. dir Displays a list of files on a file system. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. squeeze Permanently deletes Flash files by squeezing a Class A Flash file system. undelete Recovers a file marked “deleted” on a Class A or Class B Flash file system. diag CF-150 Cisco IOS Configuration Fundamentals Command Reference April 2010 diag To perform field diagnostics on a line card, on the Gigabit Route Processor (GRP), on the Switch Fabric Cards (SFCs), and on the Clock Scheduler Card (CSC) in Cisco 12000 series Gigabit Switch Routers (GSRs), use the diag command in privileged EXEC mode. To disable field diagnostics on a line card, use the no form of this command. diag slot-number [halt | previous | post | verbose [wait] | wait] no diag slot-number Syntax Description Defaults No field diagnostics tests are performed on the line card. Command Modes Privileged EXEC Command History Usage Guidelines The diag command must be executed from the GRP main console port. Perform diagnostics on the CSC only if a redundant CSC is in the router. slot-number Slot number of the line card you want to test. Slot numbers range from 0 to 11 for the Cisco 12012 and 0 to 7 for the Cisco 12008 router. Slot numbers for the CSC are 16 and 17, and for the FSC are 18, 19, and 20. halt (Optional) Stops the field diagnostic testing on the line card. previous (Optional) Displays previous test results (if any) for the line card. post (Optional) Initiates an EPROM-based extended power-on self-test (EPOST) only. The EPOST test suite is not as comprehensive as the field diagnostics, and a pass/fail message is the only message displayed on the console. verbose [wait] (Optional) Enables the maximum status messages to be displayed on the console. By default, only the minimum status messages are displayed on the console. If you specify the optional wait keyword, the Cisco IOS software is not automatically reloaded on the line card after the test completes. wait (Optional) Stops the automatic reloading of the Cisco IOS software on the line card after the completion of the field diagnostic testing. If you use this keyword, you must use the microcode reload slot global configuration command, or manually remove and insert the line card (to power it up) in the slot so that the GRP will recognize the line card and download the Cisco IOS software image to the line card. Release Modification 11.2 GS This command was introduced to support the Cisco 12000 series GSR. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. diag CF-151 Cisco IOS Configuration Fundamentals Command Reference April 2010 Diagnostics will stop and ask you for confirmation before altering the router’s configuration. For example, running diagnostics on a SFC or CSC will cause the fabric to go from full bandwidth to one-fourth bandwidth. Bandwidth is not affected by GRP or line card diagnostics. The field diagnostic software image is bundled with the Cisco IOS software and is downloaded automatically from the GRP to the target line card prior to testing. Caution Performing field diagnostics on a line card stops all activity on the line card. Before the diag EXEC command begins running diagnostics, you are prompted to confirm the request to perform field diagnostics on the line card. In normal mode, if a test fails, the title of the failed test is displayed on the console. However, not all tests that are performed are displayed. To view all the tests that are performed, use the verbose keyword. After all diagnostic tests are completed on the line card, a PASSED or TEST FAILURE message is displayed. If the line card sends a PASSED message, the Cisco IOS software image on the line card is automatically reloaded unless the wait keyword is specified. If the line card sends a TEST FAILURE message, the Cisco IOS software image on the line card is not automatically reloaded. If you want to reload the line card after it fails diagnostic testing, use the microcode reload slot global configuration command. Note When you stop the field diagnostic test, the line card remains down (that is, in an unbooted state). In most cases, you stopped the testing because you need to remove the line card or replace the line card. If that is not the case, and you want to bring the line card back up (that is, online), you must use the microcode reload global configuration command or power cycle the line card. If the line card fails the test, the line card is defective and should be replaced. In future releases this might not be the case because DRAM and SDRAM SIMM modules might be field replaceable units. For example, if the DRAM test failed you might only need to replace the DRAM on the line card. For more information, refer to the Cisco 12000 series installation and configuration guides. Examples In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3. After the line card passes all field diagnostic tests, the Cisco IOS software is automatically reloaded on the card. Before starting the diagnostic tests, you must confirm the request to perform these tests on the line card because all activity on the line card is halted. The total/indiv. timeout set to 600/220 sec. message indicates that 600 seconds are allowed to perform all field diagnostics tests, and that no single test should exceed 220 seconds to complete. Router# diag 3 Running Diags will halt ALL activity on the requested slot. [confirm] Router# Launching a Field Diagnostic for slot 3 Running DIAG config check RUNNING DIAG download to slot 3 (timeout set to 400 sec.) sending cmd FDIAG-DO ALL to fdiag in slot 3 (total/indiv. timeout set to 600/220 sec.) Field Diagnostic PASSED for slot 3 Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3 last test failed was 0, error code 0 diag CF-152 Cisco IOS Configuration Fundamentals Command Reference April 2010 sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3 Board will reload . . . Router# In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3 in verbose mode: Router# diag 3 verbose Running Diags will halt ALL activity on the requested slot. [confirm] Router# Launching a Field Diagnostic for slot 3 Running DIAG config check RUNNING DIAG download to slot 3 (timeout set to 400 sec.) sending cmd FDIAG-DO ALL to fdiag in slot 3 (total/indiv. timeout set to 600/220 sec.) FDIAG_STAT_IN_PROGRESS: test #1 R5K Internal Cache FDIAG_STAT_PASS test_num 1 FDIAG_STAT_IN_PROGRESS: test #2 Sunblock Ordering FDIAG_STAT_PASS test_num 2 FDIAG_STAT_IN_PROGRESS: test #3 Dram Datapins FDIAG_STAT_PASS test_num 3 . . . Field Diags: FDIAG_STAT_DONE Field Diagnostic PASSED for slot 3 Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3 last test failed was 0, error code 0 sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3 Board will reload . . . Router# Related Commands Command Description microcode reload Reloads the Cisco IOS image on a line card on the Cisco 7000 series with RSP7000, Cisco 7500 series, or Cisco 12000 series routers after all microcode configuration commands have been entered. diagnostic bootup level CF-153 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic bootup level To set the diagnostic bootup level, use the diagnostic bootup level command in global configuration mode. To skip all diagnostic tests, use the no form of this command. diagnostic bootup level {minimal | complete} no diagnostic bootup level Syntax Description Command Default None Command Modes Global configuration (config) Command History Usage Guidelines Setting the diagnostic level determines the level of testing that occurs when the system or module is reset. The two levels are as follows: • Complete—Runs all tests. • Minimal—Runs only EARL tests for the supervisor engine and loopback tests for all ports in the system. Note Although the default is minimal, you can set the diagnostic level to complete for troubleshooting hardware problems. In certain circumstances, you might want to skip the bootup online diagnostics completely. For example, you might skip the bootup online diagnostics to verify that a port is as bad as online diagnostics reports. To skip online diagnostic testing completely, use the no diagnostic bootup level command. For information on the diagnostic test types, use the show diagnostic command. minimal Specifies minimal diagnostics. See the Usage Guidelines section for additional information. complete Specifies complete diagnostics. See the Usage Guidelines section for additional information. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. diagnostic bootup level CF-154 Cisco IOS Configuration Fundamentals Command Reference April 2010 The new level takes effect at the next reload or the next time that an online insertion and removal is performed. Examples The following example shows how to set the diagnostic bootup level: Router(config)# diagnostic bootup level complete Related Commands Command Description show diagnostic bootup level Displays the coverage level for the configured bootup diagnostics. diagnostic cns CF-155 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic cns To configure the Cisco Networking Services (CNS) diagnostics, use the diagnostic cns command in global configuration mode. To disable sending diagnostic results to the CNS event bus., use the no form of this command. diagnostic cns {publish | subscribe} [subject] no diagnostic cns {publish | subscribe} [subject] Syntax Description Defaults This command has no default settings. Command Modes Global configuration Command History Usage Guidelines The online diagnostics receive events by subscribing to an event subject name. The subject is the event that you subscribe (receive) or publish (generate) through the CNS bus. The diagnostic cns publish command sends diagnostic results to a remote network application to make decisions and take corrective actions that are based on the diagnostic results. The diagnostic cns subscribe command receives messages from remote network applications to perform diagnostic tests or retrieve diagnostic results. Examples This example shows how to enable the publishing of diagnostic results: Router(config)# diagnostic cns publish Router(config)# This example shows how to receive messages from remote network applications to perform diagnostic tests or retrieve diagnostic results: Router(config)# diagnostic cns subscribe Router(config)# publish Sends diagnostic results to a remote network application to make decisions and take corrective actions that are based on the diagnostic results. subscribe Receives messages from remote network applications to perform diagnostic tests or retrieve diagnostic results. subject (Optional) Event subject name. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA. This command was integrated into Cisco IOS Release 12.2(33)SRA. diagnostic cns CF-156 Cisco IOS Configuration Fundamentals Command Reference April 2010 This example shows how to set the default to publish: Router(config)# default diagnostic cns publish Router(config)# Related Commands Command Description show diagnostic cns Displays the information about the CNS subject. diagnostic event-log size CF-157 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic event-log size To modify the diagnostic event log size dynamically, use the diagnostic event-log size command in global configuration mode. To return to the default settings, use the no form of this command. diagnostic event-log size size no diagnostic event-log size Syntax Description Command Default The event log size is 500 entries. Command Modes Global configuration (config) Command History Usage Guidelines The events are dynamically allocated and stored in a circular queue. You can enter either the default diagnostic event-log size command or the no diagnostic event-log size command to return to the default settings. Examples The following example shows how to set the diagnostic event-log size: Router(config)# diagnostic event-log size 600 Related Commands size Diagnostic event-log sizes. The valid values range from 1 to 10000 entries. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA. This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. Command Description show diagnostic events Displays the event log for the diagnostic events. diagnostic level CF-158 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic level To turn on power-on diagnostic tests for the network service engines (NSEs) installed in a Cisco 7300 series router, use the diagnostic level command in privileged EXEC configuration mode. There is no no form of this command. diagnostic level {power-on | bypass} Syntax Description Defaults No diagnostic tests are performed. Command Modes Privileged EXEC Command History Usage Guidelines Use this command to enable power-on diagnostic tests to run on the installed NSEs of a Cisco 7300 series router when the system is booted. It is recommended that you issue this command only if you are experiencing problems with an NSE and are planning on rebooting the router. Issuing this command causes an increase in the boot time. Examples The following example shows how to enable diagnostic power-on tests: diagnostic level power-on The following sample output shows the output that is displayed upon system bootup after a power cycle or router crash: . . . System Power On Diagnostics DRAM Size ....................128 MB Testing DRAM..................Passed Level2 Cache .................Present Testing Level2 Cache (256 KB)Passed Level3 Cache .................Present power-on Power-on diagnostic tests are performed at system bootup on the NSEs. bypass No diagnostic tests are performed. This is the default. Release Modification 12.1(10)EX2 This command was introduced. 12.2(18)S This command was introduced on Cisco 7304 routers running Cisco IOS Release 12.2 S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. diagnostic level CF-159 Cisco IOS Configuration Fundamentals Command Reference April 2010 Testing Level3 Cache (1024 KB)Passed System Power On Diagnostics Complete Note This output is displayed when the system is booting, not when the command is issued. Related Commands Command Description debug redundancy Enables NSE redundancy debugging. show c7300 Displays the types of cards (NSE and line cards) installed in a Cisco 7300 series router. show redundancy (7300) Displays redundancy information for the active and standby NSEs. diagnostic monitor CF-160 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic monitor To configure health-monitoring diagnostic testing, use the diagnostic monitor command in global configuration mode. To disable testing, use the no form of this command. diagnostic monitor interval {module num} test {test-id | test-id-range | all} [hour hh] [min mm] [second ss] [millisec ms] [day day] diagnostic monitor syslog diagnostic monitor {module num} test {test-id | test-id-range | all} no diagnostic monitor {interval | syslog} Cisco UBR10012 Router diagnostic monitor {bay slot/bay | slot slot-no | subslot slot/sub-slot} test {test-id | test-id-range | all} diagnostic monitor interval {bay slot/bay | slot slot-no | subslot slot/sub-slot} test {test-id | test-id-range | all} {hh:mm:ss} {milliseconds} {number-of-days} diagnostic monitor syslog diagnostic monitor threshold {bay slot/bay | slot slot-no | subslot slot/sub-slot} test {test-id | test-id-range | all} {failure count no-of-allowed-failures} Syntax Description interval Sets the interval between testing. module num Specifies the module number. test Specifies a test to run. test-id Identification number for the test to run. See the Usage Guidelines section for additional information. test-id-range Range of identification numbers for tests to be run. run. See the Usage Guidelines section for additional information. all Runs all the diagnostic tests. hour hh (Optional) Specifies the number of hours between tests. See the Usage Guidelines section for formatting guidelines. min mm (Optional) Specifies the number of minutes between tests. See the Usage Guidelines section for formatting guidelines. second ss (Optional) Specifies the number of seconds between tests. See the Usage Guidelines section for formatting guidelines. millisec ms (Optional) Specifies the number of milliseconds between tests; see the “Usage Guidelines” section for formatting guidelines. day day (Optional) Specifies the number of days between tests. See the Usage Guidelines section for formatting guidelines. syslog Enables system logging messages when a health-monitoring test fails. diagnostic monitor CF-161 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default The defaults are as follows: • Depending on the test run, monitoring may be enabled or disabled. • Depending on the test run, the default monitoring interval varies. • syslog is enabled. Command Modes Global configuration (config) Command History Usage Guidelines Use these guidelines when scheduling testing: • test-id—Enter the show diagnostic content command to display the test ID list. • test-id-range—Enter the show diagnostic content command to display the test ID list. Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). • hh—Enter the hours from 1 to 24. bay slot/bay Indicates the card slot and bay number where the diagnostic test is run periodically and monitored. The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from 1 to 8 and 0 to 3 for the bay number. slot slot-no Indicates the slot number of the full-height line card where the diagnostic test is run periodically and monitored. The slot keyword is used to refer a full-height line card on the router. The valid range for the slot is from 1 to 8. subslot slot/sub-slot Indicates the slot and subslot number of half-height line card on which the diagnostic test is run periodically and monitored. The subslot keyword is used to refer a half-height line card on the router. The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number. threshold Configures the failure threshold value for the specified bay, slot, or subslot. failure count no-of-allowed-fail ures Configures the count for maximum failures allowed after which the failed test results are displayed in the output of the show diagnostic results command. The range for number of allowed failures is 0 to 99. hh:mm:ss Hours, minutes, and seconds interval configured to run the test again. milliseconds Number of milliseconds between tests. no-of -days Number of days between tests. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. The keywords bay, slot, and subslot were added for the Cisco UBR10012 Universal Broadband Router. diagnostic monitor CF-162 Cisco IOS Configuration Fundamentals Command Reference April 2010 • mm—Enter the minutes from 1 to 60. • day—Enter the day of the week as a number from 1 to 7 (1 is Sunday). • ss—Enter the seconds from 1 to 60. • ms—Enter the milliseconds from 1 to 1000. Enter the [no] diagnostic monitor test {test-id | test-id-range | all} command to enable or disable the specified health monitoring test. When entering the diagnostic monitor {module num} test {test-id | test-id-range | all} command, observe the following: • Required – Isolate network traffic by disabling all connected ports and do not pump test packets during the test. – Remove all modules for testing FIB TCAM and SSRAM memory on the PFC of the supervisor engine. – Reset the system or the test module before putting the system back into the normal operating mode. • Recommended – If the DFC module is present, remove all modules, and then reboot the system before starting the memory test on the central PFC3B of the supervisor engine. – Turn off all background health-monitoring tests on the supervisor engine and the modules using the no diagnostic monitor {module num} test {test-id | test-id-range | all} command. The FIB TCAM test for central PFC3BXL or PFC3B (on the supervisor engine) takes approximately 4 hours and 30 minutes. The FIB TCAM test for the distributed PFC3BXL or PFC3B (on the DFC module) takes approximately 16 hours. You can run the FIB TCAM test on multiple DFC3BX modules simultaneously. Cisco UBR10012 Router The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA. To monitor a diagnostic test periodically, you first need to configure the hours, minutes, and seconds interval to run the diagnostic test using the diagnostic monitor interval command. An error message is displayed, if the interval is not configured before enabling the monitoring. To store log details for failed tests, execute the diagnostic monitor syslog command. A threshold value to specify the maximum count for allowed failures is configured using the diagnostic monitor threshold command. The failed test results can be viewed using the show diagnostic results command, after the number of failed test reaches the maximum number of allowed failures configured using the diagnostic monitor threshold command. diagnostic monitor CF-163 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to run the specified test every 3 days, 10 hours, and 2 minutes: Router(config)# diagnostic monitor interval module 1 test 1 day 3 hours 10 min 2 The following example shows how to enable the generation of a syslog message when any health-monitoring test fails: Router(config)# diagnostic monitor syslog Cisco UBR10012 Router The following example shows a sample output of an error message displayed when monitoring is enabled before configuring the test interval: Router(config)# diagnostic monitor bay 1/0 test 2 Aug 12 18:04:56.280: %DIAG-3-MONITOR_INTERVAL_ZERO: Bay 1/0: Monitoring interval is 0. Cannot enable monitoring for Test #2 The following example shows how to configure the periodic interval for running diagnostic tests on the the router before enabling monitoring: Router(config)# diagnostic monitor interval bay 1/0 test 2 06:00:00 100 10 The following example shows how to enable the diagnostic monitoring on bay 1/0: Router(config)# diangostic monitor bay 1/0 test 2 The following example shows how to enable logging of failed messages to syslog: Router(config)# diangostic monitor syslog The following example shows how to configure the failure threshold value after which the failed test results are displayed in the command output for show diagnostic results: Router(config)# diagnostic monitor threshold bay 1/0 test 2 failure count 10 Related Commands Command Description show diagnostic content Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all modules. diagnostic ondemand CF-164 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic ondemand To configure the on-demand diagnostics, use the diagnostic ondemand command in privileged EXEC mode. diagnostic ondemand {iteration iteration-count | action-on-failure {continue error-count | stop}} Syntax Description Command Default The default settings are as follows: • iteration-count is 1. • action-on-error is continue. • error-count is 0. Command Modes Privileged EXEC (#) Command History Usage Guidelines Entering 0 for the error-count sets the number of errors that are allowed to unlimited. iteration iteration-count Sets the number of times the same test to rerun when the command is issued. The valid range for iteration-count is between 1 to 999. action-on-failure Sets the execution action when a failure is detected. continue Continues testing when a test failure is detected. stop Stops testing when a test failure is detected. error-count (Optional) Number of errors that are allowed before stopping. This argument is used with the continue option. The valid range for error-count is from 0 to 65534. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. diagnostic ondemand CF-165 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to set the ondemand testing iteration count: Router# diagnostic ondemand iteration 4 Router# The following example shows how to set the execution action when an error is detected: Router# diagnostic ondemand action-on-failure continue 2 Router# Related Commands Command Description show diagnostic ondemand settings Displays the settings for on-demand diagnostics. diagnostic schedule test CF-166 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic schedule test To set the scheduling of test-based diagnostic testing for a specific module or schedule a supervisor engine switchover, use the diagnostic schedule test command in global configuration mode. To remove the scheduling, use the no form of this command. diagnostic schedule module {num | active-sup-slot} test {test-id | test-id-range | all} [port {num | num-range | all}] {on mm dd yyyy hh:mm | daily hh:mm} | weekly day-of-week hh:mm} no diagnostic schedule test Syntax Description Defaults This command has no default settings. Command Modes Global configuration Command History module num Specifies the module number. module active-sup-slot Specifies the slot number of the active supervisor engine. test-id Identification number for the test to be run; see the “Usage Guidelines” section for additional information. test-id-range Range of identification numbers for tests to be run; see the “Usage Guidelines” section for additional information. all Runs all diagnostic tests. port (Optional) Specifies the port to schedule testing. num (Optional) Port number. num-range (Optional) Range of port numbers, separated by a hyphen. all Specifies all ports. on mm dd yyyy hh:mm Specifies the scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines. daily hh:mm Specifies the daily scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines. weekly day-of-week hh:mm Specifies the weekly scheduling of a test-based diagnostic task; see the “Usage Guidelines” section for formatting guidelines. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17b)SXA This command was changed to support scheduled switchover for supervisor engines. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. diagnostic schedule test CF-167 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines Use these guidelines when scheduling testing: • test-id—Enter the show diagnostic content command to display the test ID list. • test-id-range—Enter the show diagnostic content command to display the test ID list. Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). • num-range—Enter the range as integers separated by a comma and a hyphen (for example, you can enter 1,3-6 to specify ports 1, 3, 4, 5, and 6). • mm—Spell out the month such as january, february ... december (either uppercase or lowercase characters). • dd—Enter the day as a 2-digit number. • yyyy—Enter the year as a 4-digit number. • hh:mm—Enter the time as a 2-digit number (for a 24-hour clock) for hours:minutes; the colon (:) is required. • day-of-week—Spell out the day of the week, such as monday, tuesday... sunday (either uppercase or lowercase characters). • port {num | num-range | all}—Is not supported when specifying a scheduled switchover. Enter the show diagnostic content command to display the test ID list. You can use the diagnostic schedule module active-sup-slot test test-id command to schedule a switchover from the active supervisor engine to the standby supervisor engine. Enter the show diagnostic content active-sup-slot command to display the test ID list and look for the test ID in the ScheduleSwitchover field. You can specify a periodic switchover (daily or weekly) or a single switchover occurrence at a specific time using these commands: • diagnostic schedule module active-sup-slot test test-id on mm dd yyyy hh:mm • diagnostic schedule module active-sup-slot test test-id daily hh:mm • diagnostic schedule module active-sup-slot test test-id weekly day-of-week hh:mm Note To avoid system downtime in the event that the standby supervisor engine cannot switch over the system, we recommend that you schedule a switchover from the standby supervisor engine to the active supervisor engine 10 minutes after the switchover occurs. See the “Examples” section for additional information. Examples This example shows how to schedule the diagnostic testing on a specific date and time for a specific module and port: Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 on january 3 2003 23:32 Router(config)# This example shows how to schedule the diagnostic testing to occur daily at a certain time for a specific port and module: Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 daily 12:34 Router(config)# diagnostic schedule test CF-168 Cisco IOS Configuration Fundamentals Command Reference April 2010 This example shows how to schedule the diagnostic testing to occur weekly on a certain day for a specific port and module: Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 weekly friday 09:23 Router(config)# This example shows how to schedule a switchover for the active supervisor engine every Friday at 10:00 pm, and switch the standby supervisor engine back to the active supervisor engine 10 minutes after the switchover occurs. For this example, these conditions apply: • test-id is 32. • The active supervisor engine is in slot 5. • The standby supervisor engine is in slot 6. Related Commands Command Description show diagnostic content Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all modules. show diagnostic schedule Displays the current scheduled diagnostic tasks. diagnostic start CF-169 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic start To run the specified diagnostic test, use the diagnostic start command in privileged EXEC mode. diagnostic start module num test {test-id | test-id-range | minimal | complete | basic | per-port | non-disruptive | all} [port {num | port#-range | all}] diagnostic start system test all Cisco UBR10012 Universal Broadband Router diagnostic start {bay slot/bay | slot slot-no} test {test-id | test-id-range | all | complete | minimal | non-disruptive} diagnostic start {subslot slot/sub-slot} test {test-id | test-id-range | all | complete | minimal | non-disruptive | per-port [port {num | port#-range | all}]} Syntax Description module num Specifies the module number. test Specifies a test to run. test-id Identification number for the test to run. See the Usage Guidelines section for additional information. test-id-range Range of identification numbers for tests to run. See the Usage Guidelines section for additional information. minimal Runs minimal bootup diagnostic tests. complete Runs complete bootup diagnostic tests. basic Runs basic on-demand diagnostic tests. per-port Runs per-port level tests. non-disruptive Runs the non disruptive health-monitoring tests. all Runs all diagnostic tests. port num (Optional) Specifies the interface port number. port port#-range (Optional) Specifies the interface port number range. See the Usage Guidelines section for additional information. port all (Optional) Specifies all ports. system test all Runs all disruptive and nondisruptive diagnostic tests at once. All test dependencies are handled automatically. bay slot/bay Indicates the card slot and bay number where the diagnostic test is executed. The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from 1 to 8 and 0 to 3 for the bay number. slot slot-no Indicates the slot number of the full-height line card where the diagnostic test is executed. The slot keyword is used to refer a full-height line card on the router. The valid range for slot is from 1 to 8. subslot slot/sub-slot Indicates the slot and subslot number of half-height line card where the diagnostic test is executed. The subslot keyword is used to refer a half-height line card on the router. The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number. diagnostic start CF-170 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default None Command Modes Privileged EXEC (#) Command History Usage Guidelines Note Running all online diagnostic tests disrupts normal system operation. Reset the system after the diagnostic start system test all command has completed. Do not insert, remove, or power down line cards or the supervisor while the system test is running. Do not issue any diagnostic command other than the diagnostic stop system test all command while the system test is running. Make sure no traffic is running in background. Note Do not enter the diagnostic start module x test all command on systems that are configured with a DFC3A because this command causes the TCAM test to fail. Enter the show diagnostic content command to display the test ID list. Enter the test-id-range or port#-range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). Use diagnostic stop command to stop the testing process. Cisco UBR10012 Router The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA. Note To start a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stop with the bay, slot or subslot keyword respectively. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17a)SX This command was changed to include the complete and basic keywords. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2.(33)SXH This command was changed to include the system test all keywords. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. The keywords bay, slot, and subslot were added for the Cisco UBR10012 Universal Broadband Router. diagnostic start CF-171 Cisco IOS Configuration Fundamentals Command Reference April 2010 The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and Guardian index leak tests. Examples The following example shows how to run the specified diagnostic test at the specified slot: Router# diagnostic start module 1 test 5 Module 1:Running test(s) 5 may disrupt normal system operation Do you want to run disruptive tests? [no] yes 00:48:14:Running OnDemand Diagnostics [Iteration #1] ... 00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ... 00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfully 00:48:14:Running OnDemand Diagnostics [Iteration #2] ... 00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ... 00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfully Router# This example shows how to start all online diagnostic tests: Router# diagnostic start system test all ********************************************************************* * WARNING: * * 'diagnostic start system test all' will disrupt normal system * * operation. The system requires RESET after the command * * 'diagnostic start system test all' has completed prior to * * normal use. * * * * IMPORTANT: * * 1. DO NOT INSERT, OIR, or POWER DOWN Linecards or * * Supervisor while system test is running. * * * * 2. DO NOT ISSUE ANY DIAGNOSTIC COMMAND except * * "diagnostic stop system test all" while system test * * is running. * * * * 3. PLEASE MAKE SURE no traffic is running in background. * ************************************************************************* Do you want to continue? [no]: Cisco UBR10012 Router The following example shows how to run a diagnostic test with test id 2 on a SPA: ubr-122s-1# diagnostic start bay 1/0 test 2 ubr-122s-1# Aug 5 09:24:42.019: %DIAG-6-TEST_RUNNING: Bay 1/0: Running TestModenaLLQDrops{I D=2} ... Aug 5 09:24:42.019: %DIAG-6-TEST_OK: Bay 1/0: TestModenaLLQDrops{ID=2} has comp leted successfully Related Commands Command Description diagnostic schedule Sets the diagnostic test schedule for a particular bay, slot, or subslot. show diagnostic description Provides the description for the diagnostic tests. diagnostic stop Runs the specified diagnostic test. show diagnostic content module Displays the available diagnostic tests. diagnostic start CF-172 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic bootup level Configures the diagnostic bootup level. diagnostic event-log size Modifies the diagnostic event-log size dynamically. diagnostic monitor Configures the health-monitoring diagnostic testing. diagnostic ondemand Configures the on-demand diagnostics. show diagnostic bootup Displays the configured diagnostics level at bootup. show diagnostic events Displays the diagnostic event log. show diagnostic ondemand settings Displays the settings for the on-demand diagnostics. show diagnostic result Displays the diagnostic test results for a module. show diagnostic schedule Displays the current scheduled diagnostic tasks. show diagnostic status Displays the running diagnostics tests. Command Description diagnostic stop CF-173 Cisco IOS Configuration Fundamentals Command Reference April 2010 diagnostic stop To stop the testing process, use the diagnostic stop command in privileged EXEC mode. diagnostic stop module num Cisco UBR10012 Universal Broadband Router diagnostic stop {bay slot/bay | slot slot-no | subslot slot/subslot} Syntax Description Command Default None Command Modes Privileged EXEC (#) Command History Usage Guidelines Use the diagnostic start command to start the testing process. Cisco UBR10012 Router The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA. module num Module number. bay slot/bay Indicates the card slot and bay number of the SPA for which the diagnostic test has stopped. The bay keyword is used to refer a SPA on the router. The valid range for the slot number is from 1 to 8 and 0 to 3 for the bay number. slot slot-no Indicates the slot number of full height line card for which the diagnostic test has to be stopped. The slot keyword is used to refer a full-height line card on the router. Valid range for the slot is from 1 to 8. subslot slot/subslot Indicates the slot and subslot number of half-height line card for which the diagnostic test has to be stopped. The subslot keyword is used to refer a half-height line card on the router. The valid range for the slot number is from 1 to 8 and 0 to 1 for the subslot number. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SCC The command was integrated in this release to support Generic Online Diagnostics (GOLD) functionality for Cisco UBR10012 Universal Broadband Router. The keywords bay, slot, and subslot were added for the Cisco UBR10012 Universal Broadband Router. diagnostic stop CF-174 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note To stop a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stop with the bay, slot or subslot keyword respectively. The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and line card index leak tests. Examples This example shows how to stop the diagnostic test process: Router# diagnostic stop module 3 Router# This example shows how to stop the diagnostic test process for subslot 5/0 on the Cisco UBR10012 Universal Broadband Router: Router# diagnostic stop subslot 5/0 Router# Related Commands Command Description diagnostic schedule Sets the diagnostic test schedule for a particular bay, slot, or subslot. show diagnostic description Provides the description for the diagnostic tests. diagnostic start Stops the specified diagnostic test. show diagnostic content module Displays the available diagnostic tests. diagnostic bootup level Configures the diagnostic bootup level. diagnostic event-log size Modifies the diagnostic event-log size dynamically. diagnostic monitor Configures the health-monitoring diagnostic testing. diagnostic ondemand Configures the on-demand diagnostics. show diagnostic bootup Displays the configured diagnostics level at bootup. show diagnostic events Displays the diagnostic event log. show diagnostic ondemand settings Displays the settings for the on-demand diagnostics. show diagnostic result Displays the diagnostic test results for a module. show diagnostic schedule Displays the current scheduled diagnostic tasks. show diagnostic status Displays the running diagnostics tests. dir CF-175 Cisco IOS Configuration Fundamentals Command Reference April 2010 dir To display a list of files on a file system, use the dir command in EXEC, privileged EXEC, or diagnostic mode. dir [/all] [/recursive] [all-filesystems] [filesystem:][file-url] Syntax Description Defaults The default file system is specified by the cd command. When you omit the /all keyword, the Cisco IOS software displays only undeleted files. Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines Use the show (flash file system) command to display more detail about the files in a particular file system. /all (Optional) Lists deleted files, undeleted files, and files with errors. /recursive (Optional) Lists files recursively. all-filesystems (Optional) Lists all files in all filesystems on the router. filesystem: (Optional) File system or directory containing the files to list, followed by a colon. file-url (Optional) The name of the files to display on a specified device. The files can be of any type. You can use wildcards in the filename. A wildcard character () matches all patterns. Strings after a wildcard are ignored. Release Modification 11.0 This command was introduced. 12.3 A timestamp that shows the offset from Coordinated Universal Time (UTC) was added to the dir command display. 12.3(14)T The usbflash[0-9]: and usbtoken[0-9]: options were added as available file systems. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.4(11)T This command was integrated into the Cisco 7200VXR NPE-G2 platform. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Routers, and the following enhancements were introduced: • The command was made available in diagnostic mode. • The /recursive option was introduced. • The file systems available with the Cisco ASR 1000 Series Routers became available as filesystem: options. dir CF-176 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following is sample output from the dir command: Router# dir slot0: Directory of slot0:/ 1 -rw- 4720148 Dec 29 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz 2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz 5 -rw- 639 Jan 03 2004 12:09:32 -08:00 rally 7 -rw- 639 Jan 03 2004 12:37:13 -08:00 the_time 20578304 bytes total (3104544 bytes free) Router# dir /all slot0: Directory of slot0:/ 1 -rw- 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz 2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz 3 -rw- 7982828 Jan 02 2004 18:48:14 -08:00 [rsp-jsv-mz] 4 -rw- 639 Jan 03 2004 12:09:17 -08:00 the_time] 5 -rw- 639 Jan 03 1994 12:09:32 -08:00 rally 6 -rw- 639 Jan 03 1994 12:37:01 -08:00 [the_time] 7 -rw- 639 Jan 03 1994 12:37:13 -08:00 Table 28 describes the significant fields shown in the output. Related Commands Table 28 dir Field Descriptions Field Description 1 Index number of the file. -rw- Permissions. The file can be any or all of the following: • d—directory • r—readable • w—writable • x—executable 4720148 Size of the file. Dec 15 2003 17:49:36 Last modification date. -08:00 Conversion to local time in hours from Coordinated Universal Time (UTC). In the example, -08:00 indicates that the given time is 8 hours behind UTC or Pacific Standard Time (PST). hampton/nitro/c7200-j-mz Filename. Deleted files are indicated by square brackets around the filename. Command Description cd Changes the default directory or file system. delete Deletes a file on a Flash memory device. undelete Recovers a file marked “deleted” on a Class A or Class B Flash file system. disable CF-177 Cisco IOS Configuration Fundamentals Command Reference April 2010 disable To exit privileged EXEC mode and return to user EXEC mode, or to exit to a lower privilege level, enter the disable command in EXEC, privileged EXEC, or diagnostic mode. disable [privilege-level] Syntax Description Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines Up to 16 security levels can be configured using Cisco IOS software. If such levels are configured on a system, using this command with the privilege-level option allows you to exit to a lower security level. If a level is not specified, the user will exit to the user EXEC mode, which is the default. Note Five EXEC commands are associated with privilege level 0: disable, enable, exit, help, and logout. If you configure a privilege level greater than 0, these five commands will not be included in the command set for that privilege level. Examples In the following example, the user enters privileged EXEC mode using the enable command, then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is >, and the prompt for privileged EXEC mode is #. Router> enable Password: Router# disable Router> Related Commands privilege-level (Optional) Specific privilege level (other than user EXEC mode). Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Routers, and became available in diagnostic mode. Command Description enable Enables higher privilege level access, such as privileged EXEC mode. disconnect-character CF-178 Cisco IOS Configuration Fundamentals Command Reference April 2010 disconnect-character To define a character to disconnect a session, use the disconnect-character command in line configuration mode. To remove the disconnect character, use the no form of this command. disconnect-character ascii-number no disconnect-character Syntax Description Defaults No disconnect character is defined. Command Modes Line configuration Command History Usage Guidelines See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters. The Break character is represented by zero; NULL cannot be represented. To use the session-disconnect character in normal communications, precede it with the escape character. Examples The following example defines the disconnect character for virtual terminal line 4 as Escape, which is decimal character 27: Router(config)# line vty 4 Router(config-line)# disconnect-character 27 ascii-number Decimal representation of the session disconnect character. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. dispatch-character CF-179 Cisco IOS Configuration Fundamentals Command Reference April 2010 dispatch-character To define a character that causes a packet to be sent, use the dispatch-character command in line configuration mode. To remove the definition of the specified dispatch character, use the no form of this command. dispatch-character ascii-number1 [ascii-number2 . . . ascii-number] no dispatch-character ascii-number1 [ascii-number2 . . . ascii-number] Syntax Description Defaults No dispatch character is defined. Command Modes Line configuration Command History Usage Guidelines See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters. The dispatch-character command defines one or more dispatch characters that cause a packet to be sent even if the dispatch timer has not expired. Use of a dispatch character causes the Cisco IOS software to attempt to buffer characters into larger-sized packets for transmission to the remote host. Enable the dispatch-character command from the session that initiates the connection, not from the incoming side of a streaming Telnet session. This command can take multiple arguments, so you can define any number of characters as dispatch characters. Examples The following example defines the Return character (decimal 13) as the dispatch character for virtual terminal line (vty) line 4: Router(config)# line vty 4 Router(config-line)# dispatch-character 13 ascii-number1 Decimal representation of the desired dispatch character. ascii-number2 . . . ascii-number (Optional) Additional decimal representations of characters. This syntax indicates that you can define any number of characters as dispatch characters. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. dispatch-character CF-180 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description dispatch-machine Specifies an identifier for a TCP packet dispatch state machine on a particular line. dispatch-timeout Sets the character dispatch timer. state-machine Specifies the transition criteria for the state of a particular state machine. terminal dispatch-character Defines a character that causes a packet to be sent for the current session. dispatch-machine CF-181 Cisco IOS Configuration Fundamentals Command Reference April 2010 dispatch-machine To specify an identifier for a TCP packet dispatch state machine on a particular line, use the dispatch-machine command in line configuration mode. To disable a state machine on a particular line, use the no form of this command. dispatch-machine name no dispatch-machine Syntax Description Defaults No dispatch state machine identifier is defined. Command Modes Line configuration Command History Usage Guidelines When the dispatch-timeout command is specified, a packet being built will be sent when the timer expires, and the state will be reset to zero. Any dispatch characters specified using the dispatch-character command are ignored when a state machine is also specified. If a packet becomes full, it will be sent regardless of the current state, but the state will not be reset. The packet size depends on the traffic level on the asynchronous line and the dispatch-timeout value. There is always room for 60 data bytes. If the dispatch-timeout value is greater than or equal to 100 milliseconds, a packet size of 536 (data bytes) is allocated. Examples The following example specifies the name linefeed for the state machine: Router(config)# state-machine linefeed 0 0 9 0 Router(config)# state-machine linefeed 0 11 255 0 Router(config)# state-machine linefeed 0 10 10 transmit Router(config)# line 1 Router(config-line)# dispatch-machine linefeed Related Commands name Name of the state machine that determines when to send packets on the asynchronous line. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description dispatch-character Defines a character that causes a packet to be sent. dispatch-machine CF-182 Cisco IOS Configuration Fundamentals Command Reference April 2010 dispatch-timeout Sets the character dispatch timer. state-machine Specifies the transition criteria for the state of a particular state machine. Command Description dispatch-timeout CF-183 Cisco IOS Configuration Fundamentals Command Reference April 2010 dispatch-timeout To set the character dispatch timer, use the dispatch-timeout command in line configuration mode. To remove the timeout definition, use the no form of this command. dispatch-timeout milliseconds no dispatch-timeout Syntax Description Defaults No dispatch timeout is defined. Command Modes Line configuration Command History Usage Guidelines Use this command to increase the processing efficiency for the remote host. The dispatch-timeout line configuration command causes the software to buffer characters into packets for transmission to the remote host. The Cisco IOS software sends a packet a specified amount of time after the first character is put into the buffer. You can use the dispatch-timeout and dispatch-character line configuration commands together. In this case, the software dispatches a packet each time the dispatch character is entered, or after the specified dispatch timeout interval, depending on which condition is met first. Note The system response time might appear intermittent if the timeout interval is greater than 100 milliseconds and remote echoing is used. For lines with a reverse-Telnet connection, use a dispatch-timeout value less than 10 milliseconds. Examples The following example sets the dispatch timer to 80 milliseconds for virtual terminal line (vty) lines 0 through 4: Router(config)# line vty 0 4 Router(config-line)# dispatch-timeout 80 milliseconds Integer that specifies the number of milliseconds (ms) that the Cisco IOS software waits after putting the first character into a packet buffer before sending the packet. During this interval, more characters can be added to the packet, which increases the processing efficiency of the remote host. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. dispatch-timeout CF-184 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description buffer-length Specifies the maximum length of data streams forwarded on a line. dispatch-character Defines a character that causes a packet to be sent. dispatch-machine Specifies an identifier for a TCP packet dispatch state machine on a particular line. state-machine Specifies the transition criteria for the state of a particular state machine. terminal dispatch-timeout Sets the character dispatch timer for the current session. do CF-185 Cisco IOS Configuration Fundamentals Command Reference April 2010 do To execute user EXEC or privileged EXEC commands from global configuration mode or other configuration modes or submodes, use the do command in any configuration mode. do command Syntax Description Command Default A user EXEC or privileged EXEC command is not executed from a configuration mode. Command Modes All configuration modes Command History Usage Guidelines Use this command to execute user EXEC or privileged EXEC commands (such as show, clear, and debug commands) while configuring your routing device. After the EXEC command is executed, the system will return to the configuration mode you were using. Tip This command can be useful for saving your configuration to the startup-config file without having to return to the user EXEC mode or privileged EXEC mode (do copy running-config startup-config) or for checking the status of a feature (using a do show command) while configuring the feature. Caution Do not enter the do command in user EXEC mode or privileged EXEC mode. Interruption of service might occur. You cannot use the do command to execute the configure terminal command because entering the configure terminal command changes the user EXEC mode or privileged EXEC mode to the global configuration mode. You cannot use the do command to execute copy or write commands in the global configuration or any other configuration mode or submode. command The user EXEC or privileged EXEC command to be executed. Release Modification 12.2(8)T This command was introduced. 12.2(14)S This command was integrated into Cisco IOS Release 12.2(14)S. 12.2(14)SX Support for this command was added for the Supervisor Engine 720. 12.2(17a)SX This command was changed to support the copy command restriction. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. do CF-186 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to enter the show interfaces serial privileged EXEC command from within global configuration mode: Router(config)# do show interfaces serial 3/0 Serial3/0 is up, line protocol is up Hardware is M8T-RS232 MTU 1500 bytes, BW 1544 Kbit, DLY 20000 usec, rely 255/255, load 1/255 Encapsulation HDLC, loopback not set, keepalive set (10 sec) Last input never, output 1d17h, output hang never Last clearing of “show interface” counters never . . . The following example shows how to enter the clear vpdn tunnel user EXEC or privileged EXEC command from within VPDN configuration mode: Router(config-vpdn)# do clear vpdn tunnel Related Commands Command Description clear vpdn tunnel Shuts down a specified VPDN tunnel and all sessions within the tunnel. configure terminal Enters global configuration mode. copy Copies any file from a source to a destination. show interfaces Displays statistics for all interfaces configured on the router or access server. write core Tests the configuration of a core dump setup. downward-compatible-config CF-187 Cisco IOS Configuration Fundamentals Command Reference April 2010 downward-compatible-config To generate a configuration that is compatible with an earlier Cisco IOS release, use the downward-compatible-config command in global configuration mode. To disable this function, use the no form of this command. downward-compatible-config version no downward-compatible-config Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines In Cisco IOS Release 10.3, IP access lists changed format. Use the downward-compatible-config command to regenerate a configuration in a format prior to Release 10.3 if you are going to downgrade from your software version to version 10.2 or 10.3. The earliest version value this command accepts is 10.2. When this command is configured, the router attempts to generate a configuration that is compatible with the specified version. Note that this command affects only IP access lists. Under some circumstances, the software might not be able to generate a fully backward-compatible configuration. In such a case, the software issues a warning message. Examples The following example generates a configuration file compatible with Cisco IOS Release 10.2 access lists: Router(config)# downward-compatible-config 10.2 Related Commands version Cisco IOS release number, not earlier than Release 10.2. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description access-list (extended) Provides extended access lists that allow more detailed access lists. access-list (standard) Defines a standard XNS access list. editing CF-188 Cisco IOS Configuration Fundamentals Command Reference April 2010 editing To reenable Cisco IOS enhanced editing features for a particular line after they have been disabled, use the editing command in line configuration mode. To disable these features, use the no form of this command. editing no editing Syntax Description This command has no arguments or keywords. Defaults Enabled Command Modes Line configuration Command History Usage Guidelines Enhanced editing features are enabled by default. However, there may be situations in which you need to disable these features. The no form of this command disables these enhanced editing features, and the plain form of the command can be used to reenable these features. Table 29 provides a description of the keys used to enter and edit commands when the editing features are enabled. Ctrl indicates the Control key, which must be pressed simultaneously with its associated letter key. Esc indicates the Escape key, which must be pressed first, followed by its associated letter key. A comma is used in the following table to indicate a key sequence (the comma key should not be pressed). Keys are not case sensitive. Many letters used for CLI navigation and editing were chosen to provide an easy way of remembering their functions. In the following table (Table 29), characters are bolded in the “Function Summary” column to indicate the relation between the letter used and the function. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. editing CF-189 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 29 Command Editing Keys and Functions Keys Function Summary Function Details Tab Complete command Completes a partial command name entry. When you enter a unique set of characters and press the Tab key, the system completes the command name. If you enter a set of characters that could indicate more than one command, the system beeps to indicate an error. To view the commands which match the set of characters you have entered, enter a question mark (?) immediately following the partial command (no space). The CLI will then list the commands that begin with that string. Return (at the command line) Execute Executes the command. Return (at the --More-- prompt) Continue Displays the next line of output. Space Bar (at the --More-- prompt) Continue Displays the next screen of output. The amount of output you see will depend on the screen depth setting of your terminal. Delete or Backspace Backspace Erases the character to the left of the cursor. Left Arrow1 or Ctrl-B Back character Moves the cursor one character to the left. When you enter a command that extends beyond a single line, you can press the Left Arrow or Ctrl-B keys repeatedly to scroll back toward the system prompt and verify the beginning of the command entry. Right Arrow1 or Ctrl-F Forward character Moves the cursor one character to the right. Esc, B Back word Moves the cursor back one word. Esc, F Forward word Moves the cursor forward one word. Ctrl-A Beginning of line Moves the cursor to the beginning of the line. Ctrl-E End of line Moves the cursor to the end of the command line. Ctrl-D Delete character Deletes the character at the cursor. Esc, D Delete next word Deletes from the cursor to the end of the word. Ctrl-W Delete previous word Deletes the word to the left of the cursor. Ctrl-K Delete line forward Deletes all characters from the cursor to the end of the command line. Ctrl-U or Ctrl-X Delete line backward Deletes all characters from the cursor back to the beginning of the command line. Ctrl-T Transpose characters Transposes the character to the left of the cursor with the character located at the cursor. editing CF-190 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, enhanced editing mode is disabled on line 3: Router(config)# line 3 Router(config-line)# no editing Related Commands Ctrl-R or Ctrl-L Redisplay line Redisplays the system prompt and command line. Ctrl-V or Esc, Q Ignore editing Inserts a code to indicate to the system that the keystroke immediately following should be treated as a command entry, not as an editing key. Up Arrow1 or Ctrl-P Previous command Recalls commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands. Down Arrow1 or Ctrl-N (next) Next command Returns to more recent commands in the history buffer (after recalling commands with the Up Arrow or Ctrl-P). Repeat the key sequence to recall successively more recent commands. Ctrl-Y Recall last deleted command Recalls the most recent entry in the delete buffer. The delete buffer contains the last ten items you have deleted or cut. Ctrl-Y can be used in conjunction with Esc Y. Esc, Y Recall next deleted command Recalls the next entry in the delete buffer. The delete buffer contains the last ten items you have deleted. Press Ctrl-Y first to recall the most recent entry. Then press Esc Y up to nine times to recall the remaining entries in the buffer. If you bypass an entry, continue to press Esc Y to cycle back to it. Esc, C Capitalize word Capitalizes the word from the cursor to the end of the word. Esc, U Make word uppercase Changes all letters from the cursor to the next space on the line appear in uppercase letters. Esc, L Make word lowercase Changes the word to lowercase from the cursor to the end of the word. 1. The arrow keys function only with ANSI-compatible terminals. Table 29 Command Editing Keys and Functions (continued) Keys Function Summary Function Details Command Description terminal editing Controls CLI enhanced editing feature for the current terminal session. enable CF-191 Cisco IOS Configuration Fundamentals Command Reference April 2010 enable To change the privilege level for a CLI session or to use a CLI view for a CLI session, use the enable command in either user EXEC, privileged EXEC, or diagnostic mode. enable [privilege-level] [view [view-name]] Syntax Description Defaults Privilege-level 15 (privileged EXEC) Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic Mode (diag) Command History Usage Guidelines By default, using the enable command without the privilege-level argument in user EXEC mode causes the router to enter privileged EXEC mode (privilege-level 15). Entering privileged EXEC mode enables the use of privileged commands. Because many of the privileged commands set operating parameters, privileged access should be password-protected to prevent unauthorized use. If the system administrator has set a password with the enable password global configuration command, you are prompted to enter the password before being allowed access to privileged EXEC mode. The password is case sensitive. privilege-level (Optional) Privilege level at which to log in. view (Optional) Enters into root view, which enables users to configure CLI views. Note This keyword is required if you want to configure a CLI view. view-name (Optional) Enters or exits a specified command-line interface (CLI) view. This keyword can be used to switch from one CLI view to another CLI view. Release Modification 10.0 This command was introduced. 12.3(7)T The view keyword and view-name argument were added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SRB The view keyword and view-name argument were integrated into Cisco IOS Release 12.2(33)SRB. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(22)SB. Cisco IOS XE Release 2.1 This command became available on the ASR 1000 Series Routers, and became available in diagnostic mode for the first time. enable CF-192 Cisco IOS Configuration Fundamentals Command Reference April 2010 If an enable password has not been set, only enable mode can be accessed through the console connection. Security levels can be set by an administrator using the enable password and privilege level commands. Up to 16 privilege levels can be specified, using the numbers 0 through 15. Using these privilege levels, the administrator can allow or deny access to specific commands. Privilege level 0 is associated with user EXEC mode, and privilege level 15 is associated with privileged EXEC mode. For more information on defined privilege levels, see the Cisco IOS Security Configuration Guide and the Cisco IOS Security Command Reference publications. If a level is not specified when entering the enable command, the user will enter the default mode of privileged EXEC (level 15). Accessing a CLI View CLI views restrict user access to specified CLI and configuration information. To configure and access CLI views, users must first enter into root view, which is accomplished via the enable view command (without the view-name argument). Thereafter, users are prompted for a password, which is the same password as the privilege level 15 password. The view-name argument is used to switch from one view to another view. To prevent dictionary attacks, a user is prompted for a password even if an incorrect view name is given. The user is denied access only after an incorrect view name and password are given. Examples In the following example, the user enters privileged EXEC mode (changes to privilege-level 15) by using the enable command without a privilege-level argument. The system prompts the user for a password before allowing access to the privileged EXEC mode. The password is not printed to the screen. The user then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is the greater than symbol (>), and the prompt for privileged EXEC mode is the number sign (#). Router> enable Password: Router# disable Router> The following example shows which commands are available inside the CLI view “first” after the user has logged into this view: Router# enable view first Password: 00:28:23:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'. Router# ? Exec commands: configure Enter configuration mode enable Turn on privileged commands exit Exit from the EXEC show Show running system information Router# show ? ip IP information parser Display parser information version System hardware and software status enable CF-193 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# show ip ? access-lists List IP access lists accounting The active IP accounting database aliases IP alias table arp IP ARP table as-path-access-list List AS path access lists bgp BGP information cache IP fast-switching route cache casa display casa information cef Cisco Express Forwarding community-list List community-list dfp DFP information dhcp Show items in the DHCP database drp Director response protocol dvmrp DVMRP information eigrp IP-EIGRP show commands extcommunity-list List extended-community list flow NetFlow switching helper-address helper-address table http HTTP information igmp IGMP information irdp ICMP Router Discovery Protocol . . The following example shows how to use the enable view command to switch from the root view to the CLI view “first”: Router# enable view Router# 01:08:16:%PARSER-6-VIEW_SWITCH:successfully set to view 'root'. Router# ! Enable the show parser view command from the root view Router# show parser view Current view is 'root' ! Enable the show parser view command from the root view to display all views Router# show parser view all Views Present in System: View Name: first View Name: second ! Switch to the CLI view “first.” Router# enable view first Router# 01:08:09:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'. ! Enable the show parser view command from the CLI view “first.” Router# show parser view Current view is 'first' Related Commands Command Description disable Exits from privileged EXEC mode to user EXEC mode, or, if privilege levels are set, to the specified privilege level. enable password Sets a local password to control access to various privilege levels. privilege level (global) Sets a privilege level for a command. privilege level (line) Sets a privilege level for a command for a specific line. end CF-194 Cisco IOS Configuration Fundamentals Command Reference April 2010 end To end the current configuration session and return to privileged EXEC mode, use the end command in global configuration mode. end Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes Global configuration Command History Usage Guidelines This command will bring you back to privileged EXEC mode regardless of what configuration mode or configuration submode you are in. Note This global configuration command can be used in any configuration mode. Use this command when you are done configuring the system and you want to return to EXEC mode to perform verification steps. Examples In the following example, the end command is used to exit from ALPS ASCU configuration mode and return to privileged EXEC mode. A show command is used in privileged EXEC mode to verify the configuration. Router# configure terminal Router(config)# interface serial 1:1 Router(config-if)# alps ascu 4B Router(config-alps-ascu)# end Router# show interface serial 1:1 Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description exit (global) Exits from the current configuration mode. environment-monitor shutdown temperature CF-195 Cisco IOS Configuration Fundamentals Command Reference April 2010 environment-monitor shutdown temperature To enable monitoring of the environment sensors, use the environment-monitor shutdown temperature command in global configuration mode. To disable monitoring of the environment sensors, use the no form of this command. environment-monitor shutdown temperature [rommon | powerdown] no environment-monitor shutdown temperature [rommon | powerdown] Syntax Description Defaults By default, rommon is enabled. Command Modes Global configuration Command History Examples This example shows how to place the supervisor engine in ROMMON when a major active alarm occurs: Router(config)# environment-monitor shutdown temperature rommon Router(config)# This example shows how to power down the supervisor engine when a major active alarm occurs: Router(config)# environment-monitor shutdown temperature powerdown Router(config)# rommon (Optional) Places the supervisor engine in ROMMON when a major active alarm is identified. powerdown (Optional) Powers down the supervisor engine when a new active major alarm is identified. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(18)SXF17 Support for powerdown keyword added. 12.2(33)SXH6 Support for powerdown keyword added. environment temperature-controlled CF-196 Cisco IOS Configuration Fundamentals Command Reference April 2010 environment temperature-controlled To enable the ambient temperature control, use the environment temperature-controlled command in global configuration mode. To disable the ambient temperature control, use the no form of this command. environment temperature-controlled no environment temperature-controlled Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes Global configuration Command History Usage Guidelines This command does not affect temperature monitoring and alarm thresholds; it only affects whether a module may be powered on. The software does not validate the inlet temperature. If you enter the no form of this command and the cooling capacity is reduced below the module cooling requirement, a syslog warning (and SNMP alarm) is generated. This module status does not change, and an environmental alarm is not raised when you enter the no form of this command. Examples This example shows how to enable the ambient temperature control: Router(config)# environment temperature-controlled Router(config)# This example shows how to disable the ambient temperature control: Router(config)# no environment temperature-controlled Router(config)# Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. erase CF-197 Cisco IOS Configuration Fundamentals Command Reference April 2010 erase To erase a file system or all files available on a file system, use the erase command in privileged EXEC or diagnostic mode. erase {/all nvram: | /no-squeeze-reserve-space | filesystem: | startup-config} Cisco 7600 Series Routers and Cisco ASR1000 Series Routers erase {/all nvram: | filesystem: | startup-config} Syntax Description Command Modes Privileged EXEC (#) Diagnostic (#) Command History Usage Guidelines The erase nvram: command replaces the write erase command and the erase startup-config command. Caution When you use the erase command to erase a file system, you cannot recover the files in the file system. The word help feature is disabled for the erase command. You must enter the complete command name to enable the command. The parser does not complete the command name if you enter partial syntax of the command and press the Tab key. For more information on the word help feature, refer to the Using the Cisco IOS Command-Line Interface feature guide. The erase command can be used on Class B and Class C flash file systems only. /all Erases all files in the specified file system. filesystem: File system name, followed by a colon. For example, flash: or nvram:. /no-squeeze-reserve-space Disables the squeeze operation to conserve memory and makes the erase command compatible with older file systems. startup-config Erases the contents of the configuration memory. Release Modification 11.0 This command was introduced. 12.2(11)T This command was modified. The /no-squeeze-reserve-space keyword was added. 12.2(14)SX This command was modified. Support for this command was added for the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was modified. The command was introduced in diagnostic mode on the Cisco ASR 1000 Series Routers, and the /all keyword was added. erase CF-198 Cisco IOS Configuration Fundamentals Command Reference April 2010 Class A flash file systems cannot be erased. You can delete individual files using the delete command and then reclaim the space using the squeeze command. You can use the format command to format the flash file system. The format command when used on ATA disk clears the File Allocation Table (FAT) and root directory entries only. The data is not erased. The erase nvram: command erases NVRAM. On Class A file system platforms, if the CONFIG_FILE variable specifies a file in flash memory, the specified file will be marked “deleted.” The erase /all nvram: command erases all files on NVRAM, including private NVRAM. The /no-squeeze-reserve-space keyword is available on systems with small amounts of flash memory in order to conserve memory. When a squeeze operation is performed, the last two erase sectors are permanently reserved for the squeeze logs and squeeze buffer. The /no-squeeze-reserve-space keyword prevents the reservation of space that guarantees the ability to run the squeeze command. Disabling the squeeze operation keeps these memory sectors free. If any sectors using squeeze data are detected, they will be erased when the /no-squeeze-reserve-space keyword is used. The /no-squeeze-reserve-space keyword increases the available amount of usable flash space, but you may not be able to run the squeeze command. This is typically fine if the file system (such as flash) is used to store a single, large file. For example, an IOS image. On Class C flash file systems, space is dynamically reclaimed when you use the delete command. You can also use either the format or erase command to reinitialize a Class C flash file system. Note Use the context-sensitive help to determine which file systems can be used for the erase command. The output will vary based on the platform. Examples The following example shows how to erase the NVRAM, including the startup configuration located there: Router# erase nvram: The following example shows how to erase all of partition 2 in internal flash memory: Router# erase flash:2 System flash directory, partition 2: File Length Name/status 1 1711088 dirt/images/c3600-i-mz [1711152 bytes used, 15066064 available, 16777216 total] Erase flash device, partition 2? [confirm] Are you sure? [yes/no]: yes Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased The following example shows how to erase flash memory when flash is partitioned, but no partition is specified in the command: Router# erase flash: System flash partition information: Partition Size Used Free Bank-Size State Copy-Mode 1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH 2 4096K 2048K 2048K 2048K Read/Write Direct [Type ? for partition directory; ? for full directory; q to abort] Which partition? [default = 2] erase CF-199 Cisco IOS Configuration Fundamentals Command Reference April 2010 The system will prompt only if there are two or more read/write partitions. If the partition entered is not valid or is the read-only partition, the process terminates. You can enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (?number) for directory display of a particular partition. The default is the first read/write partition. System flash directory, partition 2: File Length Name/status 1 3459720 master/igs-bfpx.100-4.3 [3459784 bytes used, 734520 available, 4194304 total] Erase flash device, partition 2? [confirm] Related Commands Command Description boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). delete Deletes a file on a flash memory device. more nvram:startup-config Displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. squeeze Removes all deleted files from the flash file system and recovers the memory space used by deleted files. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. undelete Recovers a file marked “deleted” on a Class A or Class B flash file system. write erase The write erase command is replaced by the erase nvram: command. See the description of the erase command for more information erase bootflash CF-200 Cisco IOS Configuration Fundamentals Command Reference April 2010 erase bootflash The erase bootflash: and erase bootflash commands have identical functions. See the description of the erase command in this chapter for more information. errdisable detect cause CF-201 Cisco IOS Configuration Fundamentals Command Reference April 2010 errdisable detect cause To enable the error-disable detection, use the errdisable detect cause command in global configuration mode. To disable the error-disable detection, use the no form of this command. errdisable detect cause {all | dtp-flap | l2ptguard | link-flap | packet-buffer-error | pagp-flap | udld} no errdisable detect cause {all | dtp-flap | l2ptguard | link-flap | pagp-flap | udld} Syntax Description Defaults Enabled for all causes Command Modes Global configuration Command History Usage Guidelines Note Entering the no errdisable detect cause packet-buffer-error command allows you to detect the fault that triggers a power cycle of the affected module. A cause (bpduguard, dtp-flap, link-flap, pagp-flap, root-guard, udld) is defined as the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in an error-disabled state (an operational state that is similiar to the link-down state). You must enter the shutdown and then the no shutdown commands to recover an interface manually from the error-disable state. all Specifies error-disable detection for all error-disable causes. dtp-flap Specifies detection for the DTP flap error-disable cause. l2ptguard Specifies detection for the Layer 2 protocol-tunnel error-disable cause. link-flap Specifies detection for the link flap error-disable cause. packet-buffer-error Causes the packet buffer error to error-disable the affected port. pagp-flap Specifies detection for the PAgP flap error-disable cause. udld Specifies detection for the UDLD error-disable cause. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17b)SXA This command was changed to include the packet-buffer-error keyword. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. errdisable detect cause CF-202 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to enable the error-disable detection for the Layer 2 protocol-tunnel guard error-disable cause: Router(config)# errdisable detect cause l2ptguard Router(config)# Related Commands Command Description show errdisable detect Displays the error-disable detection status. show interfaces status Displays the interface status or a list of interfaces in an error-disabled state on LAN ports only. errdisable recovery CF-203 Cisco IOS Configuration Fundamentals Command Reference April 2010 errdisable recovery To configure the recovery mechanism variables, use the errdisable recovery command in global configuration mode. To return to the default state, use the no form of this command. errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | l2ptguard | link-flap | pagp-flap | psecure-violation | security-violation | udld | unicast-flood} | interval interval} no errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | l2ptguard | link-flap | pagp-flap | psecure-violation | security-violation | udld | unicast-flood} | interval interval} Syntax Description Command Default The recovery mechanisms are disabled. Command Modes Global configuration Command History cause Enables error-disable recovery from a specific cause. all Enables the recovery timers for all error-disable causes. arp-inspection Enables error-disable recovery from an ARP inspection cause. bpduguard Enables the recovery timer for the BPDU-guard error-disable cause. channel-misconfig Enables the recovery timer for the channel-misconfig error-disable cause. dhcp-rate-limit Enables the recovery timer for the DHCP-rate-limit error-disable cause. dtp-flap Enables the recovery timer for the DTP-flap error-disable cause. gbic-invalid Enables the recovery timer for the GBIC-invalid error-disable cause. l2ptguard Enables the recovery timer for the L2PT error-disable cause. link-flap Enables the recovery timer for the link-flap error-disable cause. pagp-flap Enables the recovery timer for the PAgP-flap error-disable cause. psecure-violation Enables the recovery timer for the psecure-violation error-disable cause. security-violation Enables the automatic recovery of ports that were disabled because of 802.1X security violations. udld Enables the recovery timer for the UDLD error-disable cause. unicast-flood Enables the recovery timer for the unicast-flood error-disable cause. interval interval Specifies the time, in seconds, to recover from a specified error-disable cause. Range: 30 to 86400. Default: 300. Release Modification 12.2(14)SX This command was introduced on the Supervisor Engine 720. 12.2(17d)SXB This command was implemented on the Supervisor Engine 2. 12.2(18)SXD The arp-inspection keyword was added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. errdisable recovery CF-204 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines A cause (bpduguard, channel-misconfig, dhcp-rate-limit, dtp-flap, l2ptguard, link-flap, pagp-flap, psecure-violation, security-violation, udld, or unicast-flood) is defined as the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in an error-disabled state (an operational state that is similar to the link-down state). If you do not enable error-disable recovery for the cause, the interface stays in the error-disabled state until a shutdown and no shutdown occurs. If you enable recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry operation once all the causes have timed out. You must enter the shutdown command and then the no shutdown command to manually recover an interface from the error-disabled state. Note Each time you want enter the errdisable recovery cause command to add a new reason for recovery, it takes up a separate line; each new reason does not get appended to the original single line. This means you must enter each new reason separately. Examples This example shows how to enable the recovery timer for the BPDU-guard error-disable cause: Router(config)# errdisable recovery cause bpduguard This example shows how to set the recovery timer to 300 seconds: Router(config)# errdisable recovery interval 300 Related Commands Command Description show errdisable recovery Displays the information about the error-disable recovery timer. show interfaces status Displays the interface status or a list of interfaces in an error-disabled state on LAN ports only. escape-character CF-205 Cisco IOS Configuration Fundamentals Command Reference April 2010 escape-character To define a system escape character, use the escape-character command in line configuration mode. To set the escape character to Break, use the no or default form of this command. escape-character {break | char | default | none | soft} no escape-character [soft] default escape-character [soft] Syntax Description Defaults The default escape key sequence is Ctrl-Shift-6 (Ctrl-^) or Ctrl-Shift-6, X (^^X). The X is generally only required for modem connections. The default escape-character command sets the escape character to Break (the default setting for Break is Ctrl-C). Command Modes Line configuration Command History Usage Guidelines See the “ASCII Character Set and Hexidecimal Values” appendix for a list of ASCII characters. The escape character (or key sequence) suspends any actively running processes and returns you to privileged EXEC mode or, if a menu is being used, to the system menu interface. The escape character is used for interrupting or aborting a process started by previously executed command. Examples of processes from which you can escape include Domain-Name lookup, ping, trace, and Telnet sessions initiated from the device to which you are connected. To view the current setting of the escape sequence for a line, use the show line command followed by the specific line identifier (for example, show line 0, or show line console). The default escape sequence for a line is often displayed as ^^X . The first caret symbol represents the Control (Ctrl) key, the second caret symbol is literal (Shift-6), and the X is literal (for most systems, the X is not required). break Sets the escape character to Break. Note that the Break key should not be used as an escape character on a console terminal. char Character (for example, !) or its ASCII decimal representation (integer in the range of 0 to 255) to be used as the escape character. default Sets the escape key sequence to the default of Ctrl-^, X. none Disables escape entirely. soft Sets an escape character that will wait until pending input is processed before it executes. Release Modification 10.0 This command was introduced. 11.3 The soft keyword was added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. escape-character CF-206 Cisco IOS Configuration Fundamentals Command Reference April 2010 To set the escape key for the active terminal line session, use the terminal escape-character command. The Break key cannot be used as an escape character on a console terminal because the Cisco IOS software interprets Break as an instruction to halt the system. Depending upon the configuration register setting, break commands issued from the console line either will be ignored or cause the server to shut down. To send an escape sequence over a Telnet connection, press Ctrl-Shift-6 twice. The escape-character soft form of this command defines a character or character sequence that will cause the system to wait until pending input is processed before suspending the current session. This option allows you to program a key sequence to perform multiple actions, such as using the F1 key to execute a command, then execute the escape function after the first command is executed. The following restrictions apply when using the soft keyword: • The length of the logout sequence must be 14 characters or fewer. • The soft escape character cannot be the same as the generic Cisco escape character, Break, or the characters b, d, n, or s. • The soft escape character should be an ASCII value from 1 to 127. Do not use the number 30. Examples The following example sets the escape character for the console line to the keyboard entry Ctrl-P, which is represented by the ASCII decimal value of 16: Router(config)# line console Router(config-line)# escape-character 16 The following example sets the escape character for line 1 to !, which is represented in the configuration file as the ASCII number 33: Router(config)# line 1 Router(config-line)# escape-character ! Router(config-line)# end Router# show running-config Building configuration... . . . line 1 autoselect during-login autoselect ppp modem InOut transport preferred none transport output telnet escape-character 33 Related Commands Command Description show line Displays information about the specified line connection, or all the lines. terminal escape-character Sets the escape character for the current terminal line for the current session. exec CF-207 Cisco IOS Configuration Fundamentals Command Reference April 2010 exec To allow an EXEC process on a line, use the exec command in line configuration mode. To turn off the EXEC process for the specified line, use the no form of this command. exec no exec Syntax Description This command has no arguments or keywords. Defaults The EXEC processes is enabled on all lines. Command Modes Line configuration Command History Usage Guidelines When you want to allow only an outgoing connection on a line, use the no exec command. The no exec command allows you to disable the EXEC process for connections which may attempt to send unsolicited data to the router. (For example, the control port of a rack of modems attached to an auxiliary port of router.) When certain types of data are sent to a line connection, an EXEC process can start, which makes the line unavailable. When a user tries to Telnet to a line with the EXEC process disabled, the user will get no response when attempting to log on. Examples The following example disables the EXEC process on line 7. Router(config)# line 7 Router(config-line)# no exec Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. exec-banner CF-208 Cisco IOS Configuration Fundamentals Command Reference April 2010 exec-banner To reenable the display of EXEC and message-of-the-day (MOTD) banners on the specified line or lines, use the exec-banner command in line configuration mode. To suppress the banners on the specified line or lines, use the no form of this command. exec-banner no exec-banner Syntax Description This command has no arguments or keywords. Defaults Enabled on all lines Command Modes Line configuration Command History Usage Guidelines This command determines whether the router will display the EXEC banner and the message-of-the-day (MOTD) banner when an EXEC session is created. These banners are defined with the banner exec and banner motd global configuration commands. By default, these banner are enabled on all lines. Disable the EXEC and MOTD banners using the no exec-banner command. This command has no effect on the incoming banner, which is controlled by the banner incoming command. The MOTD banners can also be disabled by the no motd-banner line configuration command, which disables MOTD banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-banner command is enabled or disabled. Table 30 summarizes the effects of the exec-banner command and the motd-banner command. For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. Table 31 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 30 Banners Displayed Based On exec-banner and motd-banner Combinations exec-banner (default) no exec-banner motd-banner (default) MOTD banner EXEC banner None no motd-banner EXEC banner None exec-banner CF-209 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4: Router(config)# line vty 0 4 Router(config-line)# no exec-banner Related Commands Table 31 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet Sessions to Async Lines exec-banner (default) no exec-banner motd-banner (default) MOTD banner Incoming banner Incoming banner no motd-banner Incoming banner Incoming banner Command Description banner exec Defines and enables a customized banner to be displayed whenever the EXEC process is initiated. banner incoming Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network. banner motd Defines and enables a customized message-of-the-day banner. motd-banner Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines. exec-character-bits CF-210 Cisco IOS Configuration Fundamentals Command Reference April 2010 exec-character-bits To configure the character widths of EXEC and configuration command characters, use the exec-character-bits command in line configuration mode. To restore the default value, use the no form of this command. exec-character-bits {7 | 8} no exec-character-bits Syntax Description Defaults 7-bit ASCII character set Command Modes Line configuration Command History Usage Guidelines Setting the EXEC character width to 8 allows you to use special graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can cause failures. If a user on a terminal that is sending parity enters the help command, an “unrecognized command” message appears because the system is reading all 8 bits, and the eighth bit is not needed for the help command. Note If you are using the autoselect function, set the activation character to the default (Return) and the value for exec-character-bits to 7. If you change these defaults, the application will not recognize the activation request. Examples The following example enables full 8-bit international character sets, except for the console, which is an ASCII terminal. It illustrates use of the default-value exec-character-bits global configuration command and the exec-character-bits line configuration command. Router(config)# default-value exec-character-bits 8 Router(config)# line 0 Router(config-line)# exec-character-bits 7 7 Selects the 7-bit character set. This is the default. 8 Selects the full 8-bit character set for use of international and graphical characters in banner messages, prompts, and so on. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. exec-character-bits CF-211 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description default-value exec-character-bits Defines the EXEC character width for either 7 bits or 8 bits. default-value special-character-bits Configures the flow control default value from a 7-bit width to an 8-bit width. length Sets the terminal screen length. terminal exec-character-bits Locally changes the ASCII character set used in EXEC and configuration command characters for the current session. terminal special-character-bits Changes the ASCII character widths to accept special characters for the current terminal line and session. exec-timeout CF-212 Cisco IOS Configuration Fundamentals Command Reference April 2010 exec-timeout To set the interval that the EXEC command interpreter waits until user input is detected, use the exec-timeout command in line configuration mode. To remove the timeout definition, use the no form of this command. exec-timeout minutes [seconds] no exec-timeout Syntax Description Defaults 10 minutes Command Modes Line configuration Command History Usage Guidelines If no input is detected during the interval, the EXEC facility resumes the current connection. If no connections exist, the EXEC facility returns the terminal to the idle state and disconnects the incoming session. To specify no timeout, enter the exec-timeout 0 0 command. Examples The following example sets a time interval of 2 minutes, 30 seconds: Router(config)# line console Router(config-line)# exec-timeout 2 30 The following example sets a time interval of 10 seconds: Router(config)# line console Router(config-line)# exec-timeout 0 10 minutes Integer that specifies the number of minutes. The default is 10 minutes. seconds (Optional) Additional time intervals in seconds. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. execute-on CF-213 Cisco IOS Configuration Fundamentals Command Reference April 2010 execute-on To execute commands on a line card, use the execute-on command in privileged EXEC mode. execute-on {slot slot-number | all | master} command Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines Use this command to execute a command on one or all line cards to monitor and maintain information on one or more line cards (for example, a line card in a specified slot on a dial shelf). This allows you to issue commands remotely; that is, to issue commands without needing to log in to the line card directly. The all form of the command allows you to issue commands to all the line cards without having to log in to each in turn. Though this command does not have a no form, note that it is possible to use the no form of the remotely executed commands used in this command. Tip This command is useful when used with show EXEC commands (such as show version), because you can verify and troubleshoot the features found only on a specific line card. Please note, however, that because not all statistics are maintained on the line cards, the output from some of the show commands might not be consistent. Cisco 12000 GSR Guidelines and Restrictions You can use the execute-on privileged EXEC command only from Cisco IOS software running on the GRP card. slot slot-number Executes the command on the line card in the specified slot. Slot numbers can be chosen from the following ranges: • Cisco 12012 router: 0 to 11 • Cisco 12008 access server: 0 to 7 • Cisco AS5800 access server: 0 to 13 all Executes the command on all line cards. master (AS5800 only) Executes the designated command on a Dial Shelf Controller (DSC). Do not use this option; it is used for technical support troubleshooting only. command Cisco IOS command to remotely execute on the line card. Release Modification 11.2 GS This command was introduced to support Cisco 12000 series Gigabit Switch Routers. 11.3(2)AA This command was implemented in images for the Cisco AS5800 series. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. execute-on CF-214 Cisco IOS Configuration Fundamentals Command Reference April 2010 Timesaver Though you can use the attach privileged EXEC command to execute commands on a specific line card, using the execute-on slot command saves you some steps. For example, first you must use the attach command to connect to the Cisco IOS software running on the line card. Next you must issue the command. Finally you must disconnect from the line card to return to the Cisco IOS software running on the GRP card. With the execute-on slot command, you can perform three steps with one command. In addition, the execute-on all command allows you to perform the same command on all line cards simultaneously. Cisco AS5800 Guidelines and Restrictions The purpose of the command is to conveniently enable certain commands to be remotely executed on the dial shelf cards from the router without connecting to each line card. This is the recommended procedure, because it avoids the possibility of adversely affecting a good configuration of a line card in the process. The execute-on command does not give access to every Cisco IOS command available on the Cisco AS5800 access server. In general, the purpose of the execute-on command is to provide access to statistical reports from line cards without directly connecting to the dial shelf line cards. Caution Do not use this command to change configurations on dial shelf cards, because such changes will not be reflected in the router shelf. Using this command makes it possible to accumulate inputs for inclusion in the show tech-support command. The master form of the command can run a designated command remotely on the router from the DSC card. However, using the console on the DSC is not recommended. It is used for technical support troubleshooting only. The show tech-support command for each dial shelf card is bundled into the router shelf's show tech-support command via the execute-on facility. The execute-on command also support interactive commands such as the following: router: execute-on slave slot slot ping The execute-on command has the same limitations and restrictions as a vty telnet client has; that is, it cannot reload DSC using the following command: router: execute-on slave slot slot reload You can use the execute-on command to enable remote execution of the commands included in the following partial list: • debug dsc clock • show context • show diag • show environment • show dsc clock • show dsi • show dsip • show tech-support execute-on CF-215 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the user executes the show controllers command on the line card in slot 4 of a Cisco 12000 series GSR: Router# execute-on slot 4 show controllers ========= Line Card (Slot 4) ======= Interface POS0 Hardware is BFLC POS lcpos_instance struct 6033A6E0 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000400 SUNI rsop intr status 00 CRC16 enabled, HDLC enc, int clock no loop Interface POS1 Hardware is BFLC POS lcpos_instance struct 6033CEC0 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000600 SUNI rsop intr status 00 CRC32 enabled, HDLC enc, int clock no loop Interface POS2 Hardware is BFLC POS lcpos_instance struct 6033F6A0 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000800 SUNI rsop intr status 00 CRC32 enabled, HDLC enc, int clock no loop Interface POS3 Hardware is BFLC POS lcpos_instance struct 60341E80 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000A00 SUNI rsop intr status 00 CRC32 enabled, HDLC enc, ext clock no loop Router# Related Commands Command Description attach Connects you to a specific line card for the purpose of executing commands using the Cisco IOS software image on that line card. exit (EXEC) CF-216 Cisco IOS Configuration Fundamentals Command Reference April 2010 exit (EXEC) To close an active terminal session by logging off the router, use the exit command in EXEC mode. exit Syntax Description This command has no arguments or keywords. Defaults No default behavior or values Command Modes EXEC Command History Usage Guidelines Use the exit command in EXEC mode to exit the active session (log off the device). This command can be used in any EXEC mode (such as User EXEC mode or Privileged EXEC mode) to exit from the EXEC process. Examples In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the exit (EXEC) command is used to log off (exit the active session): Router(config)# exit Router# disable Router> exit Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description disconnect Disconnects a line. end Ends your configuration session by exiting to EXEC mode. exit (global) Exits from the current configuration mode to the next highest configuration mode. logout Closes your connection to the device (equivilant to the exit command). exit (global) CF-217 Cisco IOS Configuration Fundamentals Command Reference April 2010 exit (global) To exit any configuration mode to the next highest mode in the CLI mode hierarchy, use the exit command in any configuration mode. exit Syntax Description This command has no arguments or keywords. Defaults No default behavior or values Command Modes All configuration modes Command History Usage Guidelines The exit command is used in the Cisco IOS CLI to exit from the current command mode to the next highest command mode in the CLI mode hierarchy. For example, use the exit command in global configuration mode to return to privileged EXEC mode. Use the exit command in interface, line, or router configuration mode to return to global configuration mode. Use the exit command in subinterface configuration mode to return to interface configuration mode. At the highest level, EXEC mode, the exit command will exit the EXEC mode and disconnect from the router interface (see the description of the exit (EXEC) command for details). Examples The following example shows how to exit from the subinterface configuration mode and to return to the interface configuration mode: Router(config-subif)# exit Router(config-if)# The following example displays an exit from the interface configuration mode to return to the global configuration mode: Router(config-if)# exit Router(config)# Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description disconnect Disconnects a line. end Ends your configuration session by exiting to privileged EXEC mode. exit (EXEC) Closes the active terminal session by logging off the router. file prompt CF-218 Cisco IOS Configuration Fundamentals Command Reference April 2010 file prompt To specify the level of prompting, use the file prompt command in global configuration mode. file prompt [alert | noisy | quiet] Syntax Description Defaults alert Command Modes Global configuration Command History Usage Guidelines Use this command to change the amount of confirmation needed for different file operations. This command affects only prompts for confirmation of operations. The router will always prompt for missing information. Examples The following example configures confirmation prompting for all file operations: Router(config)# file prompt noisy alert (Optional) Prompts only for destructive file operations. This is the default. noisy (Optional) Confirms all file operation parameters. quiet (Optional) Seldom prompts for file operations. Release Modification 11.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. file verify auto CF-219 Cisco IOS Configuration Fundamentals Command Reference April 2010 file verify auto To enable automatic image verification, use the file verify auto command in global configuration mode. To disable automatic image verification, use the no form of this command. file verify auto no file verify auto Syntax Description This command has no arguments or keywords. Defaults Image verification is not automatically applied to all images that are copied or reloaded onto a router. Command Modes Global configuration Command History Usage Guidelines Image verification is accomplished by verifying the compressed Cisco IOS image checksum. Image verification allows users to automatically verify the integrity of all Cisco IOS images. Thus, users can be sure that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user. The file verify auto command enables image verification globally; that is, all images that are to be copied (via the copy command) or reloaded (via the reload command) are automatically verified. Although both the copy and reload commands have a /verify keyword that enables image verification, you must issue the keyword each time you want to copy or reload an image. The file verify auto command enables image verification by default so you no longer have to specify image verification multiple times. If you have enabled image verification by default but prefer to disable verification for a specific image copy or reload, the /noverify keyword along with either the copy or the reload command will override the file verify auto command. Examples The following example shows how to enable automatic image verification: Router(config)# file verify auto Release Modification 12.2(18)S This command was introduced. 12.0(26)S This command was integrated into Cisco IOS Release 12.0(26)S. 12.2(14)SX This command was integrated into Cisco IOS Release 12.2(14)SX and implemented on the Supervisor Engine 720. 12.2(17d)SXB Support was added for the Supervisor Engine 2. 12.3(4)T This command was integrated into Cisco IOS Release 12.3(4)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. file verify auto CF-220 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description copy Copies any file from a source to a destination. copy/noverify Disables the automatic image verification for the current copy operation. reload Reloads the operating system. verify Verifies the checksum of a file on a Flash memory file system or computes an MD5 signature for a file. format CF-221 Cisco IOS Configuration Fundamentals Command Reference April 2010 format To format a Class A, Class B, or Class C flash memory file system, use the format command in privileged EXEC or diagnostic mode. Class B and Class C Flash File Systems format filesystem1: Class A Flash File System format [spare spare-number] filesystem1: [[filesystem2:][monlib-filename]] Syntax Description Command Default spare-number: 0 monlib-filename: The monlib file bundled with the system software Command Modes Privileged EXEC (#) Diagnostic (diag) spare (Optional) Reserves spare sectors as specified by the spare-number argument when you format flash memory. spare-number (Optional) Number of the spare sectors to reserve in formatted flash memory. Valid values are from 0 to 16. The default value is 0. filesystem1: Flash memory to format, followed by a colon. Valid values for use with the Cisco 7600 series router are disk0:, disk1:, bootflash:, slot0:, sup-slot0:, and sup-bootflash:; see the “Usage Guidelines” section for additional information. Valid values for use with the ASR1000 Series Routers are bootflash:, harddisk:, stby-harddisk:, obfl:, and usb[0-1];. filesystem2: (Optional) File system containing the monlib file to use for formatting the argument filesystem1 followed by a colon. monlib-filename (Optional) Name of the ROM monitor library file (monlib file) to use for formatting the filesystem1 argument. The default monlib file is the one bundled with the system software. Dual Route Switch Processors (RSP) High System Availability (HSA) Functionality When this command is used with Dual RSPs and you do not specify the monlib-filename argument, the system takes the ROM monitor library file from the slave image bundle. If you specify the monlib-filename argument, the system assumes that the files reside on the slave devices. format CF-222 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines Reserve a certain number of memory sectors as spares, so that if some sectors fail, most of the flash memory card can still be used. Otherwise, you must reformat the flash card after some of the sectors fail. Use this command to format Class A, B, or C flash memory file systems. The Cisco 7600 series router supports only Class A and Class C flash file systems. In some cases, you might need to insert a new Personal Computer Memory Card Industry Association (PCMCIA) flash memory or flash PC card and load images or backup configuration files onto it. Before you can use a new flash memory or flash PC card, you must format it. Sectors in flash memory or flash PC cards can fail. Reserve certain flash memory or flash PC sectors as “spares” by using the optional spare-number argument on the format command to specify 0 to 16 sectors as spares. If you reserve a small number of spare sectors for emergencies, you can still use most of the flash memory or flash PC card. If you specify 0 spare sectors and some sectors fail, you must reformat the flash memory or flash PC card, thereby erasing all existing data. The monlib file is the ROM monitor library. The ROM monitor uses this file to access files in the flash file system. The Cisco IOS system software contains a monlib file. Use the show disk0: all command to display monlib file details. When this command is used with HSA and you do not specify the monlib-filename argument, the system takes the ROM monitor library file from the slave image bundle. If you specify the monlib-filename argument, the system assumes that the files reside on the slave devices. In the command syntax, the filesystem1: argument specifies the device to format and the filesystem2: argument specifies the optional device containing the monlib file used to format the filesystem1: argument. The device determines which monlib file to use, as follows: • If you omit the optional filesystem2: and monlib-filename arguments, the system formats the filesystem1: argument using the monlib file already bundled with the system software. • If you omit only the optional filesystem2: argument, the system formats the filesystem1: argument using the monlib file from the device you specified with the cd command. • If you omit only the optional monlib-filename argument, the system formats filesystem1: using the filesystem2: monlib file. Release Modification 11.0 This command was introduced. 12.2(14)SX Support for this command was added for the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.3(14)T Support for Class B Flash (USB Flash and USB eToken) File Systems was added as part of the “USB Storage” feature. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR1000 Series Routers and the following enhancements were introduced: • This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR1000 Series Routers. • The harddisk:, obfl:, stby-harddisk:, stby-usb[0-1]: and usb[0-1]: filesystem1: options were introduced. format CF-223 Cisco IOS Configuration Fundamentals Command Reference April 2010 • When you specify both arguments—filesystem2: and monlib-filename—the system formats the filesystem1: argument using the monlib file from the specified device. • You can specify the filesystem1: arguments’s own monlib file in this argument. If the system cannot find a monlib file, it terminates its formatting. Note Most platforms do not support booting from images stored on flash memory cards. You should reboot your device only from integrated memory locations, such as NVRAM. Cisco 7600 Series Router Notes The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2. Use the format command to format Class A or C flash memory file systems. • The disk0: and disk1: keywords are for Class C file systems. • The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are for Class A file systems. The disk0: keyword is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2 only. Cisco ASR 1000 Series Routers Notes This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 Series Routers. Examples The following example shows how to format a flash memory card that is inserted in slot 0: Router# format slot0: Running config file on this device, proceed? [confirm] y All sectors will be erased, proceed? [confirm] y Enter volume id (up to 31 characters): Formatting sector 1 (erasing) Format device slot0 completed When the console returns to the EXEC prompt, the new flash memory card is formatted and ready for use. This example shows how to format a CompactFlash PC card that is inserted in slot 0: Router# format disk0: Running config file on this device, proceed? [confirm] y All sectors will be erased, proceed? [confirm] y Enter volume id (up to 31 characters): Formatting sector 1 (erasing) Format device disk0 completed When the console returns to the EXEC prompt, the new CompactFlash PC card is formatted and ready for use. Related Commands Command Description cd Changes the default directory or file system. copy Copies any file from a source to a destination. format CF-224 Cisco IOS Configuration Fundamentals Command Reference April 2010 delete Deletes a file on a flash memory device. show disk0: all Displays ATA MONLIB file information for disk0. show file systems Lists available file systems. squeeze Permanently deletes flash files by squeezing a Class A flash file system. undelete Recovers a file marked “deleted” on a Class A or Class B flash file system. Command Description fsck CF-225 Cisco IOS Configuration Fundamentals Command Reference April 2010 fsck To check a File Allocation Table (FAT)-based disk, a flash file system, or a Class C file system for damage and to repair any problems, use the fsck command in privileged EXEC or diagnostic mode. Supported Platforms Other than the Cisco 7600 Series and Cisco ASR1000 Series Routers fsck [/nocrc] [/automatic] [/all] [/force] [filesystem:] Cisco 7600 Series Routers fsck [/automatic] [/all] [/force] [filesystem:] Cisco ASR 1000 Series Routers fsck [/all] [/force] [filesystem:] Syntax Description Command Default A FAT-based disk, flash file system, or Class C file system is not checked for damage and repaired. If you do not enter the /automatic keyword, command-line interface (CLI) prompts for actions are issued. For the Cisco 7600 series router, if you do not specify the disk0: keyword, the current file system is checked. This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 series routers. Command Modes Privileged EXEC (#) Diagnostic (diag) /nocrc (Optional) This keyword is available for Class C flash file systems only. Omits cyclic redundancy checks (CRCs). /automatic (Optional) This keyword is available for Advanced Technology Attachment (ATA) FAT-based disks only. Specifies that the check and repair actions should proceed automatically. This option can be used to skip the prompts for each check and repair action. Note This command also specifies the automatic mode for the Cisco 7600 series router; see the “Usage Guidelines” section for additional information. /all (Optional) Specifies that all partitions on the disk be checked for problems. /force (Optional) Ensures forced termination of simultaneous file operations on the same device. filesystem: The file system prefix indicating the disk to be checked. The colon (:) is required. Typically, the file system prefix will be disk0: or disk1:. In case of dual processors, the file system on the redundant supervisor engine can also be specified. fsck CF-226 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines Supported Platforms Other than Cisco 7600 Series Router This command performs all steps necessary to remove corrupted files and reclaim unused disk space. Changes include checking for incorrect file sizes, cluster loops, and so on. The default form of this command issues multiple prompts to confirm each of the changes. However, you can skip these prompts by using the /automatic keyword when issuing the command. When you use the /automatic keyword you are prompted to confirm that you want the automatic option. Prompts for actions will be skipped, but all actions performed are displayed to the terminal (see the example below). This command works with ATA Personal Computer Memory Card Industry Association (PCMCIA) cards formatted in Disk Operating System (DOS), or for Class C flash file systems. Note Only one partition (the active partition) is checked in the ATA disk. Cisco 7600 Series Router The disk0: or slavedisk0: file systems are the only file systems in the Cisco 7600 series routers on which you can run the File-System-Check (fsck) utility. The slavedisk0: file system appears in redundant supervisor engine systems only. This command is valid only on Class C flash file systems and only on PCMCIA ATA flash disks and CompactFlash disks. The output for the fsck slavedisk0: command is similar to the fsck disk0: command output. If you do not enter any arguments, the current file system is used. Use the pwd command to display the current file system. Release Modification 11.3 AA This command was introduced. 12.0(22)S This command was implemented on the Cisco 7000 family of routers and on the Cisco 10000 series router and the Gigabit Switch Router (GSR) to support ATA disks. 12.2(13)T This command was integrated into Cisco IOS Release 12.2(13)T. 12.2(14)SX This command was modified. Support for this command was added for the Supervisor Engine 720. 12.2(17d)SXB This command was modified. Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Routers and the following enhancements were introduced: • This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 series routers. • The /all option was introduced. • The harddisk:, obfl:, stby-harddisk:, stby-usb[0-1]:,and usb[0-1]: filesystem: options were introduced. 15.0(1)M This command was modified. The /force keyword was added. fsck CF-227 Cisco IOS Configuration Fundamentals Command Reference April 2010 If you enter the disk0: or slavedisk0: keyword, the fsck utility checks the selected file system for problems. If a problem is detected, a prompt is displayed asking if you want the problem fixed. If you enter the /automatic keyword, you are prompted to confirm that you want the automatic mode. In automatic mode, problems are fixed automatically and you are not prompted to confirm. If you do not specify the /force keyword, any simultaneous file operations on the same device are not terminated. Instead, an error message stating files are open for read or write access appears. If you specify the /force keyword, the fsck utility terminates files that are open for read or write access and continues to check for problems. Table 32 lists the checks and actions that are performed by the fsck utility. Table 32 fsck Utility Checks and Actions Checks Actions Checks the boot sector and the partition table and reports the errors. No action. Validates the media with the signature in the last 2 bytes of the first sector (0x55 and 0xaa, respectively). No action. Checks the os_id to find whether this is a FAT-12 or FAT-16 file system (valid values include 0, 1, 4, and 6). No action. Checks the number of FAT’s field (correct values are 1 and 2). No action. Checks these values: • n_fat_sectors cannot be less than 1. • n_root_entries cannot be less than 16. • n_root_sectors cannot be less than 2. • base_fat_sector, n_sectors_per_cluster, n_heads, n_sectors_per_track is not 0. No action. Checks the files and FAT for these errors: Checks the FAT for invalid cluster numbers. If the cluster is a part of a file chain, the cluster is changed to end of file (EOF). If the cluster is not part of a file chain, it is added to the free list and unused cluster chain. Table 33 lists valid cluster numbers; numbers other than those listed in Table 33 are invalid numbers. Checks the file’s cluster chain for loops. If the loop is broken, the file is truncated at the cluster where the looping occurred. Checks the directories for nonzero size fields. If directories are found with nonzero size fields, the size is reset to zero. Checks for invalid start cluster file numbers. If the start cluster number of a file is invalid, the file is deleted. Checks files for bad or free clusters. If the file contains bad or free clusters, the file is truncated at the last good cluster; an example is the cluster that points to this bad/free cluster. Checks to see if the file’s cluster chain is longer than indicated by the size fields. If the file’s cluster chain is longer than indicated by the size fields, the file size is recalculated and the directory entry is updated. fsck CF-228 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 33 lists the valid cluster numbers. Numbers other than those listed in Table 33 are invalid numbers. Examples Supported Platforms Other than the Cisco 7600 Series Router The following example shows sample output from the fsck command in automatic mode: Router# fsck /automatic disk1: Proceed with the automatic mode? [yes] y Checking the boot sector and partition table... Checking FAT, Files and Directories... Start cluster of file disk1:/file1 is invalid, removing file File disk1:/file2 has a free/bad cluster, truncating... File disk1:/file2 truncated. File disk1:/file3 has a free/bad cluster, truncating... File disk1:/file3 truncated. File disk1:/file4 has a invalid cluster, truncating... File disk1:/file4 truncated. File disk1:/file5 has a invalid cluster, truncating... File disk1:/file5 truncated. File disk1:/file6 has a invalid cluster, truncating... File disk1:/file6 truncated. File size of disk1:/file7 is not correct, correcting it File disk1:/file8 cluster chain has a loop, truncating it File disk1:/file8 truncated. File disk1:/file9 cluster chain has a loop, truncating it File disk1:/file9 truncated. File disk1:/file16 has a free/bad cluster, truncating... File disk1:/file16 truncated. File disk1:/file20 has a free/bad cluster, truncating... File disk1:/file20 truncated. Reclaiming unused space... Created file disk1:/fsck-4 for an unused cluster chain Created file disk1:/fsck-41 for an unused cluster chain Checks to see if two or more files share the same cluster (crosslinked). If two or more files are crosslinked, you are prompted to accept the repair, and one of the files is truncated. Checks to see if the file’s cluster chain is shorter than is indicated by the size fields. If the file’s cluster chain is shorter than is indicated by the size fields, the file size is recalculated and the directory entry is updated. Checks to see if there are any unused cluster chains. If unused cluster chains are found, new files are created and linked to that file with the name fsck-start cluster. Table 32 fsck Utility Checks and Actions (continued) Checks Actions Table 33 Valid Cluster Numbers Cluster FAT-12 FAT-16 Next entry in the chain 2-FEF 2-FFEF Last entry in chain FF8-FFF FFF8-FFFF Available cluster 0 0 Bad Cluster FF7 FFF7 fsck CF-229 Cisco IOS Configuration Fundamentals Command Reference April 2010 Created file disk1:/fsck-73 for an unused cluster chain Created file disk1:/fsck-106 for an unused cluster chain Created file disk1:/fsck-121 for an unused cluster chain Created file disk1:/fsck-132 for an unused cluster chain Created file disk1:/fsck-140 for an unused cluster chain Created file disk1:/fsck-156 for an unused cluster chain Created file disk1:/fsck-171 for an unused cluster chain Created file disk1:/fsck-186 for an unused cluster chain Created file disk1:/fsck-196 for an unused cluster chain Created file disk1:/fsck-235 for an unused cluster chain Created file disk1:/fsck-239 for an unused cluster chain Updating FAT... fsck of disk1: complete Cisco 7600 Series Router This example shows how to run a check of the current file system: Router# fsck Checking the boot sector and partition table... Checking FAT, Files and Directories... Files 1) disk0:/FILE3 and 2) disk0:/FILE2 have a common cluster. Press 1/2 to truncate or any other character to ignore[confirm] q Ignoring this error and continuing with the rest of the check... Files 1) disk0:/FILE5 and 2) disk0:/FILE4 have a common cluster. Press 1/2 to truncate or any other character to ignore[confirm] 1 File disk0:/FILE5 truncated. Files 1) disk0:/FILE7 and 2) disk0:/FILE6 have a common cluster. . . . 1) disk0:/FILE15 and 2) disk0:/FILE13 have a common cluster. Press 1/2 to truncate or any other character to ignore[confirm] i Ignoring this error and continuing with the rest of the check... Reclaiming unused space... Created file disk0:/fsck-11 for an unused cluster chain Created file disk0:/fsck-20 for an unused cluster chain Created file disk0:/fsck-30 for an unused cluster chain Created file disk0:/fsck-35 for an unused cluster chain Created file disk0:/fsck-40 for an unused cluster chain Created file disk0:/fsck-46 for an unused cluster chain Created file disk0:/fsck-55 for an unused cluster chain Created file disk0:/fsck-62 for an unused cluster chain Created file disk0:/fsck-90 for an unused cluster chain Updating FAT... fsck of disk0: complete Related Commands fsck CF-230 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Description cd Changes the default directory or file system. pwd Shows the current setting of the cd command. full-help CF-231 Cisco IOS Configuration Fundamentals Command Reference April 2010 full-help To get help for the full set of user-level commands, use the full-help command in line configuration mode. full-help Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Line configuration Command History Usage Guidelines The full-help command enables (or disables) an unprivileged user to see all of the help messages available. It is used with the show ? command. Examples In the following example, the show ? command is used first with full-help disabled. Then full-help is enabled for the line, and the show ? command is used again to demonstrate the additional help output that is displayed. Router> show ? bootflash Boot Flash information calendar Display the hardware calendar clock Display the system clock context Show context information dialer Dialer parameters and statistics history Display the session command history hosts IP domain-name, lookup style, nameservers, and host table isdn ISDN information kerberos Show Kerberos Values modemcap Show Modem Capabilities database ppp PPP parameters and statistics rmon rmon statistics sessions Information about Telnet connections snmp snmp statistics terminal Display terminal configuration parameters users Display information about terminal lines version System hardware and software status Router> enable Password: Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. full-help CF-232 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# line console 0 Router(config-line)# full-help Router(config-line)# exit Router# %SYS-5-CONFIG_I: Configured from console by console Router# disable Router> show ? access-expression List access expression access-lists List access lists aliases Display alias commands apollo Apollo network information appletalk AppleTalk information arp ARP table async Information on terminal lines used as router interfaces bootflash Boot Flash information bridge Bridge Forwarding/Filtering Database [verbose] bsc BSC interface information bstun BSTUN interface information buffers Buffer pool statistics calendar Display the hardware calendar . . . translate Protocol translation information ttycap Terminal capability tables users Display information about terminal lines version System hardware and software status vines VINES information vlans Virtual LANs Information whoami Info on current tty line x25 X.25 information xns XNS information xremote XRemote statistics Related Commands Command Description help Displays a brief description of the help system. help CF-233 Cisco IOS Configuration Fundamentals Command Reference April 2010 help To display a brief description of the help system, use the help command in any command mode. help Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes User EXEC Privileged EXEC All configuration modes Command History Usage Guidelines The help command provides a brief description of the context-sensitive help system, which functions as follows: • To list all commands available for a particular command mode, enter a question mark (?) at the system prompt. • To obtain a list of commands that begin with a particular character string, enter the abbreviated command entry immediately followed by a question mark (?). This form of help is called word help, because it lists only the keywords or arguments that begin with the abbreviation you entered. • To list the keywords and arguments associated with a command, enter a question mark (?) in place of a keyword or argument on the command line. This form of help is called command syntax help, because it lists the keywords or arguments that apply based on the command, keywords, and arguments you have already entered. Examples In the following example, the help command is used to display a brief description of the help system: Router# help Help may be requested at any point in a command by entering a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options. Two styles of help are provided: 1. Full help is available when you are ready to enter a command argument (e.g. 'show ?') and describes each possible argument. 2. Partial help is provided when an abbreviated argument is entered Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. help CF-234 Cisco IOS Configuration Fundamentals Command Reference April 2010 and you want to know what arguments match the input (e.g. 'show pr?'.) The following example shows how to use word help to display all the privileged EXEC commands that begin with the letters “co.” The letters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command. Router# co? configure connect copy Router# co The following example shows how to use command syntax help to display the next argument of a partially complete access-list command. One option is to add a wildcard mask. The symbol indicates that the other option is to press Enter to execute the command without adding any more keywords or arguments. The characters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command or to execute that command as it is. Router(config)# access-list 99 deny 131.108.134.234 ? A.B.C.D Mask of bits to ignore Router(config)# access-list 99 deny 131.108.134.234 Related Commands Command Description full-help Enables help for the full set of user-level commands for a line. hidekeys CF-235 Cisco IOS Configuration Fundamentals Command Reference April 2010 hidekeys To suppress the display of password information in configuration log files, use the hidekeys command in configuration change logger configuration mode. To allow the display of password information in configuration log files, use the no form of this command. hidekeys no hidekeys Syntax Description This command has no arguments or keywords. Command Default Password information is displayed. Command Modes Configuration change logger configuration Command History Usage Guidelines Enabling the hidekeys command increases security by preventing password information from being displayed in configuration log files. Examples The following example shows how to prevent password information from being displayed in configuration log files: Router# configure terminal ! Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# hidekeys Router(config-archive-log-config)# end Related Commands Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. Command Description archive Enters archive configuration mode. log config Enters configuration change logger configuration mode. logging enable Enables the logging of configuration changes. hidekeys CF-236 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging size Specifies the maximum number of entries retained in the configuration log. notify syslog Enables the sending of notifications of configuration changes to a remote syslog. show archive log config Displays entries from the configuration log. Command Description history CF-237 Cisco IOS Configuration Fundamentals Command Reference April 2010 history To enable the command history function, use the history command in line configuration mode. To disable the command history function, use the no form of this command. history no history Syntax Description This command has no arguments or keywords. Defaults Enabled with ten command lines in the buffer. Command Modes Line configuration Command History Usage Guidelines The command history function provides a record of EXEC commands that you have entered. This function is particularly useful for recalling long or complex commands or entries, including access lists. To change the number of command lines that the system will record in its history buffer, use the history size line configuration command. The history command enables the history function with the last buffer size specified or, if there was not a prior setting, with the default of ten lines. The no history command disables the history function. The show history EXEC command will list the commands you have entered, but you can also use your keyboard to display individual commands. Table 34 lists the keys you can use to recall commands from the command history buffer. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 34 History Keys Key(s) Functions Ctrl-P or Up Arrow1 1. The arrow keys function only with ANSI-compatible terminals. Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands. Ctrl-N or Down Arrow1 Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands. history CF-238 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the command history function is disabled on line 4: Router(config)# line 4 Router(config-line)# no history Related Commands Command Description history size Sets the command history buffer size for a particular line. show history Lists the commands you have entered in the current EXEC session. terminal history Enables the command history function for the current terminal session or changes the size of the command history buffer for the current terminal session. history size CF-239 Cisco IOS Configuration Fundamentals Command Reference April 2010 history size To change the command history buffer size for a particular line, use the history size command in line configuration mode. To reset the command history buffer size to ten lines, use the no form of this command. history size number-of-lines no history size Syntax Description Defaults 10 command lines Command Modes Line configuration Command History Usage Guidelines The history size command should be used in conjunction with the history and show history commands. The history command enables or disables the command history function. The show history command lists the commands you have entered in the current EXEC session. The number of commands that the history buffer will show is set by the history size command. Note The history size command only sets the size of the buffer; it does not reenable the history function. If the no history command is used, the history command must be used to reenable this function. Examples The following example displays line 4 configured with a history buffer size of 35 lines: Router(config)# line 4 Router(config-line)# history size 35 Related Commands number-of-lines Specifies the number of command lines that the system will record in its history buffer. The range is from 0 to 256. The default is 10. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description history Enables or disables the command history function. show history Lists the commands you have entered in the current EXEC session. terminal history size Enables the command history function for the current terminal session or changes the size of the command history buffer for the current terminal session. hold-character CF-240 Cisco IOS Configuration Fundamentals Command Reference April 2010 hold-character To define the local hold character used to pause output to the terminal screen, use the hold-character command in line configuration mode. To restore the default, use the no form of this command. hold-character ascii-number no hold-character Syntax Description Defaults No hold character is defined. Command Modes Line configuration Command History Usage Guidelines The Break character is represented by zero; NULL cannot be represented. To continue the output, enter any character after the hold character. To use the hold character in normal communications, precede it with the escape character. See the “ASCII Character Set” appendix for a list of ASCII characters. Examples The following example sets the hold character to Ctrl-S, which is ASCII decimal character 19: Router(config)# line 8 Router(config-line)# hold-character 19 Related Commands ascii-number ASCII decimal representation of a character or control sequence (for example, Ctrl-P). Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal hold-character Sets or changes the hold character for the current session. hostname CF-241 Cisco IOS Configuration Fundamentals Command Reference April 2010 hostname To specify or modify the host name for the network server, use the hostname command in global configuration mode. hostname name Syntax Description Command Default The default host name is Router. Command Modes Global configuration Command History Usage Guidelines The host name is used in prompts and default configuration filenames. Do not expect case to be preserved. Uppercase and lowercase characters look the same to many internet software applications. It may seem appropriate to capitalize a name the same way you might do in English, but conventions dictate that computer names appear all lowercase. For more information, refer to RFC 1178, Choosing a Name for Your Computer. The name must also follow the rules for ARPANET host names. They must start with a letter, end with a letter or digit, and have as interior characters only letters, digits, and hyphens. Names must be 63 characters or fewer. A host name of less than 10 characters is recommended. For more information, refer to RFC 1035, Domain Names—Implementation and Specification. On most systems, a field of 30 characters is used for the host name and the prompt in the CLI. Note that the length of your host name may cause longer configuration mode prompts to be truncated. For example, the full prompt for service profile configuration mode is: (config-service-profile)# However, if you are using the host-name of "Router", you will only see the following prompt (on most systems): Router(config-service-profil)# If the hostname is longer, you will see even less of the prompt: Basement-rtr2(config-service)# Keep this behavior in mind when assigning a name to your system (using the hostname global configuration command). If you expect that users will be relying on mode prompts as a CLI navigation aid, you should assign host names of no more than nine characters. name New host name for the network server. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. hostname CF-242 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example changes the host name to “host1”: Router(config)# hostname sandbox host1(config)# Related Commands Command Description setup Enables you to make major changes to your configurations, for example, adding a protocol suit, making major addressing scheme changes, or configuring newly installed interfaces. hw-module reset CF-243 Cisco IOS Configuration Fundamentals Command Reference April 2010 hw-module reset To reset a module by turning the power off and then on, use the hw-module reset command in privileged EXEC mode. hw-module module num reset Syntax Description Command Default This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines The num argument designates the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13. Examples This example shows how to reload a specific module: Router# hw-module module 3 reset module num Applies the command to a specific module; see the “Usage Guidelines” section for valid values. Release Modification 12.2(14)SX This command was introduced on the Supervisor Engine 720. 12.2(17d)SXB This command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was integrated into Cisco IOS 12.2(31)SB2. hw-module shutdown CF-244 Cisco IOS Configuration Fundamentals Command Reference April 2010 hw-module shutdown To shut down the module, use the hw-module shutdown command in privileged EXEC mode. hw-module module num shutdown Syntax Description Defaults This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines This command is supported on the SSL Services Module and the NAM. If you enter the hw-module shutdown command to shut down the module, you will have to enter the no power enable module command and the power enable module command to restart (power down and then power up) the module. Examples This example shows how to shut down and restart the module: Router# hw-module module 3 shutdown Router# no power enable module 3 Router# power enable module 3 module num Applies the command to a specific module; see the “Usage Guidelines” section for valid values. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. insecure CF-245 Cisco IOS Configuration Fundamentals Command Reference April 2010 insecure To configure a line as insecure, use the insecure command in line configuration mode. To disable this function, use the no form of this command. insecure no insecure Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Line configuration Command History Usage Guidelines Use this command to identify a modem line as insecure for DEC local area transport (LAT) classification. Examples In the following example, line 10 is configured as an insecure dialup line: Router(config)# line 10 Router(config-line)# insecure Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. international CF-246 Cisco IOS Configuration Fundamentals Command Reference April 2010 international If you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji) and print the Escape character as a single character instead of as the caret and bracket symbols (^[), use the international command in line configuration mode. To display characters in 7-bit format, use the no form of this command. international no international Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Line configuration Command History Usage Guidelines If you are configuring a Cisco IOS platform using the Cisco web browser user interface (UI), this function is enabled automatically when you enable the Cisco web browser UI using the ip http server global configuration command. Examples The following example enables a Cisco IOS platform to display 8-bit and multibyte characters and print the Escape character as a single character instead of as the caret and bracket symbols (^[) when you are using Telnet to access the platform: line vty 4 international Related Commands Release Modification 11.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal international Prints the Escape character as a single character instead of as the caret and bracket symbols (^[) for a current Telnet session in instances when you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji). ip bootp server CF-247 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip bootp server To enable the Bootstrap Protocol (BOOTP) service on your routing device, use the ip bootp server command in global configuration mode. To disable BOOTP services, use the no form of the command. ip bootp server no ip bootp server Syntax Description This command has no arguments or keywords. Defaults Enabled Command Modes Global configuration Command History Usage Guidelines By default, the BOOTP service is enabled. When disabled, the no ip bootp server command will appear in the configuration file. The integrated Dynamic Host Configuration Protocol (DHCP) server was introduced in Cisco IOS Release 12.0(1)T. Because DHCP is based on BOOTP, both of these services share the “well-known” UDP server port of 67 (per RFC 951, RFC 1534, and RFC 2131; the client port is 68). To disable DHCP services (DHCP relay and DHCP server), use the no service dhcp command. To disable BOOTP services (in releases 12.2(8)T and later), but leave DHCP services enabled, use the ip dhcp bootp ignore command. If both the BOOTP server and DHCP server are disabled, “ICMP port unreachable” messages will be sent in response to incoming requests on port 67, and the original incoming packet will be discarded. If DHCP is enabled, using the no ip bootp server command by itself will not stop the router from listening on UDP port 67. Note As with all minor services, the async line BOOTP service should be disabled on your system if you do not have a need for it in your network. Any network device that has User Data Protocol (UDP), TCP, BOOTP, DHCP, or Finger services should be protected by a firewall or have the services disabled to protect against Denial of Service attacks. Release Modification 11.2 This command was introduced. 12.0(1)T The DHCP relay agent and DHCP server features were introduced. BOOTP forwarding is now handled by the DHCP relay agent implementation. 12.2(8)T The ip dhcp bootp ignore command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip bootp server CF-248 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, BOOTP and DHCP services are disabled on the router: Router(config)# no ip bootp server Router(config)# no service dhcp Related Commands Command Description ip dhcp bootp ignore Configures the Cisco IOS DHCP server to selectively ignore and not reply to received Bootstrap Protocol (BOOTP) request packets, allowing you continue using DHCP while disabling BOOTP. service dhcp Enables the Cisco IOS Dynamic Host Configuration Protocol (DHCP) server and relay agent features. ip finger CF-249 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip finger To configure a system to accept Finger protocol requests (defined in RFC 742), use the ip finger command in global configuration mode. To disable this service, use the no form of this command. ip finger [rfc-compliant] no ip finger Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines The Finger service allows remote users to view the output equivalent to the show users [wide] command. When ip finger is configured, the router will respond to a telnet a.b.c.d finger command from a remote host by immediately displaying the output of the show users command and then closing the connection. When the ip finger rfc-compliant command is configured, the router will wait for input before displaying anything (as required by RFC 1288). The remote user can then enter the Return key to display the output of the show users EXEC command, or enter /W to display the output of the show users wide EXEC command. After this information is displayed, the connection is closed. Note As with all minor services, the Finger service should be disabled on your system if you do not have a need for it in your network. Any network device that has UDP, TCP, BOOTP, or Finger services should be protected by a firewall or have the services disabled to protect against Denial of Service attacks. Because of the potential for hung lines, the rfc-compliant form of this command should not be configured for devices with more than 20 simultaneous users. rfc-compliant (Optional) Configures the system to wait for “Return” or “/W” input when processing Finger requests. This keyword should not be used for those systems. Release Modification 11.3 This command was introduced. 12.1(5), 12.1(5)T This command was changed from being enabled by default to being disabled by default. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip finger CF-250 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example disables the Finger protocol: Router(config)# no ip finger ip ftp passive CF-251 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip ftp passive To configure the router to use only passive FTP connections, use the ip ftp passive command in global configuration mode. To allow all types of FTP connections, use the no form of this command. ip ftp passive no ip ftp passive Syntax Description This command has no arguments or keywords. Defaults All types of FTP connections are allowed. Command Modes Global configuration Command History Examples In the following example, the router is configured to use only passive FTP connections: Router(config)# ip ftp passive Related Commands Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip ftp password Specifies the password to be used for FTP connections. ip ftp source-interface Specifies the source IP address for FTP connections. ip ftp username Configures the username for FTP connections. ip ftp password CF-252 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip ftp password To specify the password to be used for File Transfer Protocol (FTP) connections, use the ip ftp password command in global configuration mode. To return the password to its default, use the no form of this command. ip ftp password [type] password no ip ftp password Syntax Description Defaults The router forms a password username@routername.domain. The variable username is the username associated with the current session, routername is the configured host name, and domain is the domain of the router. Command Modes Global configuration Command History Examples The following example configures the router to use the username “red” and the password “blue” for FTP connections: Router(config)# ip ftp username red Router(config)# ip ftp password blue Related Commands type (Optional) Type of encryption to use on the password. A value of 0 disables encryption. A value of 7 indicates proprietary encryption. password Password to use for FTP connections. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip ftp password Specifies the password to be used for FTP connections. ip ftp source-interface Specifies the source IP address for FTP connections. ip ftp username Configures the username for FTP connections. ip ftp source-interface CF-253 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip ftp source-interface To specify the source IP address for File Transfer Protocol (FTP) connections, use the ip ftp source-interface command in global configuration mode. To use the address of the interface where the connection is made, use the no form of this command. ip ftp source-interface interface-type interface-number no ip ftp source-interface Syntax Description Command Default The FTP source address is the IP address of the interface that the FTP packets use to leave the router. Command Modes Global configuration (config) Command History Usage Guidelines Use this command to set the same source address for all FTP connections. In Cisco IOS 12.3(6) and later releases, FTP is VRF-aware, which means that FTP transfer is supported across an interface within a VRF instance. To specify a VRF as a source for FTP connections, the VRF must be associated with the same interface that you configure with the ip ftp source-interface command. In this configuration, FTP looks for the destination IP address for file transfer in the specified VRF table. If the specified source interface is not up, Cisco IOS software selects the address of the interface closest to the destination as the source address. Examples The following example shows how to configure the router to use the IP address associated with Ethernet interface 0 as the source address on all FTP packets, regardless of which interface is actually used to send the packet: Router> enable Router# configure terminal Router(config)# ip ftp source-interface ethernet 0 The following example shows how to configure the router to use the VRF table named vpn1 to look for the destination IP address for the transfer of FTP packets: interface-type interface-number The interface type and number to use to obtain the source address for FTP connections. Release Modification 10.3 This command was introduced. 12.3(6) Destination address lookup in a Virtual Private Network (VPN) routing and forwarding (VRF) table was added for the transfer of FTP packets. 12.3(8)T This command was integrated into Cisco IOS Release 12.3(8)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip ftp source-interface CF-254 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# configure terminal Router(config)# ip ftp source-interface ethernet 0 Router(config)# ip vrf vpn1 Router(config-vrf)# rd 200:1 Router(config-vrf)# route-target both 200:1 Router(config-vrf)# interface ethernet 0 Router(config-if)# ip vrf forwarding vpn1 Router(config-if)# end Related Commands Command Description ip ftp passive Configures the router to use only passive FTP connections. ip ftp password Specifies the password to be used for FTP connections. ip ftp username Configures the username for FTP connections. ip ftp username CF-255 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip ftp username To configure the username for File Transfer Protocol (FTP) connections, use the ip ftp username command in global configuration mode. To configure the router to attempt anonymous FTP, use the no form of this command. ip ftp username username no ip ftp username Syntax Description Defaults The Cisco IOS software attempts an anonymous FTP. Command Modes Global configuration Command History Usage Guidelines The remote username must be associated with an account on the destination server. Examples In the following example, the router is configured to use the username “red” and the password “blue” for FTP connections: Router(config)# ip ftp username red Router(config)# ip ftp password blue Related Commands username Username for FTP connections. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip ftp passive Configures the router to use only passive FTP connections. ip ftp password Specifies the password to be used for FTP connections. ip ftp source-interface Specifies the source IP address for FTP connections. ip rarp-server CF-256 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rarp-server To enable the router to act as a Reverse Address Resolution Protocol (RARP) server, use the ip rarp-server command in interface configuration mode. To restore the interface to the default of no RARP server support, use the no form of this command. ip rarp-server ip-address no ip rarp-server ip-address Syntax Description Defaults Disabled Command Modes Interface configuration Command History Usage Guidelines This feature makes diskless booting of clients possible between network subnets where the client and server are on separate subnets. RARP server support is configurable on a per-interface basis, so that the router does not interfere with RARP traffic on subnets that need no RARP assistance. The Cisco IOS software answers incoming RARP requests only if both of the following two conditions are met: • The ip rarp-server command has been configured for the interface on which the request was received. • A static entry is found in the IP ARP table that maps the MAC address contained in the RARP request to an IP address. Use the show ip arp EXEC command to display the contents of the IP ARP cache. Sun Microsystems, Inc. makes use of RARP and UDP-based network services to facilitate network-based booting of SunOS on it’s workstations. By bridging RARP packets and using both the ip helper-address interface configuration command and the ip forward-protocol global configuration command, the Cisco IOS software should be able to perform the necessary packet switching to enable booting of Sun workstations across subnets. Unfortunately, some Sun workstations assume that the sender of the RARP response, in this case the router, is the host that the client can contact to TFTP load the bootstrap image. This causes the workstations to fail to boot. ip-address IP address that is to be provided in the source protocol address field of the RARP response packet. Normally, this is set to whatever address you configure as the primary address for the interface. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip rarp-server CF-257 Cisco IOS Configuration Fundamentals Command Reference April 2010 By using the ip rarp-server command, the Cisco IOS software can be configured to answer these RARP requests, and the client machine should be able to reach its server by having its TFTP requests forwarded through the router that acts as the RARP server. In the case of RARP responses to Sun workstations attempting to diskless boot, the IP address specified in the ip rarp-server interface configuration command should be the IP address of the TFTP server. In addition to configuring RARP service, the Cisco IOS software must be configured to forward UDP-based Sun portmapper requests to completely support diskless booting of Sun workstations. This can be accomplished using configuration commands of the following form: ip forward-protocol udp 111 interface interface name ip helper-address target-address RFC 903 documents the RARP. Examples The following partial example configures a router to act as a RARP server. The router is configured to use the primary address of the specified interface in its RARP responses. arp 172.30.2.5 0800.2002.ff5b arpa interface ethernet 0 ip address 172.30.3.100 255.255.255.0 ip rarp-server 172.30.3.100 In the following example, a router is configured to act as a RARP server, with TFTP and portmapper requests forwarded to the Sun server: ! Allow the router to forward broadcast portmapper requests ip forward-protocol udp 111 ! Provide the router with the IP address of the diskless sun arp 172.30.2.5 0800.2002.ff5b arpa interface ethernet 0 ! Configure the router to act as a RARP server, using the Sun Server's IP ! address in the RARP response packet. ip rarp-server 172.30.3.100 ! Portmapper broadcasts from this interface are sent to the Sun Server. ip helper-address 172.30.3.100 Related Commands Command Description ip forward-protocol Speeds up flooding of UDP datagrams using the spanning-tree algorithm. ip helper-address Forwards UDP broadcasts, including BOOTP, received on an interface. ip rcmd domain-lookup CF-258 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd domain-lookup To reenable the basic Domain Name Service (DNS) security check for rcp and rsh, use the ip rcmd domain-lookup command in global configuration mode. To disable the basic DNS security check for remote copy protocol (rcp) and remote shell protoco (rsh), use the no form of this command. ip rcmd domain-lookup no ip rcmd domain-lookup Syntax Description This command has no arguments or keywords. Defaults Enabled Command Modes Global configuration Command History Usage Guidelines The abbreviation RCMD (remote command) is used to indicate both rsh and rcp. DNS lookup for RCMD is enabled by default (provided general DNS services are enabled on the system using the ip domain-lookup command). The no ip rcmd domain-lookup command is used to disable the DNS lookup for RCMD. The ip rcmd domain-lookup command is used to reenable the DNS lookup for RCMD. DNS lookup for RCMD is performed as a basic security check. This check is performed using a host authentication process. When enabled, the system records the address of the requesting client. That address is mapped to a host name using DNS. Then a DNS request is made for the IP address for that host name. The IP address received is then checked against the original requesting address. If the address does not match with any of the addresses received from DNS, the RCMD request will not be serviced. This reverse lookup is intended to help protect against spoofing. However, please note that the process only confirms that the IP address is a valid “routable” address; it is still possible for a hacker to spoof the valid IP address of a known host. The DNS lookup is done after the TCP handshake but before the router (which is acting as a rsh/rcp server) sends any data to the remote client. The no ip rcmd domain-lookup will turn off DNS lookups for rsh and rcp only. The no ip domain-lookup command takes precedence over the ip rcmd domain-lookup command. This means that if the no ip domain-lookup command is in the current configuration, DNS will be bypassed for rcp and rsh even if the ip rcmd domain-lookup command is enabled. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip rcmd domain-lookup CF-259 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the DNS security check is disabled for RCMD (rsh/rcp): Router(config)# no ip rcmd domain-lookup Related Commands Command Description ip domain-lookup Enables the IP DNS-based host name-to-address translation. ip rcmd rcp-enable CF-260 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd rcp-enable To configure the Cisco IOS software to allow remote users to copy files to and from the router using remote copy protocol (rcp), use the ip rcmd rcp-enable command in global configuration mode. To disable rcp on the device, use the no form of this command. ip rcmd rcp-enable no ip rcmd rcp-enable Syntax Description This command has no arguments or keywords. Defaults To ensure security, the router is not enabled for rcp by default. Command Modes Global configuration Command History Usage Guidelines To allow a remote user to execute rcp commands on the router, you must also create an entry for the remote user in the local authentication database using the ip rcmd remote-host command. The no ip rcmd rcp-enable command does not prohibit a local user from using rcp to copy system images and configuration files to and from the router. To protect against unauthorized users copying the system image or configuration files, the router is not enabled for rcp by default. Examples In the following example, the rcp service is enabled on the system, the IP address assigned to the Loopback0 interface is used as the source address for outbound rcp and rsh packets, and access is granted to the user “netadmin3”on the remote host 172.16.101.101: Router(config)# ip rcmd rcp-enable Router(config)# ip rcmd source-interface Loopback0 Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3 Related Commands Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip rcmd remote-host Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp. ip rcmd remote-host CF-261 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd remote-host To create an entry for the remote user in a local authentication database so that remote users can execute commands on the router using remote shell protocol (rsh) or remote copy protocol (rcp), use the ip rcmd remote-host command in global configuration mode. To remove an entry for a remote user from the local authentication database, use the no form of this command. ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]] no ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]] Syntax Description Defaults No entries are in the local authentication database. Command Modes Global configuration Command History Usage Guidelines A TCP connection to a router is established using an IP address. Using the host name is valid only when you are initiating an rcp or rsh command from a local router. The host name is converted to an IP address using DNS or host-name aliasing. local-username Name of the user on the local router. You can specify the router name as the username. This name needs to be communicated to the network administrator or to the user on the remote system. To be allowed to remotely execute commands on the router, the remote user must specify this value correctly. ip-address IP address of the remote host from which the local router will accept remotely executed commands. Either the IP address or the host name is required. host-name Name of the remote host from which the local router will accept remotely executed commands. Either the host name or the IP address is required. remote-username Name of the user on the remote host from which the router will accept remotely executed commands. enable [level] (Optional) Enables the remote user to execute privileged EXEC commands using rsh or to copy files to the router using rcp. The range is from 1 to 15. The default is 15. For information on the enable level, refer to the privilege level global configuration command in the Release 12.2 Cisco IOS Security Command Reference. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip rcmd remote-host CF-262 Cisco IOS Configuration Fundamentals Command Reference April 2010 To allow a remote user to execute rcp or rsh commands on a local router, you must create an entry for the remote user in the local authentication database. You must also enable the router to act as an rsh or rcp server. To enable the router to act as an rsh server, issue the ip rcmd rsh-enable command. To enable the router to act as an rcp server, issue the ip rcmd rcp-enable command.The router cannot act as a server for either of these protocols unless you explicitly enable the capacity. A local authentication database, which is similar to a UNIX .rhosts file, is used to enforce security on the router through access control. Each entry that you configure in the authentication database identifies the local user, the remote host, and the remote user. To permit a remote user of rsh to execute commands in privileged EXEC mode or to permit a remote user of rcp to copy files to the router, specify the enable keyword and level. For information on the enable level, refer to the privilege level global configuration command in the Release 12.2 Cisco IOS Security Command Reference. An entry that you configure in the authentication database differs from an entry in a UNIX .rhosts file in the following aspect. Because the .rhosts file on a UNIX system resides in the home directory of a local user account, an entry in a UNIX .rhosts file need not include the local username; the local username is determined from the user account. To provide equivalent support on a router, specify the local username along with the remote host and remote username in each authentication database entry that you configure. For a remote user to be able to execute commands on the router in its capacity as a server, the local username, host address or name, and remote username sent with the remote client request must match values configured in an entry in the local authentication file. A remote client host should be registered with DNS. The Cisco IOS software uses DNS to authenticate the remote host’s name and address. Because DNS can return several valid IP addresses for a host name, the Cisco IOS software checks the address of the requesting client against all of the IP addresses for the named host returned by DNS. If the address sent by the requester is considered invalid, that is, it does not match any address listed with DNS for the host name, then the software will reject the remote-command execution request. Note that if no DNS servers are configured for the router, then that device cannot authenticate the host in this manner. In this case, the Cisco IOS software sends a broadcast request to attempt to gain access to DNS services on another server. If DNS services are not available, you must use the no ip domain-lookup command to disable the attempt to gain access to a DNS server by sending a broadcast request. If DNS services are not available and, therefore, you bypass the DNS security check, the software will accept the request to remotely execute a command only if all three values sent with the request match exactly the values configured for an entry in the local authentication file. Examples The following example allows the remote user named netadmin3 on a remote host with the IP address 172.16.101.101 to execute commands on router1 using the rsh or rcp protocol. User netadmin3 is allowed to execute commands in privileged EXEC mode. Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3 enable Related Commands Command Description ip rcmd rcp-enable Configures the Cisco IOS software to allow remote users to copy files to and from the router. ip rcmd remote-host CF-263 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip domain-lookup Enables the IP DNS-based host name-to-address translation. ip rcmd rsh-enable Configures the router to allow remote users to execute commands on it using the rsh protocol. Command Description ip rcmd remote-username CF-264 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd remote-username To configure the remote username to be used when requesting a remote copy using remote copy protocol (rcp), use the ip rcmd remote-username command in global configuration mode. To remove from the configuration the remote username, use the no form of this command. ip rcmd remote-username username no ip rcmd remote-username username Syntax Description Defaults If you do not issue this command, the Cisco IOS software sends the remote username associated with the current tty process, if that name is valid, for rcp copy commands. For example, if the user is connected to the router through Telnet and the user was authenticated through the username command, then the software sends that username as the remote username. Note The remote username must be associated with an account on the destination server. If the username for the current tty process is not valid, the Cisco IOS software sends the host name as the remote username. For rcp boot commands, the Cisco IOS software sends the access server host name by default. Note For Cisco, tty lines are commonly used for access services. The concept of tty originated with UNIX. For UNIX systems, each physical device is represented in the file system. Terminals are called tty devices (tty stands for teletype, the original UNIX terminal). Command Modes Global configuration Command History Usage Guidelines The rcp protocol requires that a client send the remote username on an rcp request to the server. Use this command to specify the remote username to be sent to the server for an rcp copy request. If the server has a directory structure, as do UNIX systems, all files and images to be copied are searched for or written relative to the directory of the remote user’s account. username Name of the remote user on the server. This name is used for rcp copy requests. All files and images to be copied are searched for or written relative to the directory of the remote user’s account, if the server has a directory structure, for example, as do UNIX systems. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip rcmd remote-username CF-265 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note Cisco IOS Release 10.3 added the ip keyword to rcmd commands. If you are upgrading from Release 10.2 to Release 10.3 or a later release, this keyword is automatically added to any rcmd commands you have in your Release 10.2 configuration files. Examples The following example configures the remote username to netadmin1: Router(config)# ip rcmd remote-username netadmin1 Related Commands Command Description boot network rcp Changes the default name of the network configuration file from which to load configuration commands. boot system rcp Specifies the system image that the router loads at startup. bridge acquire Forwards any frames for stations that the system has learned about dynamically. copy Copies any file from a source to a destination. ip rcmd rsh-enable CF-266 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd rsh-enable To configure the router to allow remote users to execute commands on it using remote shell protocol (rsh), use the ip rcmd rsh-enable command in global configuration mode. To disable a router that is enabled for rsh, use the no form of this command. ip rcmd rsh-enable no ip rcmd rsh-enable Syntax Description This command has no arguments or keywords. Defaults To ensure security, the router is not enabled for rsh by default. Command Modes Global configuration Command History Usage Guidelines rsh, used as a client process, gives users the ability to remotely get router information (such as status) without the need to connect into the router and then disconnect. This is valuable when looking at many statistics on many different routers. Use this command to enable the router to receive rsh requests from remote users. In addition to issuing this command, you must create an entry for the remote user in the local authentication database to allow a remote user to execute rsh commands on the router. The no ip rcmd rsh-enable command does not prohibit a local user of the router from executing a command on other routers and UNIX hosts on the network using rsh. The no form of this command only disables remote access to rsh on the router. Examples The following example enables a router as an rsh server: Router(config)# ip rcmd rsh-enable Related Commands Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip rcmd remote-host Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp. ip rcmd source-interface CF-267 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip rcmd source-interface To force remote copy protocol (rcp) or remote shell protocol (rsh) to use the IP address of a specified interface for all outgoing rcp/rsh communication packets, use the ip rcmd source-interface command in global configuration mode. To disable a previously configured ip rcmd source-interface command, use the no form of this command. ip rcmd source-interface interface-id no ip rcmd source-interface interface-id Syntax Description Defaults The address of the interface closest to the destination is used as the source interface for rcp/rsh communications. Command Modes Global configuration Command History Usage Guidelines If this command is not used, or if the interface specified in this command is not available (not up), the Cisco IOS software uses the address of the interface closest to the destination as the source address. Use this command to force the system to tag all outgoing rcp/rsh packets with the IP address associated with the specified interface. This address is used as the source address as long as the interface is in the up state. This command is especially useful in cases where the router has many interfaces, and you want to ensure that all rcp and/or rsh packets from this router have the same source IP address. A consistent address is preferred so that the other end of the connection (the rcp/rsh server or client) can maintain a single session. The other benefit of a consistent address is that an access list can be configured on the remote device. The specified interface must have an IP address associated with it. If the specified interface does not have an IP address or is in a down state, then rcp/rsh reverts to the default. To avoid this, add an IP address to the subinterface or bring the interface to the up state. Examples In the following example, Loopback interface 0 is assigned an IP address of 220.144.159.200, and the ip rcmd source-interface command is used to specify that the source IP address for all rcp/rsh packets will be the IP address assigned to the Loopback0 interface: interface Loopback0 interface-id The name and number used to identify the interface. For example, Loopback2. Release Modification 11.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip rcmd source-interface CF-268 Cisco IOS Configuration Fundamentals Command Reference April 2010 description Loopback interface ip address 220.144.159.200 255.255.255.255 no ip directed-broadcast ! . . . clock timezone GMT 0 ip subnet-zero no ip source-route no ip finger ip rcmd source-interface Loopback0 ip telnet source-interface Loopback0 ip tftp source-interface Loopback0 ip ftp source-interface Loopback0 ip ftp username cisco ip ftp password shhhhsecret no ip bootp server ip domain-name net.galaxy ip name-server 220.144.159.1 ip name-server 220.144.159.2 ip name-server 219.10.2.1 ! . . . Related Commands Command Description ip rcmd remote-host Creates an entry for the remote user in a local authentication database so that remote users can execute commands on the router using rsh or rcp. ip telnet source-interface CF-269 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip telnet source-interface To specify the IP address of an interface as the source address for Telnet connections, use the ip telnet source-interface command in global configuration mode. To reset the source address to the default for each connection, use the no form of this command. ip telnet source-interface interface no ip telnet source-interface Syntax Description Defaults The address of the closest interface to the destination is the source address. Command Modes Global configuration Command History Usage Guidelines Use this command to set the IP address of an interface as the source for all Telnet connections. If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the destination as the source address. Examples The following example forces the IP address for Ethernet interface 1 as the source address for Telnet connections: Router(config)# ip telnet source-interface Ethernet1 Related Commands interface The interface whose address is to be used as the source for Telnet connections. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description ip radius source-interface Forces RADIUS to use the IP address of a specified interface for all outgoing RADIUS packets. ip tftp source-interface CF-270 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip tftp source-interface To specify the IP address of an interface as the source address for TFTP connections, use the ip tftp source-interface command in global configuration mode. To return to the default, use the no form of this command. ip tftp source-interface interface-type interface-number no ip tftp source-interface Syntax Description Command Default The address of the closest interface to the destination is selected as the source address. Command Modes Global configuration Command History Usage Guidelines Use this command to set the IP address of an interface as the source for all TFTP connections. If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the destination as the source address. In Cisco IOS 12.3(6) and later releases, TFTP is VRF-aware, which means that TFTP transfer is supported across an interface within a Virtual Private Network (VPN) routing and forwarding (VRF) instance. To specify a VRF as a source for TFTP connections, the VRF must be associated with the same interface that you configure with the ip tftp source-interface command. In this configuration, TFTP looks for the destination IP address for file transfer in the specified VRF table. Examples The following example shows how to configure the router to use the IP address associated with loopback interface 0 as the source address for TFTP connections: configure terminal ! ip tftp source-interface loopback0 The following example shows how to configure the router to use the VRF table named vpn1 to look for the destination IP address for TFTP connections: interface-type interface-number The interface type and number whose address is to be used as the source for TFTP connections. Release Modification 11.1 This command was introduced. 12.3(6) Destination address lookup in a Virtual Private Network (VPN) routing and forwarding (VRF) table was added for the transfer of TFTP packets. 12.3(8)T This command was integrated into Cisco IOS Release 12.3(8)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip tftp source-interface CF-271 Cisco IOS Configuration Fundamentals Command Reference April 2010 configure terminal ! ip tftp source-interface ethernet 1/0 ! ip vrf vpn1 rd 100:1 route-target both 100:1 ! interface ethernet 1/0 ip vrf forwarding vpn1 end In this example, file transfer using TFTP is accomplished across an interface within a VRF (VRF vpn1) link. Related Commands Command Description ip ftp source-interface Forces outgoing FTP packets to use the IP address of a specified interface as the source address. ip radius source-interface Forces outgoing RADIUS packets to use the IP address of a specified interface as the source address. ip wccp web-cache accelerated CF-272 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip wccp web-cache accelerated To enable the hardware acceleration for WCCP version 1, use the ip wccp web-cache accelerated command in global configuration mode. To disable hardware acceleration, use the no form of this command. ip wccp web-cache accelerated [[group-address groupaddress] | [redirect-list access-list] | [group-list access-list] | [password password]] no ip wccp web-cache accelerated Syntax Description Defaults Disabled Command Modes Global configuration (config) Command History Usage Guidelines This command is supported on software releases later than cache engine software Release ACNS 4.2.1. The group-address group-address option requires a multicast address that is used by the router to determine which cache engine should receive redirected messages. This option instructs the router to use the specified multicast IP address to coalesce the “I See You” responses for the “Here I Am” messages that it has received on this group address. In addition, the response is sent to the group address. The default is for no group-address to be configured, so that all “Here I Am” messages are responded to with a unicast reply. group-address group-address (Optional) Directs the router to use a specified multicast IP address for communication with the WCCP service group. See the “Usage Guidelines” section for additional information. redirect-list access-list (Optional) Directs the router to use an access list to control traffic that is redirected to this service group. See the “Usage Guidelines” section for additional information. group-list access-list (Optional) Directs the router to use an access list to determine which cache engines are allowed to participate in the service group. See the “Usage Guidelines” section for additional information. password password (Optional) Specifies a string that directs the router to apply MD5 authentication to messages received from the service group specified by the service name given. See the “Usage Guidelines” section for additional information. Release Modification 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Cisco IOS Release 12.2(17d)SXB. 12.2(18)SXD1 This command was changed to support the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. ip wccp web-cache accelerated CF-273 Cisco IOS Configuration Fundamentals Command Reference April 2010 The redirect-list access-list option instructs the router to use an access list to control the traffic that is redirected to the cache engines of the service group that is specified by the service-name given. The access-list argument specifies either a number from 1 to 99 to represent a standard or extended access-list number, or a name to represent a named standard or extended access list. The access list itself specifies the traffic that is permitted to be redirected. The default is for no redirect-list to be configured (all traffic is redirected). The group-list access-list option instructs the router to use an access list to control the cache engines that are allowed to participate in the specified service group. The access-list argument specifies either a number from 1 to 99 to represent a standard access-list number, or a name to represent a named standard access list. The access list specifies which cache engines are permitted to participate in the service group. The default is for no group-list to be configured, so that all cache engines may participate in the service group. The password can be up to seven characters. When you designate a password, the messages that are not accepted by the authentication are discarded. The password name is combined with the HMAC MD5 value to create security for the connection between the router and the cache engine. Examples This example shows how to enable the hardware acceleration for WCCP version 1: Router(config)# ip wccp web-cache accelerated Related Commands Command Description ip wccp version Specifies which version of WCCP to configure on your router. length CF-274 Cisco IOS Configuration Fundamentals Command Reference April 2010 length To set the terminal screen length, use the length command in line configuration mode. To restore the default value, use the no form of this command. length screen-length no length Syntax Description Defaults Screen length of 24 lines Command Modes Line configuration Command History Usage Guidelines The Cisco IOS software uses the value of this command to determine when to pause during multiple-screen output. Not all commands recognize the configured screen length. For example, the show terminal command assumes a screen length of 24 lines or more. Examples In the following example, the terminal type is specified and the screen pause function is disabled for the terminal connection on line 6: Router(config)# line 6 Router(config-line)# terminal-type VT220 Router(config-line)# length 0 Related Commands screen-length The number of lines on the screen. A value of zero disables pausing between screens of output. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal length Sets the number of lines on the current terminal screen for the current session. load-interval CF-275 Cisco IOS Configuration Fundamentals Command Reference April 2010 load-interval To change the length of time for which data is used to compute load statistics, use the load-interval command in interface configuration mode or Frame Relay DLCI configuration mode. To revert to the default setting, use the no form of this command. load-interval seconds no load-interval seconds Syntax Description Command Default Enabled Command Modes Interface configuration Frame Relay DLCI configuration Command History Usage Guidelines To make computations more reactive to short bursts of traffic, you can shorten the length of time over which load averages are computed. If the load interval is set to 30 seconds, new data is used for load calculations over a 30-second period. This data is used to compute load statistics, including the input rate in bits and packets per second, the output rate in bits and packets per second, the load, and reliability. Load data is gathered every five seconds. This data is used for a weighted-average calculation in which recent load data has more weight in the computation than older load data. If the load interval is set to 30 seconds, the average is computed for the last 30 seconds of load data. If you change the calculation interval from the default of five minutes to a shorter period of time, the input and output statistics that are displayed by the show interface command or the show frame-relay pvc command will be more current and will be based on more nearly instantaneous data, rather than reflecting the average load over a longer period of time. This command is often used for dial backup purposes to increase or decrease the likelihood of implementation of a backup interface, but it can be used on any interface. seconds Length of time for which data is used to compute load statistics. Value is a multiple of 30, from 30 to 600 (30, 60, 90, 120, and so on). The default is 300 seconds. Release Modification 10.3 This command was introduced. 12.2(4)T This command was made available in Frame Relay DLCI configuration mode. 12.2(18)SXF Support for this command was introduced on the Supervisor Engine 720. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. load-interval CF-276 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples Interface Example In the following example, the default average of five minutes is changed to a 30-second average. A burst in traffic that would not trigger a dial backup for an interface configured with the default five-minute interval might trigger a dial backup for this interface, which is set for the shorter 30-second interval. Router(config)# interface serial 0 Router(config-if)# load-interval 30 Frame Relay PVC Example In the following example, the load interval is set to 60 seconds for a Frame Relay PVC with the DLCI 100: Router(config)# interface serial 1/1 Router(config-if)# frame-relay interface-dlci 100 Router(config-fr-dlci)# load-interval 60 Related Commands Command Description show interfaces Displays statistics for all interfaces configured on the router or access server. location CF-277 Cisco IOS Configuration Fundamentals Command Reference April 2010 location To provide a description of the location of a serial device, use the location command in line configuration mode. To remove the description, use the no form of this command. location text no location Syntax Description Defaults No location description is provided. Command Modes Line configuration Command History Usage Guidelines The location command enters information about the device location and status. Use the show users all EXEC command to display the location information. Examples In the following example, the location description for the console line is given as “Building 3, Basement”: Router(config)# line console Router(config-line)# location Building 3, Basement text Location description. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. lock CF-278 Cisco IOS Configuration Fundamentals Command Reference April 2010 lock To configure a temporary password on a line, use the lock command in EXEC mode. lock Syntax Description This command has no arguments or keywords. Defaults Not locked Command Modes EXEC Command History Usage Guidelines You can prevent access to your session while keeping your connection open by setting up a temporary password. To lock access to the terminal, perform the following steps: Step 1 Enter the lock command. The system prompts you for a password. Step 2 Enter a password, which can be any arbitrary string. The system will prompt you to confirm the password. The screen then clears and displays the message “Locked.” Step 3 To regain access to your sessions, reenter the password. The Cisco IOS software honors session timeouts on a locked lines. You must clear the line to remove this feature. The system administrator must set the line up to allow use of the temporary locking feature by using the lockable line configuration command. Examples The following example shows configuring the router as lockable, saving the configuration, and then locking the current session for the user: Router(config-line)# lockable Router(config-line)# ^Z Router# copy system:running-config nvram:startup-config Building configuration... OK Router# lock Password: Again: Locked Password: Router# Release Modification 10.0 This command was introduced in a release prior to Cisco IOS Release 10.0. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. lock CF-279 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description lockable Enables the lock EXEC command. login (EXEC) Enables or changes a login username. lockable CF-280 Cisco IOS Configuration Fundamentals Command Reference April 2010 lockable To enable use of the lock EXEC command, use the lockable command in line configuration mode. To reinstate the default (the terminal session cannot be locked), use the no form of this command. lockable no lockable Syntax Description This command has no arguments or keywords. Defaults Sessions on the line are not lockable (the lock EXEC command has no effect). Command Modes Line configuration Command History Usage Guidelines This command enables use of temporary terminal locking, which is executed using the lock EXEC command. Terminal locking allows a user keep the current session open while preventing access by other users. Examples In the following example, the terminal connection is configured as lockable, then the current connection is locked: Router# configure terminal Router(config)# line console 0 Router(config-line)# lockable Router(config)# ^Z Router# lock Password: Again: Locked Password: Router# Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description lock Prevents access to your session by other users by setting a temporary password on your terminal line. log config CF-281 Cisco IOS Configuration Fundamentals Command Reference April 2010 log config To enter configuration change logger configuration mode, use the log config command in archive configuration mode. log config Syntax Description This command has no arguments or keywords. Command Default None Command Modes Archive configuration Command History Examples The following example shows how to place the router in configuration change logger configuration mode: Router# configure terminal ! Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# Related Commands Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. Command Description archive Enters archive configuration mode. hidekeys Suppresses the display of password information in configuration log files. logging enable Enables the logging of configuration changes. logging size Specifies the maximum number of entries retained in the configuration log. notify syslog Enables the sending of notifications of configuration changes to a remote syslog. show archive log config Displays entries from the configuration log. logging enable CF-282 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging enable To enable the logging of configuration changes, use the logging enable command in configuration change logger configuration mode. To disable the logging of configuration changes, use the no form of this command. logging enable no logging enable Syntax Description This command has no arguments or keywords. Command Default Configuration change logging is disabled. Command Modes Configuration change logger configuration Command History Usage Guidelines Use this command if you want to log configuration changes. If you disable configuration logging, all configuration log records that were collected are purged. Examples The following example shows how to enable configuration logging: Router# configure terminal ! Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# logging enable Router(config-archive-log-config)# end The following example shows how to clear the configuration log by disabling and then reenabling the configuration log: Router# configure terminal ! Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# no logging enable Router(config-archive-log-config)# logging enable Router(config-archive-log-config)# end Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. logging event bundle-status CF-283 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands logging event bundle-status To enable message bundling, use the logging event bundle-status command in interface configuration mode. To disable message bundling, use the no form of this command. logging event bundle-status no logging event bundle-status Syntax Description Defaults Message bundling does not occur. Command Modes Global configuration Command History Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces. Command Description archive Enters archive configuration mode. hidekeys Suppresses the display of password information in configuration log files. log config Enters configuration change logger configuration mode. logging size Specifies the maximum number of entries retained in the configuration log. notify syslog Enables the sending of notifications of configuration changes to a remote syslog. show archive log config Displays entries from the configuration log. default Enables system logging of interface state-change events on all interfaces in the system. boot Enables system logging of interface state-change events on all interfaces in the system during system initialization. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logging event bundle-status CF-284 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to enable the system logging of the interface state-change events on all interfaces in the system: Router(config)# logging event bundle-status Router(config)# end Router # show logging event bundle-status Aug 4 17:36:48.240 UTC: %EC-SP-5-UNBUNDLE: Interface FastEthernet9/23 left the port-channel Port-channel2 Aug 4 17:36:48.256 UTC: %LINK-SP-5-CHANGED: Interface FastEthernet9/23, changed state to administratively down Aug 4 17:36:47.865 UTC: %EC-SPSTBY-5-UNBUNDLE: Interface FastEthernet9/23 left the port-channel Port-channel2 Router # show logging event bundle-status Aug 4 17:37:35.845 UTC: %EC-SP-5-BUNDLE: Interface FastEthernet9/23 joined port-channel Port-channel2 Aug 4 17:37:35.533 UTC: %EC-SPSTBY-5-BUNDLE: Interface FastEthernet9/23 joined port-channel Port-channel2 Related Commands Command Description show running-config Displays the status and configuration of the module or Layer 2 VLAN. logging event link-status (global configuration) CF-285 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging event link-status (global configuration) To change the default or set the link-status event messaging during system initialization, use the logging event link-status command in global configuration mode. To disable the link-status event messaging, use the no form of this command. logging event link-status {default | boot} no logging event link-status {default | boot} Syntax Description Defaults Interface state-change messages are not sent. Command Modes Global configuration Command History Usage Guidelines You do not have to enter the logging event link-status boot command to enable link-status messaging during system initialization. The logging event link-status default command logs system messages even during system initialization. If you enter both the logging event link-status default and the no logging event link-status boot commands, the interface state-change events are logged after all modules in the Cisco 7600 series router come online after system initialization. The logging event link-status default and the no logging event link-status boot commands are saved and retained in the running configuration of the system. When both the logging event link-status default and the no logging event link-status boot commands are present in the running configuration and you want to display the interface state-change messages during system initialization, enter the logging event link-status boot command. Examples This example shows how to enable the system logging of the interface state-change events on all interfaces in the system: Router(config)# logging event link-status default Router(config)# default Enables system logging of interface state-change events on all interfaces in the system. boot Enables system logging of interface state-change events on all interfaces in the system during system initialization. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logging event link-status (global configuration) CF-286 Cisco IOS Configuration Fundamentals Command Reference April 2010 This example shows how to enable the system logging of interface state-change events on all interfaces during system initialization: Router(config)# logging event link-status boot Router(config)# This example shows how to disable the system logging of interface state-change events on all interfaces: Router(config)# no logging event link-status default Router(config)# This example shows how to disable the system logging of interface state-change events during system initialization: Router(config)# no logging event link-status boot Router(config)# Related Commands Command Description show running-config Displays the status and configuration of the module or Layer 2 VLAN. logging event link-status (interface configuration) CF-287 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging event link-status (interface configuration) To enable the link-status event messaging on an interface, use the logging event link-status command in interface configuration mode. To disable the link-status event messaging, use the no form of this command. logging event link-status no logging event link-status Syntax Description This command has no arguments or keywords. Defaults Interface state-change messages are not sent. Command Modes Interface configuration Command History Usage Guidelines To enable system logging of interface state-change events on a specific interface, enter the logging event link-status command. To enable system logging of interface state-change events on all interfaces in the system, enter the logging event link-status command. Examples This example shows how to enable the system logging of the interface state-change events on an interface: Router(config-if)# logging event link-status Router(config-if)# This example shows how to disable the system logging of the interface state-change events on an interface: Router(config-if)# no logging event link-status Router(config-if)# Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. logging event link-status (interface configuration) CF-288 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description show running-config Displays the status and configuration of the module or Layer 2 VLAN. logging event subif-link-status CF-289 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging event subif-link-status To enable the link-status event messaging on a subinterface, use the logging event subif-link-status command in interface configuration mode. To disable the link-status event messaging on a subinterface, use the no form of this command. logging event subif-link-status no logging event subif-link-status Syntax Description This command has no arguments or keywords. Defaults Subinterface state-change messages are not sent. Command Modes Interface configuration Command History Usage Guidelines This command is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720. To enable system logging of interface state-change events on a specific subinterface, enter the logging event subif-link-status command. To enable system logging of interface state-change events on a specific interface, enter the logging event link-status command. To enable system logging of interface state-change events on all interfaces in the system, enter the logging event link-status command. Examples This example shows how to enable the system logging of the interface state-change events on a subinterface: Router(config-if)# logging event subif-link-status Router(config-if)# This example shows how to disable the system logging of the interface state-change events on a subinterface: Router(config-if)# no logging event subif-link-status Router(config-if)# Release Modification 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logging event subif-link-status CF-290 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description show running-config Displays the status and configuration of the module or Layer 2 VLAN. logging event trunk-status CF-291 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging event trunk-status To enable trunk status messaging, use the logging event trunk-status command in interface configuration mode. To disable trunk status messaging, use the no form of this command. logging event trunk-status no logging event trunk-status Syntax Description This command has no keywords or variables. Defaults This command has no default settings. Command Modes Interface configuration mode Command History Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces. Examples This example shows how to enable the trunk status messaging on physical ports: Router(config)# logging event trunk-status Router(config)# end Router# show logging event trunk-status Aug 4 17:27:01.404 UTC: %DTP-SPSTBY-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk Aug 4 17:27:00.773 UTC: %DTP-SP-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk Router# Release Modification 12.2(14)SX Support for this command was introduced. logging ip access-list cache (global configuration) CF-292 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging ip access-list cache (global configuration) To configure the Optimized ACL Logging (OAL) parameters, use the logging ip access-list cache command in global configuration mode. To return to the default settings, use the no form of this command. logging ip access-list cache {entries entries | {interval seconds | rate-limit pps | threshold packets} no logging ip access-list cache [entries | interval | rate-limit | threshold] Syntax Description Defaults The defaults are as follows: • entries—8000 entries. • seconds—300 seconds (5 minutes). • rate-limit pps—0 (rate limiting is off) and all packets are logged. • threshold packets—0 (rate limiting is off) and the system log is not triggered by the number of packet matches. Command Modes Global configuration Command History Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720 only. OAL is supported on IPv4 unicast traffic only. You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are incompatible. With OAL configured, use SPAN to capture traffic. If the entry is inactive for the duration that is specified in the update-interval seconds command, the entry is removed from the cache. entries entries Specifies the maximum number of log entries that are cached in the software; valid values are from 0 to 1048576 entries. interval seconds Specifies the maximum time interval before an entry is sent to syslog; valid values are from 5 to 86400 seconds. rate-limit pps Specifies the number of packets that are logged per second in the software; valid values are from 10 to 1000000 pps. threshold packets Specifies the number of packet matches before an entry is sent to syslog; valid values are from 1 to 1000000 packets. Release Modification 12.2(17d)SXB Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logging ip access-list cache (global configuration) CF-293 Cisco IOS Configuration Fundamentals Command Reference April 2010 If you enter the no logging ip access-list cache command without keywords, all the parameters are returned to the default values. You must set ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets. When enabling the IP "too short" check using the mls verify ip length minimum command, valid IP packets with with an IP protocol field of ICMP(1), IGMP(2), IP(4), TCP(6), UDP(17), IPv6(41), GRE(47), or SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched. Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can cause routing protocol neighbor flapping as they are incompatible Examples This example shows how to specify the maximum number of log entries that are cached in the software: Router(config)# logging ip access-list cache entries 200 This example shows how to specify the maximum time interval before an entry is sent to the system log: Router(config)# logging ip access-list cache interval 350 This example shows how to specify the number of packets that are logged per second in the software: Router(config)# logging ip access-list cache rate-limit 100 This example shows how to specify the number of packet matches before an entry is sent to the system log: Router(config)# logging ip access-list cache threshold 125 Related Commands Command Description clear logging ip access-list cache Clears all the entries from the OAL cache and sends them to the syslog. logging ip access-list cache (interface configuration) Enables an OAL-logging cache on an interface that is based on direction. show logging ip access-list Displays information about the logging IP access list. update-interval seconds Removes entries from the cache that are inactive for the duration that is specified in the command. logging ip access-list cache (interface configuration) CF-294 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging ip access-list cache (interface configuration) To enable an Optimized ACL Logging (OAL)-logging cache on an interface that is based on direction, use the logging ip access-list cache command in interface configuration mode. To disable OAL, use the no form of this command. logging ip access-list cache [in | out] no logging ip access-list cache Syntax Description Defaults Disabled Command Modes Interface configuration Command History Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720 only. This command is supported on traffic that matches the log keyword in the applied ACL. You must set ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets. On systems that are configured with a PFC3A, support for the egress direction on tunnel interfaces is not supported. OAL is supported on IPv4 unicast traffic only. You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are incompatible. With OAL configured, use SPAN to capture traffic. If the entry is inactive for the duration that is specified in the update-interval seconds command, the entry is removed from the cache. If you enter the no logging ip access-list cache command without keywords, all the parameters are returned to the default values. When enabling the IP "too short" check using the mls verify ip length minimum command, valid IP packets with with an IP protocol field of ICMP(1), IGMP(2), IP(4), TCP(6), UDP(17), IPv6(41), GRE(47), or SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched. in (Optional) Enables OAL on ingress packets. out (Optional) Enables OAL on egress packets. Release Modification 12.2(17d)SXB Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logging ip access-list cache (interface configuration) CF-295 Cisco IOS Configuration Fundamentals Command Reference April 2010 Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can cause routing protocol neighbor flapping as they are incompatible Examples This example shows how to enable OAL on ingress packets: Router(config-if)# logging ip access-list cache in This example shows how to enable OAL on egress packets: Router(config-if)# logging ip access-list cache out Related Commands Command Description clear logging ip access-list cache Clears all the entries from the OAL cache and sends them to the syslog. logging ip access-list cache (global configuration) Configures the OAL parameters. show logging ip access-list Displays information about the logging IP access list. update-interval seconds Removes entries from the cache that are inactive for the duration that is specified in the command. logging persistent (config-archive-log-cfg) CF-296 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging persistent (config-archive-log-cfg) To enable the configuration logging persistent feature and to select how the configuration commands are to be saved to the Cisco IOS secure file system, use the logging persistent command in the log config submode of archive configuration mode. To disable this capability, use the no form of this command. logging persistent {auto | manual} no logging persistent {auto | manual} Syntax Description Command Default The configuration commands are not saved to the Cisco IOS secure file system. Command Modes Archive configuration mode, log config (configuration-change logger) submode (config-archive-log-cfg)# Command History Usage Guidelines When you use the manual keyword, you must save each configuration command manually to the Cisco IOS secure file system. To do this, you must use the archive log config persistent save command. Examples The following example automatically saves the configuration commands to the Cisco IOS secure file system: Router(config)# archive Router(config-archive)# log config Router(config-archive-log-cfg)# logging enable Router(config-archive-log-cfg)# logging persistent auto auto Specifies that each configuration command will be saved automatically to the Cisco IOS secure file system. manual Specifies that each configuration command must be saved manually to the Cisco IOS secure file system. Release Modification 12.0(26)S This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.4(11)T This command was integrated into Cisco IOS Release 12.4(11)T. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. logging persistent (config-archive-log-cfg) CF-297 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description logging persistent reload Sequentially applies configuration commands in the configuration logger database to the running-config file after a reload. archive log config persistent save Saves the persisted commands in the configuration log to the Cisco IOS secure file system. logging persistent reload (config-archive-log-cfg) CF-298 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging persistent reload (config-archive-log-cfg) To sequentially apply the configuration commands saved in the configuration logger database (since the last write memory command) to the running-config file after a reload, use the logging persistent reload command in configuration change logger configuration mode in archive configuration mode. To disable this capability, use the no form of this command. logging persistent reload no logging persistent reload Syntax Description This command has no arguments or keywords. Command Default The configuration commands saved in the configuration logger database are not applied to the running-config file. Command Modes Archive config mode; log config (configuration change logger) submode (config-archive-log-cfg)# Command History Usage Guidelines Use the logging persistent reload command when you want changed configuration commands to take effect on the next reload of the router. Examples The following example applies the configuration commands in the configuration logger database to the running-config file after the next reload: Router(config-archive-log-cfg)# logging persistent reload Related Commands Release Modification 12.2(33)SRA This command was introduced. 12.4(11)T This command was integrated into Cisco IOS Release 12.4(11)T. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. Command Description logging persistent Enables the configuration logging persistent feature. logging size CF-299 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging size To specify the maximum number of entries retained in the configuration log, use the logging size command in configuration change logger configuration mode. To reset the default value, use the no form of this command. logging size entries no logging size Syntax Description Defaults 100 entries Command Modes Configuration change logger configuration Command History Usage Guidelines When the configuration log is full, the oldest log entry will be removed every time a new entry is added. Note If a new log size is specified that is smaller than the current log size, the oldest entries will be immediately purged until the new log size is satisfied, regardless of the age of the log entries. Examples The following example shows how to specify that the configuration log may have a maximum of 200 entries: Router(config-archive-log-config)# logging size 200 The following example shows how to clear the configuration log by reducing the log size to 1, then resetting the log size to the desired value. Only the most recent configuration log file will be saved. Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# logging size 1 Router(config-archive-log-config)# logging size 200 entries The maximum number of entries retained in the configuration log. Valid values range from 1 to 1000. The default value is 100 entries. Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. logging size CF-300 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description archive Enters archive configuration mode. hidekeys Suppresses the display of password information in configuration log files. log config Enters configuration change logger configuration mode. logging enable Enables the logging of configuration changes. notify syslog Enables the sending of notifications of configuration changes to a remote syslog. show archive log config Displays entries from the configuration log. logging synchronous CF-301 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging synchronous To synchronize unsolicited messages and debug output with solicited Cisco IOS software output and prompts for a specific console port line, auxiliary port line, or vty, use the logging synchronous command in line configuration mode. To disable synchronization of unsolicited messages and debug output, use the no form of this command. logging synchronous [level severity-level | all] [limit number-of-lines] no logging synchronous [level severity-level | all] [limit number-of-lines] Syntax Description Defaults This command is disabled. If you do not specify a severity level, the default value of 2 is assumed. If you do not specify the maximum number of buffers to be queued, the default value of 20 is assumed. Command Modes Line configuration Command History Usage Guidelines When synchronous logging of unsolicited messages and debug output is turned on, unsolicited Cisco IOS software output is displayed on the console or printed after solicited Cisco IOS software output is displayed or printed. This keeps unsolicited messages and debug output from being interspersed with solicited software output and prompts. Tip This command is useful for keeping system messages from interrupting your typing. By default, messages will appear immediately when they are processed by the system, and the CLI cursor will appear at the end of the displayed message. For example, the line “Configured by console from console” level severity-level (Optional) Specifies the message severity level. Messages with a severity level equal to or higher than this value are printed asynchronously. Low numbers indicate greater severity and high numbers indicate lesser severity. The default value is 2. all (Optional) Specifies that all messages are printed asynchronously, regardless of the severity level. limit number-of-lines (Optional) Specifies the number of buffer lines to be queued for the terminal, after which new messages are dropped. The default value is 20. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. logging synchronous CF-302 Cisco IOS Configuration Fundamentals Command Reference April 2010 may be printed to the screen, interrupting whatever command you are currently typing. The logging synchronous command allows you to avoid these potentially annoying interruptions without have to turn off logging to the console entirely. When this command is enabled, unsolicited messages and debug output are displayed on a separate line than user input. After the unsolicited messages are displayed, the CLI returns to the user prompt. Note This command is also useful for allowing you to continue typing when debugging is enabled. When specifying a severity level number, consider that for the logging system, low numbers indicate greater severity and high numbers indicate lesser severity. When a message queue limit of a terminal line is reached, new messages are dropped from the line, although these messages might be displayed on other lines. If messages are dropped, the notice “%SYS-3-MSGLOST number-of-messages due to overflow” follows any messages that are displayed. This notice is displayed only on the terminal that lost the messages. It is not sent to any other lines, any logging servers, or the logging buffer. Caution By configuring abnormally large message queue limits and setting the terminal to “terminal monitor” on a terminal that is accessible to intruders, you expose yourself to “denial of service” attacks. An intruder could carry out the attack by putting the terminal in synchronous output mode, making a Telnet connection to a remote host, and leaving the connection idle. This could cause large numbers of messages to be generated and queued, and these messages could consume all available RAM. You should guard against this type of attack through proper configuration. Examples In the following example, a system message appears in the middle of typing the show running-config command: Router(config-line)# end Router# show ru 2w1d: %SYS-5-CONFIG_I: Configured from console by consolenning-config . . . The user then enables synchronous logging for the current line (indicated by the * symbol in the show line command), after which the system displays the system message on a separate line, and returns the user to the prompt to allow the user to finish typing the command on a single line: Router# show line Tty Typ Tx/Rx A Modem Roty AccO AccI Uses Noise Overruns Int * 0 CTY - - - - - 0 3 0/0 - . . . Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# line 0 Router(config-line)# logging syn Router(config-line)# logging synchronous Router(config-line)# end Router# show ru 2w1d: %SYS-5-CONFIG_I: Configured from console by console Router# show running-config logging synchronous CF-303 Cisco IOS Configuration Fundamentals Command Reference April 2010 In the following example, synchronous logging for line 4 is enabled with a severity level of 6. Then synchronous logging for line 2 is enabled with a severity level of 7 and is specified with a maximum number of buffer lines of 1,000. Router(config)# line 4 Router(config-line)# logging synchronous level 6 Router(config-line)# exit Router(config)# line 2 Router(config-line)# logging synchronous level 7 limit 1000 Router(config-line)# end Router# Related Commands Command Description line Identifies a specific line for configuration and starts the line configuration command collection mode. logging on Controls logging of error messages and sends debug or error messages to a logging process, which logs messages to designated locations asynchronously to the processes that generated the messages. logging system CF-304 Cisco IOS Configuration Fundamentals Command Reference April 2010 logging system To enable System Event Archive (SEA) logging, use the logging system command in global configuration mode. To disable SEA logging, use the no form of this command. logging system [disk name] no logging system Syntax Description Command Default By default, SEA logging feature is enabled, and the events are logged to a file on a persistent storage device (bootflash: or disk:). Command Modes Global configuration (config) Command History Usage Guidelines Cisco Universal Broadband Router 100112 The SEA feature is used to address the deficiencies of the debug trace and system console. Support for SEA feature was introduced on Cisco uBR10012 Router in the Cisco IOS Release 12.2(33)SCC. Use the logging system disk command to change the location of the disk used to store the sea_log.dat file. Note To store the system event logs, the SEA requires either PCMCIA ATA disk or Compact Flash disk in compact flash adapter for PRE2. Examples The following example shows how to specify that the SEA log file should be written to the disk “disk1:”: Router(config)# logging system disk disk1: Router(config)# end Related Commands disk name (Optional) Stores the system event archive (system event log file) in the specified disk. The specified disk must be already have been configured to allow for the storage of the system event archive. Release Modification 12.2(33)SXH This command was introduced. 12.2(33)SCC The command was introduced for the Cisco uBR10012 router in the Cisco IOS Software Release 12.2(33)SCC. clear logging system Clears the event records stored in the SEA. copy logging system Copies the archived system event log to another location. show logging system Displays the SEA logging system disk. logout CF-305 Cisco IOS Configuration Fundamentals Command Reference April 2010 logout To close an active terminal session by logging off the router, use the logout command in user EXEC mode. logout Syntax Description This command has no arguments or keywords. Defaults No default behavior or values. Command Modes User EXEC Command History Examples In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the logout command is used to log off (exit from the active session): Router(config)# exit Router# disable Router> logout Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. logout-warning CF-306 Cisco IOS Configuration Fundamentals Command Reference April 2010 logout-warning To warn users of an impending forced timeout, use the logout-warning command in line configuration mode. To restore the default, use the no form of this command. logout-warning [seconds] logout-warning Syntax Description Defaults No warning is sent to the user. Command Modes Line configuration Command History Usage Guidelines This command notifies the user of an impending forced timeout (set using the absolute-timeout command). Examples In the following example, a logout warning is configured on line 5 with a countdown value of 30 seconds: Router(config)# line 5 Router(config-line)# logout-warning 30 Related Commands seconds (Optional) Number of seconds that are counted down before session termination. If no number is specified, the default of 20 seconds is used. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description absolute-timeout Sets the interval for closing user connections on a specific line or port. session-timeout Sets the interval for closing the connection when there is no input or output traffic. macro (global configuration) CF-307 Cisco IOS Configuration Fundamentals Command Reference April 2010 macro (global configuration) To create a global command macro, use the macro command in global configuration mode. To remove the macro, use the no form of this command. macro {global {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword [keyword-to-value]} | name macro-name} no macro {global {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword [keyword-to-value]} | name macro-name} Syntax Description Defaults This command has no default setting. Command Modes Global configuration (config) Command History Usage Guidelines You can enter up to three keyword pairs using the macro global trace command. You can enter the macro global description command on the switch stack or on a standalone switch. Use the description text keyword and argument to associate comment text, or the macro name, with a switch. When multiple macros are applied on a switch, the description text will be from the last applied macro. You can verify the global description settings by entering the show parser macro description command. To find any syntax or configuration errors, enter the macro global trace macro-name command to apply and debug the macro. To display a list of any keyword-value pairs defined in the macro, enter the macro global apply macro-name ? command. You can delete a global macro-applied configuration on a switch only by entering the no version of each command that is in the macro. global Applies the macro globally. apply macro-name Applies a specified macro. description text Specifies a description about the macros that are applied to the switch. trace macro-name Applies a specified macro with trace enabled. keyword-to-value (Optional) Keyword to replace with a value. value-first-keyword Value of the keyword to replace. name macro-name Specifies the name of a macro. Release Modification 12.2(33)SXH This command was introduced. macro (global configuration) CF-308 Cisco IOS Configuration Fundamentals Command Reference April 2010 Keyword matching is case sensitive. In the commands that the macro applies, all matching occurrences of keywords are replaced with the corresponding values. The no form of the macro name global configuration command only deletes the macro definition. It does not affect the configuration of those interfaces on which the macro is already applied. Examples This example shows how to apply the user-created macro called snmp, to set the host name address to test-server and to set the IP precedence value to 7: Router(config)# macro global apply snmp ADDRESS test-server VALUE 7 This example shows how to debug the user-created macro called snmp by using the macro global trace global configuration command to find any syntax or configuration errors in the macro when it is applied to the switch. Router(config)# macro global trace snmp VALUE 7 Applying command...`snmp-server enable traps port-security' Applying command...`snmp-server enable traps linkup' Applying command...`snmp-server enable traps linkdown' Applying command...`snmp-server host' %Error Unknown error. Applying command...`snmp-server ip precedence 7' Router(config)# Related Commands Command Description macro (interface configuration) Creates an interface-specific command macro. show parser macro Displays the smart port macros. macro (interface configuration) CF-309 Cisco IOS Configuration Fundamentals Command Reference April 2010 macro (interface configuration) To create an interface-specific command macro, use the macro command in interface configuration mode. To remove the macro, use the no form of this command. macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword [keyword-to-value]} no macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword [keyword-to-value]} Syntax Description Defaults This command has no default setting. Command Modes Interface configuration (config-if) Command History Usage Guidelines You can enter up to three keyword changes using the macro trace command. You can enter the macro description command on the switch stack or on a standalone switch. Use the description text keyword and argument to associate comment text, or the macro name, with a switch. When multiple macros are applied on a switch, the description text will be from the last applied macro. You can verify the description settings by entering the show parser macro description command. To find any syntax or configuration errors, enter the macro trace macro-name command to apply and debug the macro. To display a list of any keyword-value pairs defined in the macro, enter the macro apply macro-name ? command. To successfully apply the macro, you must enter any required keyword-value pairs. Keyword matching is case sensitive. In the commands that the macro applies, all matching occurrences of keywords are replaced with the corresponding values. apply macro-name Applies a specified macro. description text Specifies a description about the macros that are applied to the interface. trace macro-name Applies a specified macro with trace enabled. keyword-to-value (Optional) Keyword to replace with a value. value-first-keyword Value of the keyword to replace. Release Modification 12.2(33)SXH This command was introduced. macro (interface configuration) CF-310 Cisco IOS Configuration Fundamentals Command Reference April 2010 You can delete all configuration on an interface by entering the default interface interface interface configuration command. Examples The following example shows how to apply the user-created macro called desktop-config and to verify the configuration: Router(config)# interface fastethernet1/2 Router(config-if)# macro apply desktop-config The following example shows how to apply the user-created macro called desktop-config and to replace all occurrences of vlan with VLAN ID 25: Router(config-if)# macro apply desktop-config vlan 25 Related Commands Command Description macro (global configuration) Creates a command macro. show parser macro Displays the smart port macros. maximum CF-311 Cisco IOS Configuration Fundamentals Command Reference April 2010 maximum To set the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive, use the maximum command in archive configuration mode. To reset this command to its default, use the no form of this command. maximum number no maximum number Syntax Description Command Default By default, a maximum of 10 archive files of the running configuration are saved in the Cisco IOS configuration archive. Command Modes Archive configuration Command History Usage Guidelines Note Before using this command, you must configure the path command to specify the location and filename prefix for the files in the Cisco IOS configuration archive. After the maximum number of files are saved in the Cisco IOS configuration archive, the oldest file is automatically deleted when the next, most recent file is saved. Note This command should only be used when a local writable file system is specified in the url argument of the path command. Network file systems may not support deletion of previously saved files. number Maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. You can archive from 1 to 14 configuration files. The default is 10. Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. maximum CF-312 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, a value of 5 is set as the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive: configure terminal ! archive path disk0:myconfig maximum 5 end Related Commands Command Description archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure confirm Confirms replacement of the current running configuration with a saved Cisco IOS configuration file. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. path Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. memory free low-watermark CF-313 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory free low-watermark To configure a router to issue system logging message notifications when available memory falls below a specified threshold, use the memory free low-watermark command in global configuration mode. To disable memory threshold notifications, use the no form of this command. memory free low-watermark {processor threshold | io threshold} no memory free low-watermark Syntax Description Defaults Memory threshold notifications are disabled. Command Modes Global configuration Command History Usage Guidelines Using this command, you can configure a router to issue a system logging message each time available free memory falls below a specified threshold (“low-watermark”). Once available free memory rises to 5 percent above the threshold, another notification message is generated. Examples The following example specifies a free processor memory notification threshold of 20000 KB: Router(config)# memory free low-watermark processor 200000 If available free processor memory falls below this threshold, the router sends a notification message like this one: 000029: Aug 12 22:31:19.559: %SYS-4-FREEMEMLOW: Free Memory has dropped below 20000k Pool: Processor Free: 66814056 freemem_lwm: 204800000 Once available free processor memory rises to a point 5 percent above the threshold, another notification message like this is sent: processor threshold Sets the processor memory threshold in kilobytes. When available processor memory falls below this threshold, a notification message is triggered. Valid values are 1 to 4294967295. io threshold Sets the input/output (I/O) memory threshold in kilobytes. When available I/O memory falls below this threshold, a notification message is triggered. Valid values are 1 to 4294967295. Release Modification 12.2(18)S This command was introduced. 12.0(26)S This command was integrated into Cisco IOS Release 12.0(26)S. 12.3(4)T This command was integrated into Cisco IOS Release 12.3(4)T. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. memory free low-watermark CF-314 Cisco IOS Configuration Fundamentals Command Reference April 2010 000032: Aug 12 22:33:29.411: %SYS-5-FREEMEMRECOVER: Free Memory has recovered 20000k Pool: Processor Free: 66813960 freemem_lwm: 0 Related Commands Command Description memory reserve critical Reserves memory for use by critical processes. memory lite CF-315 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory lite To enable the memory allocation lite (malloc_lite) feature, use the memory lite command in global configuration mode. To disable this feature, use the no form of this command. memory lite no memory lite Syntax Description This command has no arguments or keywords. Defaults This command is enabled by default. Command Modes Global configuration Command History Usage Guidelines The malloc_lite feature was implemented to avoid excessive memory allocation overhead for situations where less than 128 bytes were required. This feature is supported for processor memory pools only. The malloc_lite feature is enabled by default. If the malloc_lite feature is disabled using the no memory lite command, you can re-enable the feature by entering the memory lite command. Examples The following example shows how to disable the malloc_lite feature: no memory lite Related Commands Release Modification 12.3(11)T This command was introduced. Command Description scheduler heapcheck process Performs a “sanity check” for corruption in memory blocks when a process switch occurs. memory reserve critical CF-316 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory reserve critical Note Effective with Cisco IOS Release 12.4(15)T1, the memory reserve critical command is replaced by the memory reserve command. See the memory reserve command for more information. To configure the size of the memory region to be used for critical notifications (system logging messages), use the memory reserve critical command in global configuration mode. To disable the reservation of memory for critical notifications, use the no form of this command. memory reserve critical kilobytes no memory reserve critical Syntax Description Defaults 100 kilobytes of memory is reserved for the logging process. Command Modes Global configuration (config) Command History Usage Guidelines This command reserves a region of memory on the router so that, when system resources are overloaded, the router retains enough memory to issue critical system logging messages. Note Once the size of the reserved memory region is specified, any change to the specified value takes effect only after the current configuration is saved and the system has been reloaded. Examples The following example shows how to reserve 1,000 KB of system memory for logging messages at the next system restart: Router(config)# memory reserve critical 1000 kilobytes Specifies the amount of memory to be reserved in kilobytes. Valid values are 1 to 4294967295, but the value you specify cannot exceed 25 percent of total memory. The default is 100 kilobytes. Release Modification 12.2(18)S This command was introduced. 12.0(26)S This command was integrated into Cisco IOS Release 12.0(26)S. 12.3(4)T This command was integrated into Cisco IOS Release 12.3(4)T. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.4(15)T1 This command was replaced by the memory reserve command. memory reserve critical CF-317 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description memory free low-watermark Configures a router to issue syslog notifications when available memory falls below a specified threshold. memory sanity CF-318 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory sanity To perform a “sanity check” for corruption in buffers and queues, use the memory sanity command in global configuration mode. To disable this feature, use the no form of this command. memory sanity [buffer | queue | all] no memory sanity Syntax Description Defaults This command is not enabled by default. If the buffer or queue keyword is not specified, a sanity check will be performed on all buffers and queues. Command Modes Global configuration Command History Usage Guidelines When the memory sanity buffer command is enabled, a sanity check is performed on buffers when a packet buffer is allocated or when a packet buffer is returned to the buffer pool. This command also time-stamps the buffer, which may be useful when tracking the age of a buffer. The memory sanity command can be saved in the startup configuration file and, therefore, it is not necessary to reconfigure this command each time the router is reloaded. Like the scheduler heapcheck process memory command, the memory sanity command can check for corruption in the I/O memory block. Enabling the memory sanity command may result in slight router performance degradation. Examples The following example shows how to perform a sanity check for corruption in all buffers and queues: memory sanity all Related Commands buffer (Optional) Specifies checking all buffers. queue (Optional) Specifies checking all queues. all (Optional) Specifies checking all buffers and queues. Release Modification 12.2(15)T This command was introduced. Command Description scheduler heapcheck process memory Performs a “sanity check” for corruption in memory blocks when a process switch occurs. memory scan CF-319 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory scan To enable the Memory Scan feature, use the memory scan command in global configuration mode. To restore the router configuration to the default, use the no form of this command. memory scan no memory scan Syntax Description This command has no arguments or keywords. Defaults This command is disabled by default. Command Modes Global configuration Command History Usage Guidelines The Memory Scan feature adds a low-priority background process that searches all installed dynamic random-access memory (DRAM) for possible parity errors. If errors are found in memory areas that are not in use, this feature attempts to scrub (remove) the errors. The time to complete one memory scan and scrub cycle can range from 10 minutes to several hours, depending on the amount of installed memory. The impact of the Memory Scan feature on the central processing unit (CPU) is minimal. To view the status of the memory scan feature on your router, use the show memory scan command in EXEC mode. Examples The following example enables the Memory Scan feature on a Cisco 7500 series router: Router(config)# memory scan Related Commands Release Modification 12.0(4)XE This command was introduced. 12.0(7)T This command was integrated in Cisco IOS Release 12.0 T for the Cisco 7500 series only. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show memory scan Displays the number and type of parity errors on your system. memory-size iomem CF-320 Cisco IOS Configuration Fundamentals Command Reference April 2010 memory-size iomem To reallocate the percentage of DRAM to use for I/O memory and processor memory on Cisco 3600 series routers, use the memory-size iomem command in global configuration mode. To revert to the default memory allocation, use the no form of this command. memory-size iomem i/o-memory-percentage no memory-size iomem i/o-memory-percentage Syntax Description Defaults The default memory allocation is 25 percent I/O memory and 75 percent processor memory. Note If the smartinit process has been enabled, the default memory allocation of 25 percent to I/O does not apply. Instead, smartinit examines the network modules and then calculates the I/O memory required. Command Modes Global configuration Command History Usage Guidelines When you specify the percentage of I/O memory in the command line, processor memory automatically acquires the remaining percentage of DRAM memory. Examples The following example allocates 40 percent of the DRAM memory to I/O memory and the remaining 60 percent to processor memory: Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# memory-size iomem 40 Router(config)# exit Router# copy system:running-config nvram:startup-config Building configuration... [OK] Router# reload rommon 1 > boot program load complete, entry point: 0x80008000, size: 0x32ea24 i/o-memory-percentage The percentage of DRAM allocated to I/O memory. The values permitted are 10, 15, 20, 25, 30, 40, and 50. A minimum of 4 MB of memory is required for I/O memory. Release Modification 11.2 P This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. memory-size iomem CF-321 Cisco IOS Configuration Fundamentals Command Reference April 2010 Self decompressing the image : ########################################################################################## ########################################################################################## ################################################################## [OK] menu (EXEC) CF-322 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu (EXEC) To display a preconfigured user menu, use the menu command in user EXEC or privileged EXEC mode. menu menu-name Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines A user menu is a type of user interface where text descriptions of actions to be performed are displayed to the user. The user can use the menu to select services and functions without having to know the details of command-line interface (CLI) commands. Menus can be created for users in global configuration mode, using the commands listed in the “Related Commands” section. A menu can be invoked at either the user or privileged EXEC level, but if an item in the menu contains a privileged EXEC command, the user must be logged in at the privileged level for the command to succeed. Examples The following example invokes a menu named OnRamp: Router> menu OnRamp Welcome to OnRamp Internet Services Type a number to select an option; Type 9 to exit the menu. 1 Read email 2 UNIX Internet access 3 Resume UNIX connection 6 Resume next connection 9 Exit menu system menu-name The name of the menu. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. menu (EXEC) CF-323 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user interface menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an option number. menu options Sets options for items in user interface menus. menu prompt Specifies the prompt for a user interface menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu. menu text Specifies the text of a menu item in a user interface menu. menu title Creates a title, or banner, for a user menu. no menu Deletes a specified menu from a menu configuration. menu single-space CF-324 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu single-space To display menu items single-spaced rather than double-spaced, use the menu single-space command in global configuration mode. menu menu-name single-space Syntax Description Defaults Enabled for menus with more than nine items; disabled for menus with nine or fewer items. Command Modes Global configuration Command History Usage Guidelines When more than nine menu items are defined, the menu is displayed single-spaced. To configure the menus with nine or fewer items to display single-spaced, use this command. Examples In the following example, single-spaced menu items are displayed for the menu named Access1: menu Access1 single-space Related Commands menu-name Name of the menu this command should be applied to. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu status-line Displays a line of status information about the current user at the top of a menu. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu clear-screen CF-325 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu clear-screen To clear the terminal screen before displaying a menu, use the menu clear-screen command in global configuration mode. menu menu-name clear-screen Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines This command uses a terminal-independent mechanism based on termcap entries defined in the router and the configured terminal type for the user. This command allows the same menu to be used on multiple types of terminals instead of having terminal-specific strings embedded within menu titles. If the termcap entry does not contain a clear string, the menu system enters 24 new lines, causing all existing text to scroll off the top of the terminal screen. Examples In the following example, the terminal screen is cleared before displaying the menu named Access1: Router(config)# menu Access1 clear-screen Related Commands menu-name Name of the menu this command should be applied to. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu menu text Specifies the text of a menu item in a user menu. menu clear-screen CF-326 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu title Creates a title, or banner, for a user menu. no menu Deletes a specified menu from a menu configuration. Command Description menu command CF-327 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu command To specify underlying commands for user menus, use the menu command command in global configuration mode. menu menu-name command menu-item {command | menu-exit} Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines Use this command to assign actions to items in a menu. Use the menu text global configuration command to assign text to items. These commands must use the same menu name and menu selection key. The menu command command has a special keyword for the command argument, menu-exit, that is available only within menus. It is used to exit a submenu and return to the previous menu level, or to exit the menu altogether and return to the EXEC command prompt. You can create submenus that are opened by selecting entries in another menu. Use the menu EXEC command as the command for the submenu item. Note If you nest too many levels of menus, the system prints an error message on the terminal and returns to the previous menu level. When a menu allows connections (their normal use), the command for an entry activating the connection should contain a resume command, or the line should be configured to prevent users from escaping their sessions with the escape-char none command. Otherwise, when they escape from a connection and return to the menu, there will be no way to resume the session and it will sit idle until the user logs out. menu-name Name of the menu. You can specify a maximum of 20 characters. menu-item Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu entries. When the tenth item is added to the menu, the line-mode and single-space options are activated automatically. command Command to issue when the user selects an item. menu-exit Provides a way for menu users to return to a higher-level menu or exit the menu system. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. menu command CF-328 Cisco IOS Configuration Fundamentals Command Reference April 2010 Specifying the resume command as the action that is performed for a selected menu entry permits a user to resume a named connection or connect using the specified name, if there is no active connection by that name. As an option, you can also supply the connect string needed to connect initially. When you do not supply this connect string, the command uses the specified connection name. You can also use the resume/next command, which resumes the next connection in the user’s list of connections. This function allows you to create a single menu entry that steps through all of the user’s connections. Note A menu should not contain any exit paths that leave users in an unfamiliar interface environment. When a particular line should always display a menu, that line can be configured with an autocommand line configuration command. Menus can be run on a per-user basis by defining a similar autocommand command for that local username. For more information about the autocommand command, refer to the Cisco IOS Dial Technologies Configuration Guide. Examples In the following example, the commands to be issued when the menu user selects option 1, 2, or 3 are specified for the menu named Access1: menu Access1 command 1 tn3270 vms.cisco.com menu Access1 command 2 rlogin unix.cisco.com menu Access1 command 3 menu-exit The following example allows a menu user to exit a menu by entering Exit at the menu prompt: menu Access1 text Exit Exit menu Access1 command Exit menu-exit Related Commands Command Description autocommand Configures the Cisco IOS software to automatically execute a command when a user connects to a particular line. menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu default CF-329 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu default To specify the menu item to use as the default, use the menu default command in global configuration mode. menu menu-name default menu-item Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines Use this command to specify which menu entry is used when the user presses Enter without specifying an item. The menu entries are defined by the menu command and menu text global configuration commands. Examples In the following example, the menu user exits the menu when pressing Enter without selecting an item: menu Access1 9 text Exit the menu menu Access1 9 command menu-exit menu Access1 default 9 Related Commands menu-name Name of the menu. You can specify a maximum of 20 characters. menu-item Number, character, or string key of the item to use as the default. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a preconfigured user menu. menu command Specifies underlying commands for user menus. menu prompt Specifies the prompt for a user menu. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu line-mode CF-330 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu line-mode To require the user to press Enter after specifying an item, use the menu line-mode command in global configuration mode. menu menu-name line-mode Syntax Description Defaults Enabled for menus with more than nine items. Disabled for menus with nine or fewer items. Command Modes Global configuration Command History Usage Guidelines In a menu of nine or fewer items, you ordinarily select a menu item by entering the item number. In line mode, you select a menu entry by entering the item number and pressing Enter. Line mode allows you to backspace over the selected number and enter another number before pressing Enter to issue the command. This option is activated automatically when more than nine menu items are defined but also can be configured explicitly for menus of nine or fewer items. In order to use strings as keys for items, the menu line-mode command must be configured. Examples In the following example, the line-mode option is enabled for the menu named Access1: menu Access1 line-mode Related Commands menu-name Name of the menu this command should be applied to. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a preconfigured user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for a user menu. menu default Specifies the menu item to use as the default. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu line-mode CF-331 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu status-line Displays a line of status information about the current user at the top of a menu. menu text Specifies the text of a menu item in a user menu. Command Description menu options CF-332 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu options To set options for items in user menus, use the menu options command in global configuration mode. menu menu-name options menu-item {login | pause} Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines Use the menu command and menu text global configuration commands to define a menu entry. Examples In the following example, a login is required before issuing the command specified by menu entry 3 of the menu named Access1: menu Access1 options 3 login Related Commands menu-name The name of the menu. You can specify a maximum of 20 characters. menu-item Number, character, or string key of the item affected by the option. login Requires a login before issuing the command. pause Pauses after the command is entered before redrawing the menu. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu prompt CF-333 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu prompt To specify the prompt for a user menu, use the menu prompt command in global configuration mode. menu menu-name prompt d prompt d Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines Press Enter after entering the first delimiter. The router will prompt you for the text of the prompt. Enter the text followed by the delimiter, and press Enter. Use the menu command and menu text commands to define the menu selections. Examples In the following example, the prompt for the menu named Access1 is configured as “Select an item.”: Router(config)# menu Access1 prompt / Enter TEXT message. End with the character '/'. Select an item. / Router(config)# Related Commands menu-name Name of the menu. You can specify a maximum of 20 characters. d A delimiting character that marks the beginning and end of a title. Text delimiters are characters that do not ordinarily appear within the text of a title, such as slash ( / ), double quote ("), and tilde (~). ^C is reserved for special use and should not be used in the text of the title. prompt Prompt string for the menu. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu status-line CF-334 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu status-line To display a line of status information about the current user at the top of a menu, use the menu status-line command in global configuration mode. menu menu-name status-line Syntax Description Defaults Disabled Command Modes Global configuration Command History Usage Guidelines This command displays the status information at the top of the screen before the menu title is displayed. This status line includes the router’s host name, the user’s line number, and the current terminal type and keymap type (if any). Examples In the following example, status information is enabled for the menu named Access1: menu Access1 status-line Related Commands menu-name Name of the menu this command should be applied to. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item in a menu. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. menu text CF-335 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu text To specify the text of a menu item in a user menu, use the menu text command in global configuration mode. menu menu-name text menu-item menu-text Syntax Description Defaults No text appears for the menu item. Command Modes Global configuration Command History Usage Guidelines Use this command to assign text to items in a menu. Use the menu command command to assign actions to items. These commands must use the same menu name and menu selection key. You can specify a maximum of 18 items in a menu. Examples In the following example, the descriptive text for the three entries is specified for options 1, 2, and 3 in the menu named Access1: menu Access1 text 1 IBM Information Systems menu Access1 text 2 UNIX Internet Access menu Access1 text 3 Exit menu system Related Commands menu-name Name of the menu. You can specify a maximum of 20 characters. menu-item Number, character, or string used as the key for the item. The key is displayed to the left of the menu item text. You can specify a maximum of 18 menu items. When the tenth item is added to the menu, the menu line-mode and menu single-space commands are activated automatically. menu-text Text of the menu item. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu text CF-336 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu. menu title Creates a title, or banner, for a user menu. Command Description menu title CF-337 Cisco IOS Configuration Fundamentals Command Reference April 2010 menu title To create a title (banner) for a user menu, use the menu title command in global configuration mode. menu menu-name title d menu-title d Syntax Description Defaults The menu does not have a title. Command Modes Global configuration Command History Usage Guidelines The menu title command must use the same menu name used with the menu text and menu command commands used to create a menu. You can position the title of the menu horizontally by preceding the title text with blank characters. You can also add lines of space above and below the title by pressing Enter. Follow the title keyword with one or more blank characters and a delimiting character of your choice. Then enter one or more lines of text, ending the title with the same delimiting character. You cannot use the delimiting character within the text of the message. When you are configuring from a terminal and are attempting to include special control characters, such as a screen-clearing string, you must use Ctrl-V before the special control characters so that they are accepted as part of the title string. The string ^[[H^[[J is an escape string used by many VT100-compatible terminals to clear the screen. To use a special string, you must enter Ctrl-V before each escape character. You also can use the menu clear-screen global configuration command to clear the screen before displaying menus and submenus, instead of embedding a terminal-specific string in the menu title. The menu clear-screen command allows the same menu to be used on different types of terminals. menu-name Name of the menu. You can specify a maximum of 20 characters. d A delimiting character that marks the beginning and end of a title. Text delimiters are characters that do not ordinarily appear within the text of a title, such as slash ( / ), double quote ("), and tilde (~). ^C is reserved for special use and should not be used in the text of the title. menu-title Lines of text to appear at the top of the menu. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. menu title CF-338 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the title that will be displayed is specified when the menu named Access1 is invoked. Press Enter after the second slash (/) to display the prompt. Router(config)# menu Access1 title /^[[H^[[J Enter TEXT message. End with the character '/'. Welcome to Access1 Internet Services Type a number to select an option; Type 9 to exit the menu. / Router(config)# Related Commands Command Description menu (EXEC) Invokes a user menu. menu clear-screen Clears the terminal screen before displaying a menu. menu command Specifies underlying commands for user menus. menu default Specifies the menu item to use as the default. menu line-mode Requires the user to press Enter after specifying an item. menu options Sets options for items in user menus. menu prompt Specifies the prompt for a user menu. menu single-space Displays menu items single-spaced rather than double-spaced. menu status-line Displays a line of status information about the current user at the top of a menu. menu text Specifies the text of a menu item in a user menu. microcode (12000) CF-339 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode (12000) To load a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000 series Gigabit Switch Router (GSR), use the microcode command in global configuration mode. To load the microcode bundled with the GRP system image, use the no form of this command. microcode {oc12-atm | oc12-pos | oc3-pos4} {flash file-id [slot] | system [slot]} no microcode {oc12-atm | oc12-pos | oc3-pos4} [flash file-id [slot] | system [slot]] Syntax Description Defaults The default is to load the image from the GRP card (system). Command Modes Global configuration Command History Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on a Cisco 12000 series has a Cisco IOS image. When the router is reloaded, the specified image is loaded onto the GRP card and then automatically downloaded to all the line cards. Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a Cisco IOS image that is different from the one on the line card. Additionally, you might need to load a new image on the line card to work around a problem that is affecting only one of the line cards. oc12-atm | oc12-pos | oc3-pos4 Interface name. flash Loads the image from the Flash file system. file-id Specifies the device and filename of the image file to download from Flash memory. A colon (:) must separate the device and filename (for example, slot0:gsr-p-mz). Valid devices include: • bootflash:—Internal Flash memory. • slot0:—First PCMCIA slot. • slot1:—Second PCMCIA slot. slot (Optional) Slot number of the line card that you want to copy the software image to. Slot numbers range from 0 to 11 for the Cisco 12012 router and 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is downloaded on all line cards. system Loads the image from the software image on the GRP card. Release Modification 11.2 GS This command was introduced for Cisco 12000 series GSRs. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. microcode (12000) CF-340 Cisco IOS Configuration Fundamentals Command Reference April 2010 To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to download the image to the line card, followed by the microcode reload command to start the image. Immediately after you enter the microcode reload command and press Return, the system reloads all microcode. Global configuration mode remains enabled. After the reloading is complete, enter the exit command to return to the EXEC system prompt. To verify that the correct image is running on the line card, use the execute-on slot slot show version command. For additional information on GSR configuration, refer to the documentation specific to your Cisco IOS software release. Examples In the following example, the Cisco IOS software image in slot 0 is downloaded to the line card in slot 10. This software image is used when the system is booted, a line card is inserted or removed, or the microcode reload global configuration command is issued. Router(config)# microcode oc3-POS-4 flash slot0:fip.v141-7 10 Router(config)# microcode reload 10 In this example, the user would issue the execute-on slot 10 show version command to verify that the correct version is loaded. Related Commands Command Description microcode reload (12000) Reloads microcode on Cisco 12000 series GSRs. microcode (7000/7500) CF-341 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode (7000/7500) To specify the location of the microcode that you want to download from Flash memory into the writable control store (WCS) on Cisco 7000 series (including RSP based routers) or Cisco 7500 series routers, use the microcode command in global configuration mode. To load the microcode bundled with the system image, use the no form of this command. microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]]} no microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]} Syntax Description Defaults The default is to load from the microcode bundled in the system image. Command Modes Global configuration Command History Usage Guidelines If you do not use the microcode reload command after using the microcode command, the microcode reload command will be written to the configuration file automatically. When using Dual RSPs for simple hardware backup, ensure that the master and slave RSP card contain the same microcode image in the same location when the router is to load the interface processor microcode from a Flash file system. Thus, if the slave RSP becomes the master, it will be able to find the microcode image and download it to the interface processor. interface-type One of the following interface processor names: aip, cip, eip, feip, fip, fsip, hip, mip, sip, sp, ssp, trip, vip, or vip2. flash-filesystem: Flash file system, followed by a colon. Valid file systems are bootflash, slot0, and slot1. Slave devices such as slaveslot0 are invalid. The slave’s file system is not available during microcode reloads. filename Name of the microcode file. slot (Optional) Number of the slot. Range is from 0 to 15. rom If ROM is specified, the router loads from the onboard ROM microcode. system If the system keyword is specified, the router loads the microcode from the microcode bundled into the system image you are running for that interface type. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. microcode (7000/7500) CF-342 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, all FIP cards will be loaded with the microcode found in Flash memory file fip.v141-7 when the system is booted, when a card is inserted or removed, or when the microcode reload global configuration command is issued. The configuration is then written to the startup configuration file. Router(config)# microcode fip slot0:fip.v141-7 Router(config)# end Router# copy system:running-config nvram:startup-config Related Commands Command Description more flh:logfile Displays the system console output generated during the Flash load helper operation. microcode (7200) CF-343 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode (7200) To configure a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router, use the microcode command in global configuration mode. To revert to the default microcode for the current running version of the Cisco IOS software, use the no form of this command. microcode {ecpa | pcpa} location no microcode {ecpa | pcpa} Syntax Description Defaults If the default or no form of the command is specified, the driver uses the default microcode for the current running version of the Cisco IOS software. Command Modes Global configuration Command History Usage Guidelines If there are any default overrides when the configuration is written, then the microcode reload command will be written to the configuration automatically. This action enables the configured microcode to be downloaded at system startup. The CPA microcode image is preloaded on Flash memory cards for Cisco 7200-series routers for Cisco IOS Release 11.3(3)T and later releases. You may be required to copy a new image to Flash memory when a new microcode image becomes available. For more information on the CPA configuration and maintenance, refer to the “Configuring Cisco Mainframe Channel Connection Adapters” chapter in the Release 12.2 Cisco IOS Bridging and IBM Networking Configuration Guide. Examples The following example instructs the Cisco IOS software to load the microcode from an individual microcode image that is stored as a file on the Flash card inserted in Flash card slot 0: microcode ecpa slot0:xcpa26-1 ecpa ESCON Channel Port Adapter (CPA) interface. pcpa Parallel CPA interface. location Location of microcode, including the device and filename. Release Modification 11.3(3)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. microcode (7200) CF-344 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description microcode reload (7200) Resets and reloads the specified hardware in a Cisco 7200 series router. show microcode Displays microcode information. microcode reload (12000) CF-345 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode reload (12000) To reload the Cisco IOS image from a line card on Cisco 12000 series routers, use the microcode reload command in global configuration mode. microcode reload [slot-number] Syntax Description Command Modes Global configuration Command History Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on Cisco 12000 series routers has a Cisco IOS image. When the router is reloaded, the specified Cisco IOS image is loaded onto the GRP card and automatically downloaded to all the line cards. Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a different Cisco IOS image. Additionally, you might need to load a new image on the line card to work around a problem affecting only one of the line cards. To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to download the image to the line card, followed by the microcode reload command to start the image. To verify that the correct image is running on the line card, use the execute-on slot slot show version command. For additional information on GSR configuration, refer to the “Observing System Startup and Performing a Basic Configuration” chapter in the Cisco 12000 series installation and configuration guides. The microcode reload (12000) command allows you to issue another command immediately. Note Issuing a microcode reload command on any of the line cards in a Cisco 12000 GSR immediately returns the console command prompt. This allows you to issue a subsequent command immediately to the reloading line card. However, any commands entered at this time will not execute, and often no indication will be given that such a command failed to run. Verify that the microcode has reloaded before issuing new commands. slot-number (Optional) Slot number of the line card that you want to reload the Cisco IOS software image on. Slot numbers range from 0 to 11 for the Cisco 12012 and from 0 to 7 for the Cisco 12008 router. If you do not specify a slot number, the Cisco IOS software image is reloaded on all line cards. Release Modification 11.2 GS This command was introduced for Cisco 12000 series GSRs. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. microcode reload (12000) CF-346 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the mirocode firmware is reloaded on the line card in slot 10: Router(config)# microcode reload 10 Related Commands Command Description microcode (12000) Loads a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000 series GSR. microcode reload (7000/7500) CF-347 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode reload (7000/7500) To reload the processor card on the Cisco 7000 series with RSP7000 or Cisco 7500 series routers, use the microcode reload command in global configuration mode. microcode reload [slot-number] Syntax Description Defaults No default behaviors or values. Command Modes Global configuration Command History Usage Guidelines This command reloads the microcode without rebooting the router. Immediately after you enter the microcode reload command, the system reloads all microcode. Global configuration mode remains enabled. Note If you modify the system configuration to load a microcode image, the microcode reload command will be written to the configuration file automatically following the use of a microcode command. This action enables the configured microcode to be downloaded at system startup. Examples In the following example, all controllers are reset, and the microcode specified in the current configuration is loaded: Router(config)# microcode reload Related Commands slot-number (Optional) Reloads the specified processor card slot on a Cisco 7500 series router. Release Modification 10.3 This command was introduced for Cisco 7500 series routers. 12.3(8)T The slot-number argument was added for Cisco 7500 series routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description microcode (7000/7500) Specifies the location from where microcode should be loaded when the microcode reload command is processed on RSP-based routers. microcode reload (7200) CF-348 Cisco IOS Configuration Fundamentals Command Reference April 2010 microcode reload (7200) To reload the Cisco IOS microcode image on an ESCON CPA card in the Cisco 7200 series router, use the microcode reload command in privileged EXEC mode. microcode reload {all | ecpa [slot slot-number] | pcpa [slot slot-number]} Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines Hardware types that do not support downloadable microcode are unaffected by the microcode reload all command. You will be prompted for confirmation before the microcode reload command is executed. Examples The following example reloads the ESCON CPA microcode in slot 5 with the currently configured microcode: Router# microcode reload ecpa slot 5 Related Commands all Resets and reloads all hardware types that support downloadable microcode. ecpa Resets and reloads only those slots that contain hardware type ecpa. pcpa Resets and reloads only those slots that contain hardware type pcpa. slot slot-number (Optional) Resets and reloads only the slot specified, and only if it contains the hardware specified. Release Modification 11.3(3)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description microcode (7200) Configures a default override for the microcode that is downloaded to the hardware on a Cisco 7200 series router. show microcode Displays the microcode bundled into a Cisco 7000 series with RSP7000, Cisco 7200 series, or Cisco 7500 series router. mkdir CF-349 Cisco IOS Configuration Fundamentals Command Reference April 2010 mkdir To create a new directory in a Class C Flash file system, use the mkdir command in EXEC, privileged EXEC, or diagnostic mode. mkdir directory Syntax Description Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command is only valid on Class C Flash file systems. If you do not specify the directory name in the command line, the router prompts you for it. Examples The following example creates a directory named newdir: Router# mkdir newdir Mkdir file name [newdir]? Created dir flash:newdir Router# dir Directory of flash: 2 drwx 0 Mar 13 1993 13:16:21 newdir 8128000 bytes total (8126976 bytes free) directory The name of the directory to create. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Routers and the following enhancements were introduced: • This command was introduced in diagnostic mode for the first time. The command can be entered in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 Series Routers. • The harddisk:, obfl:, stby-harddisk:, stby-nvram:, stby-obfl:, stby-usb[0-1]:,and usb[0-1]: directory options were introduced. mkdir CF-350 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description dir Displays a list of files on a file system. rmdir Removes an existing directory in a Class C Flash file system. mkdir disk0: CF-351 Cisco IOS Configuration Fundamentals Command Reference April 2010 mkdir disk0: To create a new directory in a Flash file system, use the mkdir disk0: command. mkdir disk0: Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes EXEC Command History Usage Guidelines This command is valid only on Flash file systems. After you enter the mkdir disk0: command, you are prompted to enter the new directory filename. To check your entry, enter the dir command. To remove a directory, enter the rmdir command. Examples This example shows how to create a directory named newdir: Router# mkdir disk0: Create directory filename [ ]? newdir Created dir disk0: newdir Router# Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to the 12.2 SX release. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description cd Changes the default directory or file system. dir Displays a list of files on a file system. rmdir Removes an existing directory in a Class C Flash file system. mode CF-352 Cisco IOS Configuration Fundamentals Command Reference April 2010 mode To set the redundancy mode, use the mode command in redundancy configuration mode. Syntax for 12.2S Release mode {rpr | rpr-plus | sso} Syntax for Cisco IOS XE Release 2.5 and Later Releases mode {rpr | sso} Syntax for 12.2XNE Release mode sso Syntax Description Command Default Cisco 7600 series routers That Are Configured with a Supervisor Engine 720 • The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image. • The default is RPR mode if different versions are installed. • If redundancy is enabled, the default is the mode that you have configured. Cisco 7600 series routers That Are Configured with a Supervisor Engine 2 • The default is RPR+ mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image. • The default is RPR mode if different versions are installed. • If redundancy is enabled, the default is the mode that you have configured. Cisco ASR 1000 Series Aggregation Services Routers That Are Configured with a Supervisor Engine • The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image. • The default is RPR mode if different versions are installed. Cisco 10000 Router That Is Configured with a Supervisor Engine • The default is SSO mode if the system is not configured for redundancy and the active and standby supervisor engines have the same image. • The default is RPR mode if different versions are installed. Command Modes Redundancy configuration (config-red) rpr Specifies Route Processor Redundancy (RPR) mode. rpr-plus Specifies Route Processor Redundancy Plus (RPR+) mode. sso Specifies stateful switchover (SSO) mode. mode CF-353 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines Cisco IOS Release 12.2S and 7600 Series Routers SSO is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2. On releases prior to Release 12.2(17d)SXB, single router mode (SRM) with SSO redundancy does not support stateful switchover for multicast traffic. When a switchover occurs, all multicast hardware switching entries are removed and are then re-created and reinstalled in the hardware by the newly active multilayer switch feature card (MSFC). SRM/SSO is supported in the following releases only: • Release 12.2(17b)SXA and subsequent rebuilds. • Release 12.2(17d)SXB and subsequent rebuilds. Nonstop forwarding (NSF) with SSO redundancy mode supports IPv4. NSF with SSO redundancy mode does not support IPv6, Internetwork Packet Exchange (IPX), and Multiprotocol Label Switching (MPLS). If you have configured MPLS on the Cisco 7600 series routers with redundant supervisor engines, you must configure the Cisco 7600 series router in RPR mode. The switch should not be running in the default mode of SSO. Enter the redundancy command in global configuration mode to enter redundancy configuration mode. You can enter the mode command within redundancy configuration mode. Follow these guidelines when configuring your system for RPR+ mode: • You must install compatible images on the active and standby supervisor engines to support RPR+ mode and SSO mode. • Both supervisor engines must run the same Cisco IOS software version. • Any modules that are not online at the time of a switchover are reset and reloaded on a switchover. • The Forwarding Information Base (FIB) tables are cleared on a switchover. As a result, routed traffic is interrupted until route tables reconverge. The standby supervisor engine reloads on any change of mode and begins to work in the current mode. When you use this command to force the standby supervisor engine to run as a Distributed Forwarding Card (DFC) card, the uplink ports in the standby engine continue to be in use and are not disabled. Release Modification 12.2(14)SX This command was introduced on the Supervisor Engine 720. 12.2(17b)SXA This command was modified. Support was added for SSO mode and the default mode change. 12.2(17d)SXB This command was modified. Support was added for multicast and unicast traffic. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)XNE This command was modified. This command was implemented on the Cisco 10000 router. Cisco IOS XE Release 2.5 This command was modified. This command was implemented on the Cisco ASR 1000 Series Routers. mode CF-354 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco IOS Release XE Release 2.5 and ASR 1000 Series Routers For Cisco ASR 1002 and 1004 routers, RRP and stateful switchover can be used to switch between Cisco IOS processes. RPR and SSO need to be configured by the user, however, because a second Cisco IOS process is not available by default on Cisco ASR 1002 and 1004 routers. Enter the redundancy command in global configuration mode to enter redundancy configuration mode. You can enter the mode command within redundancy configuration mode. The Cisco ASR 1006 Router supports a second Route Processor. The second Cisco IOS process can run only on the standby Route Processor. This means that hardware redundancy is available and RPR and SSO do not need to be configured by the user because a second Cisco IOS process is available by default on the Cisco ASR 1006 router. RPR+ mode is not supported on the Cisco ASR 1000 Series Routers. Cisco IOS Release 12.2XNE and 1000 Series Routers Enter the redundancy command in global configuration mode to enter redundancy configuration mode. You can enter the mode command within redundancy configuration mode. RPR mode is not supported on the Cisco 10000 router. Examples This example shows how to set the redundancy mode to RPR+: Router(config)# redundancy Router(config-red)# mode rpr-plus This example shows how to set the redundancy mode to SSO: Router(config)# redundancy Router(config-red)# mode sso Related Commands Command Description redundancy Enters redundancy configuration mode. redundancy force-switchover Forces a switchover from the active to the standby supervisor engine. route-converge-interval Configures the time interval after which the old FIB entries are purged. show redundancy Displays RF information. show running-config Displays the status and configuration of the module or Layer 2 VLAN. CF-355 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor event-trace (EXEC) CF-356 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor event-trace (EXEC) To monitor and control the event trace function for a specified Cisco IOS software subsystem component, use the monitor event-trace command in privileged EXEC mode. monitor event-trace component {clear | continuous | disable | dump [pretty] | enable | one-shot} Cisco 10000 Series Routers monitor event-trace component {disable | dump | enable | size | stacktrace} Catalyst 6500 Series Switches and Cisco 7600 Series Routers monitor event-trace all-traces {continuous [cancel] | dump [merged] [pretty]} monitor event-trace l3 {clear | continuous [cancel] | disable | dump [pretty] | enable | interface type mod/port | one-shot} monitor event-trace spa {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot} monitor event-trace subsys {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot} Syntax Description component Name of the Cisco IOS software subsystem component that is the subject of the event trace. To get a list of components that support event tracing, use the monitor event-trace ? command. clear Clears existing trace messages for the specified component from memory on the networking device. continuous Continuously displays the latest event trace entries. disable Turns off event tracing for the specified component. dump Writes the event trace results to the file configured using the monitor event-trace command in global configuration mode. The trace messages are saved in binary format. pretty (Optional) Saves the event trace message in ASCII format. enable Turns on event tracing for the specified component. one-shot Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the monitor event-trace command in global configuration mode. size Sets the number of messages that can be written to memory for a single instance of a trace. Note Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the show monitor event-trace component parameters command. When the number of event trace messages in memory exceeds the size, new messages will begin to overwrite the older messages in the file. stacktrace Enables the stack trace at tracepoints. all-traces Displays the configured merged-event traces. monitor event-trace (EXEC) CF-357 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default The event trace function is disabled by default. Command Modes Privileged EXEC (#) Command History Usage Guidelines Use the monitor event-trace command to control what, when, and how event trace data is collected. Use this command after you have configured the event trace functionality on the networking device using the monitor event-trace command in global configuration mode. Note The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace command in global configuration mode for each instance of a trace. The Cisco IOS software allows for the subsystem components to define whether support for event tracing is enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the monitor event-trace command in privileged EXEC mode or using the monitor event-trace command in global configuration mode. To disable event tracing, you would enter either of these commands with the disable keyword. To enable event tracing again, you would enter either of these commands with the enable keyword. To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? command to get a list of software components that support event tracing. To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to display trace messages. merged (Optional) Dumps the entries in all event traces sorted by time. l3 Displays information about the Layer 3 trace. spa Displays information about the Shared Port Adapter (SPA) trace. interface type mod/port Specifies the interface to be logged. cancel (Optional) Cancels the continuous display of latest trace entries. subsys Displays information about the subsystem’s initial trace. Release Modification 12.0(18)S This command was introduced. 12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T. 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. The monitor event-trace cef ipv4 clear command replaces the clear ip cef event-log command. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T. monitor event-trace (EXEC) CF-358 Cisco IOS Configuration Fundamentals Command Reference April 2010 Use the show monitor event-trace command to display trace messages. Use the monitor event-trace component dump command to save trace message information for a single event. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace component dump pretty command. To write the trace messages for all events currently enabled on a networking device to a file, enter the monitor event-trace dump command. To configure the file where you want to save trace information, use the monitor event-trace command in global configuration mode. The trace messages are saved in a binary format. Examples The following example shows the privileged EXEC commands to stop event tracing, clear the current contents of memory, and reenable the trace function for the interprocess communication (IPC) component. This example assumes that the tracing function is configured and enabled on the networking device. Router# monitor event-trace ipc disable Router# monitor event-trace ipc clear Router# monitor event-trace ipc enable The following example shows how the monitor event-trace one-shot command accomplishes the same function as the previous example except in one command. In this example, once the size of the trace message file has been exceeded, the trace is terminated. Router# monitor event-trace ipc one-shot The following example shows the command for writing trace messages for an event in binary format. In this example, the trace messages for the IPC component are written to a file. Router# monitor event-trace ipc dump The following example shows the command for writing trace messages for an event in ASCII format. In this example, the trace messages for the MBUS component are written to a file. Router# monitor event-trace mbus dump pretty Catalyst 6500 Series Switches and Cisco 7600 Series Routers Examples Only This example shows how to stop event tracing, clear the current contents of memory, and reenable the trace function for the SPA component. This example assumes that the tracing function is configured and enabled on the networking device. Router# monitor event-trace spa disable Router# monitor event-trace spa clear Router# monitor event-trace spa enable Related Commands Command Description monitor event-trace (global) Configures event tracing for a specified Cisco IOS software subsystem component. monitor event-trace dump-traces Saves trace messages for all event traces currently enabled on the networking device. show monitor event-trace Displays event trace messages for Cisco IOS software subsystem components. monitor event-trace (global) CF-359 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor event-trace (global) To configure event tracing for a specified Cisco IOS software subsystem component, use the monitor event-trace command in global configuration mode. monitor event-trace component {disable | dump-file filename | enable | size number | stacktrace number} monitor event-trace timestamps [datetime [localtime] [msec] [show-timezone] | uptime] Cisco 10000 Series Routers monitor event-trace component {disable | dump-file filename | enable | clear | continuous | one-shot} Syntax Description component Name of the Cisco IOS software subsystem component that is the object of the event trace. To get a list of components that support event tracing, use the monitor event-trace ? command. disable Turns off event tracing for the specified component. dump-file filename Specifies the file where event trace messages are written from memory on the networking device. The maximum length of the filename (path and filename) is 100 characters, and the path can point to flash memory on the networking device or to a TFTP or FTP server. enable Turns on event tracing for the specified component provided that the component has been configured using the monitor event-trace command. size number Sets the number of messages that can be written to memory for a single instance of a trace. Valid values are from1 to 65536. Note Some Cisco IOS software subsystem components set the size by default. To display the size parameter, use the show monitor event-trace component parameters command. When the number of event trace messages in memory exceeds the configured size, new messages will begin to overwrite the older messages in the file. stacktrace number Enables the stack trace at tracepoints and specifies the depth of the stack trace stored. Valid values are from 1 to 16. timestamps Includes time stamp information with the event trace messages for the specified component. datetime (Optional) Specifies that the time stamp information included with event trace messages will consist of the date and time of the event trace. localtime (Optional) Specifies that the time given in the time stamp will be local time. msec (Optional) Includes milliseconds in the time stamp. show-timezone (Optional) Includes time zone information in the time stamp. uptime (Optional) Displays time stamped information about the system uptime. clear Clears existing trace messages for the specified component from memory on the networking device. monitor event-trace (global) CF-360 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default Event tracing is enabled or disabled depending on the software component. Command Modes Global configuration (config) Command History Usage Guidelines Use the monitor event-trace command to enable or disable event tracing and to configure event trace parameters for Cisco IOS software subsystem components. Note Event tracing is intended for use as a software diagnostic tool and should be configured only under the direction of a Technical Assistance Center (TAC) representative. In Cisco IOS software images that do not provide subsystem support for the event trace function, the monitor event-trace command is not available. The Cisco IOS software allows the subsystem components to define whether support for event tracing is enabled or disabled by default. The command interface for event tracing allows you to change the default two ways: using the monitor event-trace command in privileged EXEC mode or using the monitor event-trace command in global configuration mode. Additionally, default settings do not show up in the configuration file. If the subsystem software enables event tracing by default, the monitor event-trace component enable command will not show up in the configuration file of the networking device; however, disabling event tracing that has been enabled by default by the subsystem will create a command entry in the configuration file. Note The amount of data collected from the trace depends on the trace message size configured using the monitor event-trace command for each instance of a trace. To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ? command to get a list of software components that support event tracing. continuous Continuously displays the latest event trace entries. one-shot Clears any existing trace information from memory, starts event tracing again, and disables the trace when the trace reaches the size specified using the monitor event-trace command. Release Modification 12.0(18)S This command was introduced. 12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T. 12.2(14)SX This command was integrated into Cisco IOS Release 12.2(14)SX and implemented on the Supervisor Engine 720. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB and implemented on the Cisco 10000 series routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T. monitor event-trace (global) CF-361 Cisco IOS Configuration Fundamentals Command Reference April 2010 To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-trace command to display trace messages. To specify the trace call stack at tracepoints, you must first clear the trace buffer. Examples The following example shows how to enable event tracing for the interprocess communication (IPC) subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages file is set to ipc-dump in slot0 (flash memory). configure terminal ! monitor event-trace ipc enable monitor event-trace ipc dump-file slot0:ipc-dump monitor event-trace ipc size 4096 When you select Cisco Express Forwarding as the component for which to enable event tracing, you can use the following additional arguments and keywords: monitor event-trace cef [events | interface | ipv6 | ipv4][all]. The following example shows how to enable event tracing for IPv4 or IPv6 events of the Cisco Express Forwarding component in Cisco IOS software: configure terminal ! monitor event-trace cef ipv4 enable configure terminal ! monitor event-trace cef ipv6 enable exit The following example shows what happens when you try to enable event tracing for a component (in this case, adjacency events) when it is already enabled: configure terminal ! monitor event-trace adjacency enable %EVENT_TRACE-6-ENABLE: Trace already enabled. Related Commands Command Description monitor event-trace (EXEC) Controls the event trace function for a specified Cisco IOS software subsystem component. monitor event-trace dump-traces Saves trace messages for all event traces currently enabled on the networking device. show monitor event-trace Displays event trace messages for Cisco IOS software subsystem components. monitor event-trace dump-traces CF-362 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor event-trace dump-traces To save trace messages for all event traces currently enabled on the networking device, use the monitor event-trace dump-traces command in privileged EXEC mode. monitor event-trace dump-traces [pretty] Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines Use the monitor event-trace dump-traces command to save trace message information for all event traces currently enabled on a networking device. By default, trace information is saved in binary format. If you want to save trace messages in ASCII format, possibly for additional application processing, use the monitor event-trace dump-traces pretty command. To write the trace messages for an individual trace event to a file, enter the monitor event-trace (EXEC) command. To configure the file where you want to save messages, use the monitor event-trace (global) command. Examples The following example shows how to save the trace messages in binary format for all event traces enabled on the networking device. monitor event-trace dump-traces The following example shows how to save the trace messages in ASCII format for all event traces enabled on the networking device. monitor event-trace dump-traces pretty Related Commands pretty (Optional) Saves the event trace message in ASCII format. Release Modification 12.0(18)S This command was introduced. 12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T. Command Description monitor event-trace (EXEC) Controls event trace function for a specified Cisco IOS software subsystem component. monitor event-trace (global) Configures event tracing for a specified Cisco IOS software subsystem component. show monitor event-trace Displays event trace messages for Cisco IOS software subsystem components. monitor permit-list CF-363 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor permit-list To configure a destination port permit list or add to an existing destination port permit list, use the monitor permit-list command in global configuration mode. To delete from or clear an existing destination port permit list, use the no form of this command. Activate monitoring monitor permit-list no monitor permit-list Activate monitoring on one port monitor permit-list destination interface interface-type slot/port no monitor permit-list destination interface interface-type slot/port Activate monitoring on one range of ports monitor permit-list destination interface interface-type slot/port-last-port no monitor permit-list destination interface interface-type slot/port-last-port Activate monitoring on two or more ranges of ports monitor permit-list destination interface interface-type slot/port-last-port , [port-last-port ] no monitor permit-list destination interface interface-type slot/port-last-port , [port-last-port ] Syntax Description Defaults Disabled Command Modes Global configuration destination Specifies a destination port. interface interface-type Specifies the interface type; valid values are ethernet, fastethernet, gigabitethernet, or tengigabitethernet. slot The slot that the interface module is installed in. port Specifies a single port on an interface module, or the first port on an interface module used in a range of ports. last-port (Optional) Specifies the port on an interface module used as the last port in a range of ports. , (Optional) Separates each instance of a port, or range of ports, that are monitored. See the Usage Guidelines and the Examples for more information. monitor permit-list CF-364 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines To prevent accidental configuration of ports as destinations, you can create a permit list of the ports that are valid for use as destinations. With a destination port permit list configured, you can only configure the ports in the permit list as destinations. When you enter multiple instances of interface interface-type slot/port-last-port, you must enter a space before and after the comma. For example, interface interface-type slot/port-last-port , interface-type slot/port-last-port , interface-type slot/port-last-port. Examples This example shows how to configure a destination port permit list that includes Gigabit Ethernet ports 5/1 through 5/4, and activate monitoring: Router# configure terminal Router(config)# monitor permit-list destination interface gigabitethernet 5/1-4 Router(config)# monitor permit-list This example shows how to configure a destination port permit list that includes Fast Ethernet ports 1/1-48, 2/1-48, and Gigabit Ethernet ports 3/1 through 3/4, and activate monitoring: Router# configure terminal Router(config)# monitor permit-list destination interface fastEthernet 1/1-48 , fastEthernet 2/1-48 , gigabitEthernet 3/1-4 Router(config)# monitor permit-list Related Commands Release Modification 12.2(18)SXE Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show monitor permit-list Displays the permit-list state and interfaces configured. monitor session egress replication-mode CF-365 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor session egress replication-mode To switch the egress-span mode from the default mode (either centralized or distributed depending on your Cisco IOS software release), use the monitor session egress replication-mode command in global configuration mode. To return to the default mode, use the no form of the command. Cisco IOS Release 12.2(33)SXH2a and Later Releases monitor session egress replication-mode centralized no monitor session egress replication-mode centralized Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2 monitor session egress replication-mode distributed no monitor session egress replication-mode distributed Syntax Description Command Default Cisco IOS Releases 12.2(33)SXH2a and later releases: Centralized mode Cisco IOS Releases 12.2(33)SXH, SXH1, and SXH2: Distributed mode Command Modes Global configuration (config) Command History Usage Guidelines Note Prior to Cisco IOS Release 12.2(33)SXH and the introduction of this feature, the operating mode was centralized and could not be changed. Centralized egress span monitoring redirects traffic to the supervisor engine for egress monitoring. centralized In Cisco IOS Release 12.2(33)SXH2a and later releases: Specifies centralized egress span monitoring as the default mode. distributed In Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2: Specifies distributed egress span monitoring as the default mode. Release Modification 12.2(33)SXH This command was introduced. 12.2(33)SXH2a The command was changed as follows: • The default mode was changed from distributed mode to centralized mode. • The centralized keyword was removed and the distributed keyword was added. monitor session egress replication-mode CF-366 Cisco IOS Configuration Fundamentals Command Reference April 2010 Distributed egress span monitoring is performed in the ingress module. Distributed replication for Switched Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN) increases the total throughput at the span destination. Note Distributed egress span (DES) mode is applied to ASIC-based sessions only. Examples Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2 The following example shows how to switch the egress-span mode from the distributed default to centralized mode: Router(config)# monitor session egress replication-mode centralized The following example shows how to switch the egress-span mode from centralized back to distributed mode: Router(config)# no monitor session egress replication-mode centralized Cisco IOS Release 12.2(33)SXH2a and Later Releases The following example shows how to switch the egress-span mode from the centralized default to distributed mode: Router(config)# monitor session egress replication-mode distributed The following example shows how to switch the egress-span mode from distributed back to centralized mode: Router(config)# no monitor session egress replication-mode distributed Related Commands Command Description show monitor session Displays the operational mode and configured mode of the session and module session capabilities. monitor session type CF-367 Cisco IOS Configuration Fundamentals Command Reference April 2010 monitor session type To configure a local Switched Port Analyzer (SPAN), RSPAN, or ERSPAN, use the monitor session type command in global configuration mode. To remove one or more source or destination interfaces from the SPAN session, use the no form of this command. monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx | rspan-destination | rspan-source} no monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx | rspan-destination | rspan-source} Syntax Description Defaults This command has no default settings. Command Modes Global configuration (config) Command History Usage Guidelines Release 12.2(18)SXE and later releases support ERSPAN with the Supervisor Engine 720, hardware revision 3.2 or higher. Enter the show module version | include WS-SUP720-BASE command to display the hardware revision. span-session-number Number of the local SPAN or ERSPAN session; valid values are from 1 to 66. erspan-destination Specifies the ERSPAN destination-session configuration mode. erspan-source Specifies the ERSPAN source-session configuration mode. local Specifies the local SPAN session configuration mode. local-tx Specifies the local egress-only SPAN session configuration mode. rspan-destination Specifies the RSPAN destination-session configuration mode. rspan-source Specifies the RSPAN source-session configuration mode. Release Modification 12.2(18)SXE Support for this command was introduced on the Supervisor Engine 720. 12.2(18)SXF This command was changed as follows: • Support for this command was introduced on the Supervisor Engine 32. • ERSPAN is supported in any switch fabric module functionality switching mode. 12.2(33)SXH This command was changed to include the following keywords: • local • local-tx • rspan-destination • rspan-source monitor session type CF-368 Cisco IOS Configuration Fundamentals Command Reference April 2010 ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination session. This command is not supported on Catalyst 6500 series switches that are configured with a Supervisor Engine 2. All ERSPAN source sessions on a switch must use the same source IP address. You enter the origin ip address command to configure the IP address for the ERSPAN source sessions. All ERSPAN destination sessions on a switch must use the same IP address. You enter the ip address command to configure the IP address for the ERSPAN destination sessions. If the ERSPAN destination IP address is not a Supervisor Engine 720 (for example, it is a network sniffer), the traffic arrives with the GRE and RSPAN headers/encapsulation intact. The ERSPAN source session destination IP address, which must be configured on an interface on the destination switch, is the source of traffic that an ERSPAN destination session sends to the destination ports. You configure the same address in both the source and destination sessions with the ip address command. The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from different ERSPAN source sessions. The local ERSPAN session limits are as follows: • Total sessions—66 • Source sessions—2 (ingress or egress or both) • Destination sessions—23 The monitor session type command creates a new ERSPAN session or allows you to enter the ERSPAN session configuration mode. ERSPAN uses separate source and destination sessions. You configure the source and destination sessions on different switches. The ERSPAN session configuration mode prompts are as follows: • Router(config-mon-erspan-src)—Indicates the ERSPAN source session configuration mode. • Router(config-mon-erspan-src-dst)—Indicates the ERSPAN source session destination configuration mode. • Router(config-mon-erspan-dst)—Indicates the ERSPAN destination session configuration mode. • Router(config-mon-erspan-dst-src)—Indicates the ERSPAN destination session source configuration mode Table 35 lists the ERSPAN destination session configuration mode syntaxes. Table 35 ERSPAN Destination Session Configuration Mode Syntaxes Syntax Description Global Configuration Mode monitor session erspan-destination-session-number | rspan-destination-session-number type erspan-destination | erspan-destination Enters ERSPAN or RSPAN destination session configuration mode and changes the prompt to the following: Router(config-mon-erspan-dst)# Router(config-mon-rspan-dst)# Destination Session Configuration Mode description session-description (Optional) Describes the ERSPAN or RSPAN destination session. monitor session type CF-369 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 36 lists the ERSPAN source session configuration mode syntaxes. shutdown (Optional) (Default) Inactivates the ERSPAN destination session. no shutdown Activates the ERSPAN destination session. destination {single-interface | interface-list | interface-range | mixed-interface-list} Associates the ERSPAN destination session number with the destination ports. source Enters ERSPAN destination session source configuration mode and changes the prompt to the following: Router(config-mon-erspan-dst-src)# Destination Session Source Configuration Mode ip address ip-address [force] Configures the ERSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN destination session configuration. erspan-id erspan-flow-id Configures the ID number used by the destination and destination sessions to identify the ERSPAN traffic. vrf vrf-name (Optional) Configures the VRF name of the packets in the ERSPAN traffic. Table 35 ERSPAN Destination Session Configuration Mode Syntaxes Syntax Description Table 36 ERSPAN or RSPAN Source Session Configuration Mode Syntaxes Syntax Description Global Configuration Mode monitor session erspan-source-session-number type erspan-source | rspan-source Enters ERSPAN or RSPAN source session configuration mode and changes the prompt as appropriate to the following: Router(config-mon-erspan-src)# Router(config-mon-rspan-src)# Source Session Configuration Mode description session-description (Optional) Describes the ERSPAN or RSPAN source session. shutdown (Optional) (Default) Inactivates the ERSPAN or RSPAN source session. no shutdown Activates the ERSPAN or RSPAN source session. source {{single-interface | interface-list | interface-range | mixed-interface-list | single-vlan | vlan-list | vlan-range | mixed-vlan-list} [rx | tx | both]} Associates the ERSPAN or RSPAN source session number with the source ports or VLANs, and selects the traffic direction to be monitored. filter {single-vlan | vlan-list | vlan-range | mixed-vlan-list} (Optional) Configures source VLAN filtering when the ERSPAN or RSPAN source is a trunk port. description session-description (Optional) Describes the ERSPAN or RSPAN source session. monitor session type CF-370 Cisco IOS Configuration Fundamentals Command Reference April 2010 When you configure the monitor sessions, follow these syntax guidelines: • erspan-destination-span-session-number can range from 1 to 66. • single-interface is interface type slot/port; type is fastethernet, gigabitethernet, or tengigabitethernet. • interface-list is single-interface , single-interface , single-interface ... Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash. • interface-range is interface type slot/first-port - last-port . • mixed-interface-list is, in any order, single-interface , interface-range , ... • erspan-flow-id can range from 1 to 1023. When you clear the monitor sessions, follow these syntax guidelines: • The no monitor session session-number command entered with no other parameters clears the session session-number. • session-range is first-session-number-last-session-number. Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas. Use the monitor session type local command to configure ingress, egress, or both ingress and egress SPAN sessions. Source Session Destination Configuration Mode ip address ip-address Configures the ERSPAN or RSPAN flow destination IP address, which must also be configured on an interface on the destination switch and be entered in the ERSPAN or RSPAN destination session configuration. erspan-id erspan-flow-id Configures the ID number used by the source and destination sessions to identify the ERSPAN or RSPAN traffic. origin ip address ip-address Configures the IP address used as the source of the ERSPAN or RSPAN traffic. ip {{ttl ttl-value} | {prec ipp-value} | {dscp dscp-value}} (Optional) Configures the following packet values in the ERSPAN or RSPAN traffic: • ttl ttl-value—IP time-to-live (TTL) value • prec ipp-value—IP-precedence value • dscp dscp-value—IP-precedence value vrf vrf-name (Optional) Configures the VRF name of the packets in the ERSPAN or RSPAN traffic. Table 36 ERSPAN or RSPAN Source Session Configuration Mode Syntaxes Syntax Description monitor session type CF-371 Cisco IOS Configuration Fundamentals Command Reference April 2010 Use the monitor session type local-tx command to configure egress-only SPAN sessions. When you enter the local or the local egress-only SPAN session configuration mode, the prompt changes accordingly to Router(config-mon-local)# or Router(config-mon-local-tx)#, and the following commands are available: • description—Describes the properties for this session using this syntax: description description The description can be up to 240 characters and cannot contain special characters or spaces. • destination—Specifies the destination and the destination properties using this syntax: destination {analysis-module num | anomaly-detector-module num | interface type number | intrusion-detection-module num} • exit—Exits from configuration session mode. • filter vlan vlan-id—Limits the SPAN source traffic to specific VLANs; valid values are from 1 to 4096. • no—Negates a command or sets its defaults. • shutdown—Shuts down this session • source—Specifies the SPAN source interface or VLAN using the following syntax: source {cpu {rp | sp} | {interface type number} | {intrusion-detection-module num} | {vlan vlan-id}} [, | - | rx | tx | both] analysis-module num Specifies the SPAN destination analysis-module. anomaly-detector-module num Specifies the SPAN destination anomaly-detector-module. interface type number Specifies the interface type and number as follows: • GigabitEthernet mod/port • port-channel num—Ethernet Channel of interfaces; valid values are from 1 to 496. ingress (Optional) Configures destinations to receive traffic from attached devices. learning (Optional) Enables MAC address learning from the destinations, which allows the switch to transmit traffic that is addressed to devices attached to the destinations. intrusion-detection-module num Specifies the SPAN destination intrusion-detection-module. cpu rp Associates the local SPAN session number with the CPU on the route processor. cpu sp Associates the local SPAN session number with the CPU on the switch processor. monitor session type CF-372 Cisco IOS Configuration Fundamentals Command Reference April 2010 The local SPAN session limits are as follows: • Total sessions—80 • Source sessions—2 (ingress or egress or both) • Egress only—14 If you enter the filter keyword on a monitored trunk interface, only traffic on the set of specified VLANs is monitored. Only one destination per SPAN session is supported. If you attempt to add another destination interface to a session that already has a destination interface configured, you get an error. You must first remove a SPAN destination interface before changing the SPAN destination to a different interface. You can configure up to 64 SPAN destination interfaces, but you can have one egress SPAN source interface and up to 128 ingress source interfaces only. A SPAN session can either monitor VLANs or monitor individual interfaces, but it cannot monitor both specific interfaces and specific VLANs. Configuring a SPAN session with a source interface and then trying to add a source VLAN to the same SPAN session causes an error. Configuring a SPAN session with a source VLAN and then trying to add a source interface to that session also causes an error. You must first clear any sources for a SPAN session before switching to another type of source. Port channel interfaces display in the list of interface options if you have them configured. VLAN interfaces are not supported. However, you can span a particular VLAN by entering the monitor session session source vlan vlan-id command. When you configure the destination, use these guidelines: • A single-interface is as follows: – interface type slot/port; type is fastethernet, gigabitethernet, or tengigabitethernet. – interface port-channel number Note Destination port channel interfaces must be configured with the channel-group group-num mode on command and the no channel-protocol command. • An interface-list is single-interface , single-interface , single-interface ... interface type number Specifies the interface type and number as follows: • FastEthernet mod/port • GigabitEthernet mod/port • Port-channel num—Ethernet Channel of interfaces; valid values are from 1 to 496. vlan vlan-id Specifies the VLAN; valid values are from 1 to 4094. , (Optional) Specifies another range of interfaces. - (Optional) Specifies a range of interfaces. both (Optional) Monitors the received and the transmitted traffic. rx (Optional) Monitors the received traffic only. tx1 (Optional) Monitors the transmitted traffic only. 1. When you enter the local-tx keyword, the rx and both keywords are not available and the tx keyword is required. monitor session type CF-373 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and after the dash. • An interface-range is interface type slot/first-port - last-port. • A mixed-interface-list is, in any order, single-interface , interface-range , ... • A single-vlan is the ID number of a single VLAN. • A single-list is single-vlan , single-vlan , single-vlan ... • A vlan-range is first-vlan-ID - last-vlan-ID. • A mixed-vlan-list is, in any order, single-vlan , vlan-range , ... When you clear the monitor sessions, follow these syntax guidelines: • The no monitor session session-number command entered with no other parameters clears the session session-number. • session-range is first-session-number-last-session-number. Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If you enter multiple ranges, do not enter spaces before or after the commas. Examples This example shows how to configure an ERSPAN source session number and enter the ERSPAN source session configuration mode for the session: Router(config)# monitor session 55 type erspan-source Router(config-mon-erspan-src)# This example shows how to configure an ERSPAN destination session number and enter the ERSPAN destination session configuration mode for the session: Router(config)# monitor session 55 type erspan-destination Router(config-mon-erspan-dst)# This example shows how to associate the ERSPAN destination session number with the destination ports: Router(config-mon-erspan-dst) destination interface fastethernet 1/2 , 2/3 This example shows how to enter the ERSPAN destination session source configuration: Router(config-mon-erspan-dst)# source Router(config-mon-erspan-dst-src)# This example shows how to enter the ERSPAN destination session source configuration mode: Router(config-mon-erspan-dst)# source Router(config-mon-erspan-dst-src)# This example shows how to configure multiple sources for a session: Router(config-mon-erspan-src)# source interface fastethernet 5/15 , 7/3 rx Router(config-mon-erspan-src)# source interface gigabitethernet 1/2 tx Router(config-mon-erspan-src)# source interface port-channel 102 Router(config-mon-erspan-src)# source filter vlan 2 - 3 Router(config-mon-erspan-src)# monitor session type CF-374 Cisco IOS Configuration Fundamentals Command Reference April 2010 This example shows how to enter the ERSPAN source session destination configuration mode: Router(config-mon-erspan-src)# destination Router(config-mon-erspan-src-dst)# This example shows how to configure the ID number that is used by the source and destination sessions to identify the ERSPAN traffic: Router(config-mon-erspan-src-dst)# erspan-id 1005 Router(config-mon-erspan-src-dst)# This example shows how to configure session 1 to monitor ingress traffic from Gigabit Ethernet port 1/1 and configure Gigabit Ethernet port 1/2 as the destination: Router(config)# monitor session 1 type local Router(config-mon-local)# source interface gigabitethernet 1/1 rx Router(config-mon-local)# destination interface gigabitethernet 1/2 This example shows how to configure session 1 to monitor egress-only traffic from Gigabit Ethernet port 5/1 and configure Gigabit Ethernet port 5/2 as the destination: Router(config)# monitor session 1 type local-tx Router(config-mon-local)# source interface gigabitethernet 5/1 rx Router(config-mon-local)# destination interface gigabitethernet 5/2 This example shows how to remove an interface from a session: Router(config)# no monitor session 1 type local-tx Related Commands Command Description monitor session type Creates an ERSPAN source session number or enters the ERSPAN session configuration mode for the session. show monitor session Displays information about the ERSPAN, SPAN, and RSPAN sessions. mop device-code CF-375 Cisco IOS Configuration Fundamentals Command Reference April 2010 mop device-code To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification (sysid) messages and request program messages, use the mop device-code command in global configuration mode. To set the identity to the default value, use the no form of this command. mop device-code {cisco | ds200} no mop device-code {cisco | ds200} Syntax Description Defaults Cisco device code Command Modes Global configuration Command History Usage Guidelines The sysid messages and request program messages use the identity information indicated by this command. Examples The following example identifies a DECserver 200 device as sending MOP sysid and request program messages: mop device-code ds200 Related Commands cisco Denotes a Cisco device code. This is the default. ds200 Denotes a DECserver 200 device code. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description mop sysid Enables an interface to send out periodic MOP system identification messages. mop retransmit-timer CF-376 Cisco IOS Configuration Fundamentals Command Reference April 2010 mop retransmit-timer To configure the length of time that the Cisco IOS software waits before resending boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retransmit-timer command in global configuration mode. To reinstate the default value, use the no form of this command. mop retransmit-timer seconds no mop retransmit-timer Syntax Description Defaults 4 seconds Command Modes Global configuration Command History Usage Guidelines By default, when the software sends a request that requires a response from a MOP boot server and the server does not respond, the message is re-sent after 4 seconds. If the MOP boot server and router are separated by a slow serial link, it might take longer than 4 seconds for the software to receive a response to its message. Therefore, you might want to configure the software to wait longer than 4 seconds before resending the message if you are using such a link. Examples In the following example, if the MOP boot server does not respond within 10 seconds after the router sends a message, the server will resend the message: mop retransmit-timer 10 Related Commands seconds Sets the length of time (in seconds) that the software waits before resending a message. The value is a number from 1 to 20. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description mop device-code Identifies the type of device sending MOP sysid messages and requests program messages. mop enabled Enables an interface to support the MOP. mop retries CF-377 Cisco IOS Configuration Fundamentals Command Reference April 2010 mop retries To configure the number of times the Cisco IOS software will resend boot requests to a Maintenance Operation Protocol (MOP) server, use the mop retries command in global configuration mode. To reinstate the default value, use the no form of this command. mop retries count no mop retries Syntax Description Defaults 8 times Command Modes Global configuration Command History Examples In the following example, the software will attempt to resend a message to an unresponsive host 11 times before declaring a failure: Router(config)# mop retries 11 Related Commands count Indicates the number of times the software will resend a MOP boot request. The value is a number from 3 to 24. The default is 8. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description mop device-code Identifies the type of device sending MOP sysid messages and requests program messages. mop enabled Enables an interface to support the MOP server. mop retransmit-timer Configures the length of time that the Cisco IOS software waits before resending boot requests to a MOP server. more CF-378 Cisco IOS Configuration Fundamentals Command Reference April 2010 more To display the contents of a file, use the more command in EXEC mode. more [/ascii | /binary | /ebcdic] url Syntax Description Defaults The command displays the conent of a file in its native format. Optional formats include ascii, binary, and ebcdic. Command Modes EXEC Command History Usage Guidelines The more system:running-config command displays the same output as the show running-config command. The more nvram:startup-config command is recommended as a replacement for the show startup-config command and the show configuration command. You can use this command to display configuration files, as follows: • The more nvram:startup-config command displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. The Cisco IOS software informs you whether the displayed configuration is a complete configuration or a distilled version. A distilled configuration is one that does not contain access lists. • The more system:running-config command displays the running configuration. These commands show the version number of the software used when you last changed the configuration file. You can also display the contents of files on remote systems using the more command. For example, you could display a saved running configuration file on an FTP server using more ftp://username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the copy command for more information on file-system prefixes available in the Cisco IOS CLI. Options for filtering and redirecting the output of this command are available by appending a pipe character (|). See the Related Commands table for a list of more command extensions. /ascii (Optional) Displays a binary file in ASCII format. /binary (Optional) Displays a file in hex/text format. /ebcdic (Optional) Displays a binary file in EBCDIC format. url The URL of the file to display. A URL in the CLI consists of a file-system prefix (such as system: or nvram:), an optional path (such as a folder name), and the name of a file. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. more CF-379 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following partial sample output displays the configuration file named startup-config in NVRAM: Router# more nvram:startup-config ! ! No configuration change since last restart ! NVRAM config last updated at 02:03:26 PDT Thu Oct 2 1997 ! version 12.1 service timestamps debug uptime service timestamps log uptime service password-encryption service udp-small-servers service tcp-small-servers . . . end The following is partial sample output from the more nvram:startup-config command when the configuration file has been compressed: Router# more nvram:startup-config Using 21542 out of 65536 bytes, uncompressed size = 142085 bytes ! version 12.1 service compress-config ! hostname rose ! . . . The following partial sample output displays the running configuration: Router2# more system:running-config Building configuration... Current configuration: ! version 12.1 no service udp-small-servers no service tcp-small-servers ! hostname Router2 ! . . . ! end Related Commands Command Description boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). more begin Begins the output of any more command from a matched string. more CF-380 Cisco IOS Configuration Fundamentals Command Reference April 2010 more exclude Filters the output of any more command to exclude a matched string. more include Filters the output of any more command to display only the lines that match the specified string. service compress-config Compresses startup configuration files. show bootvar Displays the contents of the BOOT environment variable, the name of the configuration file pointed to by the CONFIG_FILE environment variable, the contents of the BOOTLDR environment variable, and the configuration register setting. Command Description more begin CF-381 Cisco IOS Configuration Fundamentals Command Reference April 2010 more begin To search the output of any more command, use the more url | begin command in EXEC mode. This command begins unfiltered output of the more command with the first line that contains the regular expression you specify. more url | begin regular-expression Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. You can specify a new search at every --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt: /regular-expression To filter the remaining output of the more command, use one of the following commands at the --More-- prompt: -regular-expression +regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z. url The Universal Resource Locator (RLl) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command. | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in more command output. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. - Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression. + Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression. Release Modification 11.3 AA The more command was introduced. 12.0(1)T This extension of the more command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. more begin CF-382 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter. Because prior output is not saved, you cannot search or filter backward through prior output. Examples The following is partial sample output of the more nvram:startup-config | begin command that begins unfiltered output with the first line that contain the regular expression “ip.” At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression “ip.” router# more nvram:startup-config | begin ip ip subnet-zero ip domain-name cisco.com ip name-server 198.92.30.32 ip name-server 171.69.2.132 ! isdn switch-type primary-5ess . . . interface Ethernet1 ip address 5.5.5.99 255.255.255.0 --More-- -ip filtering... media-type 10BaseT ! interface Serial0:23 encapsulation frame-relay no keepalive dialer string 4001 dialer-group 1 isdn switch-type primary-5ess no fair-queue Related Commands Command Description more exclude Filters more command output so that it excludes lines that contain a particular regular expression. more include Filters more command output so that it displays only lines that contain a particular regular expression. show begin Searches the output of any show command and displays the output from the first instance of a specified string. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show include Filters show command output so that it displays only lines that contain a particular regular expression. more exclude CF-383 Cisco IOS Configuration Fundamentals Command Reference April 2010 more exclude To filter more command output so that it excludes lines that contain a particular regular expression, use the more exclude command in EXEC mode. more url | exclude regular-expression Syntax Description Command Modes EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt: /regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z. Because prior output is not saved, you cannot search or filter backward through prior output. url The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command. The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename Prefixes can be local file systems or file locations, such as nvram: or system:. Alternatively, you can specify network locations using the following syntax: ftp:[[//[username[:password]@]location]/directory]/filename tftp:[[//location]/directory]/filename rcp:[[//[username@]location]/directory]/filename | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in more command output. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. Release Modification 11.3 AA The more command was introduced. 12.0(1)T This extension of the more command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. more exclude CF-384 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following is partial sample output of the more nvram:startup-config | exclude command. The use of | exclude service in the command specifies a filter that excludes lines that contain the regular expression “service.” At the --More-- prompt, the user searches for the regular expression “Dialer1,” which continues filtered output with the first line that contains “Dialer1.” router# more nvram:startup-config | exclude service ! version 12.0 ! hostname router ! boot system flash no logging buffered ! ip subnet-zero ip domain-name cisco.com . . . --More-- /Dialer1 filtering... interface Dialer1 no ip address no ip directed-broadcast dialer in-band no cdp enable Related Commands Command Description more begin Begins unfiltered output of the more command with the first line that contains the regular expression you specify. more include Filters more command output so that it displays only lines that contain a particular regular expression. show begin Searches the output of any show command and displays the output from the first instance of a specified string. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show include Filters show command output so that it displays only lines that contain a particular regular expression. more include CF-385 Cisco IOS Configuration Fundamentals Command Reference April 2010 more include To filter more command output so that it displays only lines that contain a particular regular expression, use the more include command in EXEC mode. more url | include regular-expression Syntax Description Command Modes EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt: /regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z. Because prior output is not saved, you cannot search or filter backward through prior output. Examples The following is partial sample output of the more nvram:startup-config | include command. It only displays lines that contain the regular expression “ip.” router# more nvram:startup-config | include ip ip subnet-zero ip domain-name cisco.com ip name-server 198.92.30.32 ip name-server 171.69.2.132 description ip address 172.21.53.199 255.255.255.0 ip address 172.21.53.199 255.255.255.0 url The Universal Resource Locator (URL) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command. | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in more command output. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. Release Modification 11.3 AA The more command was introduced. 12.0(1)T This extension of the more command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. more include CF-386 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description more begin Begins unfiltered output of the more command with the first line that contains the regular expression you specify. more exclude Filters more command output so that it excludes lines that contain a particular regular expression. show begin Searches the output of any show command and displays the output from the first instance of a specified string. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show include Filters show command output so that it displays only lines that contain a particular regular expression. more flh:logfile CF-387 Cisco IOS Configuration Fundamentals Command Reference April 2010 more flh:logfile To view the system console output generated during the Flash load helper operation, use the more flh:logfile privileged EXEC command. more flh:logfile Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines If you are a remote Telnet user performing the Flash upgrade without a console connection, this command allows you to retrieve console output when your Telnet connection has terminated due to the switch to the ROM image. The output indicates what happened during the download, and is particularly useful if the download fails. This command is a form of the more command. See the more command for more information. Examples The following is sample output from the more flh:logfile command: Router# more flh:logfile %FLH: abc/igs-kf.914 from 172.16.1.111 to flash... System flash directory: File Length Name/status 1 2251320 abc/igs-kf.914 [2251384 bytes used, 1942920 available, 4194304 total] Accessing file 'abc/igs-kf.914' on 172.16.1.111... Loading from 172.16.13.111: Erasing device...... erased Loading from 172.16.13.111: - [OK - 2251320/4194304 bytes] Verifying checksum... OK (0x97FA) Flash copy took 79292 msecs %FLH: Re-booting system after download Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK] F3: 2183364+67924+259584 at 0x3000060 Restricted Rights Legend Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. more flh:logfile CF-388 Cisco IOS Configuration Fundamentals Command Reference April 2010 Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) of the Commercial Computer Software - Restricted Rights clause at FAR sec. 52.227-19 and subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at DFARS sec. 252.227-7013. cisco Systems, Inc. 170 West Tasman Drive San Jose, California 95134 Cisco Internetwork Operating System Software Cisco IOS (tm) GS Software (GS7), Version 11.0 Copyright (c) 1986-1995 by cisco Systems, Inc. Compiled Tue 06-Dec-94 14:01 by smith Image text-base: 0x00001000, data-base: 0x005A9C94 cisco 2500 (68030) processor (revision 0x00) with 4092K/2048K bytes of memory. Processor board serial number 00000000 DDN X.25 software, Version 2.0, NET2 and BFE compliant. ISDN software, Version 1.0. Bridging software. Enterprise software set supported. (0x0) 1 Ethernet/IEEE 802.3 interface. 2 Serial network interfaces. --More-- 1 ISDN Basic Rate interface. 32K bytes of non-volatile configuration memory. 4096K bytes of processor board System flash (Read ONLY) Related Commands Command Description more Displays a file. motd-banner CF-389 Cisco IOS Configuration Fundamentals Command Reference April 2010 motd-banner To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the motd-banner command in line configuration mode. To suppress the MOTD banners on the specified line or lines, use the no form of this command. motd-banner no motd-banner Syntax Description This command has no arguments or keywords. Defaults Enabled on all lines. Command Modes Line configuration Command History Usage Guidelines This command determines whether the router will display the MOTD banner when an EXEC session is created on the specified line or lines. The MOTD banner is defined with the banner motd global configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner on specific lines using the no motd-banner line configuration command. The MOTD banners can also be disabled by the no exec-banner line configuration command, which disables both MOTD banners and EXEC banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-banner command is enabled or disabled. Table 37 summarizes the effects of the exec-banner command and the motd-banner command. For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. Table 38 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 37 Banners Displayed Based On exec-banner and motd-banner Combinations exec-banner (default) no exec-banner motd-banner (default) MOTD banner EXEC banner None no motd-banner EXEC banner None motd-banner CF-390 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example suppresses the MOTD banner on vty lines 0 through 4: line vty 0 4 no motd-banner Related Commands Table 38 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet Sessions to Async Lines exec-banner (default) no exec-banner motd-banner (default) MOTD banner Incoming banner Incoming banner no motd-banner Incoming banner Incoming banner Command Description banner exec Defines and enables a customized banner to be displayed whenever the EXEC process is initiated. banner incoming Defines and enables a customized message to be displayed when there is an incoming connection to a terminal line from a host on the network. banner motd Defines and enables a customized message-of-the-day banner. motd-banner Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines. name-connection CF-391 Cisco IOS Configuration Fundamentals Command Reference April 2010 name-connection To assign a logical name to a connection, use the name-connection command in user EXEC mode. name-connection Syntax Description This command has no arguments or keywords. Defaults No logical name is defined. Command Modes User EXEC Command History Usage Guidelines This command can be useful for keeping track of multiple connections. You are prompted for the connection number and name to assign. The where command displays a list of the assigned logical connection names. Examples The following example assigns the logical name blue to the connection: Router> where Conn Host Address Byte Idle Conn Name * 1 doc-2509 172.30.162.131 0 0 doc-2509 Router> name-connection Connection number: 1 Enter logical name: blue Connection 1 to doc-2509 will be named "BLUE" [confirm] Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description where Lists open sessions associated with the current terminal line. no menu CF-392 Cisco IOS Configuration Fundamentals Command Reference April 2010 no menu To delete a user menu from the configuration file, use the no menu command in global configuration mode. no menu menu-name Syntax Description Defaults No default behavior or values. Command Modes Global configuration Command History Usage Guidelines Use this command to remove any menu commands for a particular menu from the configuration file. As with all global configuration commands, this command will only effect the startup configuration file when you save the running configuration using the copy running-config startup-config EXEC command. Examples The following example deletes the menu named Access1: no menu Access1 Related Commands menu-name Name of the menu to delete from the configuration file. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description menu (EXEC) Invokes a user menu. menu command Specifies underlying commands for user menus. menu prompt Specifies the prompt for a user menu. menu text Specifies the text of a menu item in a user menu. menu title Creates a title, or banner, for a user menu. notify CF-393 Cisco IOS Configuration Fundamentals Command Reference April 2010 notify To enable terminal notification about pending output from other Telnet connections, use the notify command in line configuration mode. To disable notifications, use the no form of this command. notify no notify Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Line configuration Command History Usage Guidelines This command sets a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one. Examples In the following example, notification of pending output from connections is enabled on virtual terminal lines 0 to 4: Router(config)# line vty 0 4 Router(config-line)# notify Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal notify Configures a line to inform a user that has multiple, concurrent Telnet connections when output is pending on a connection other than the current one. notify syslog CF-394 Cisco IOS Configuration Fundamentals Command Reference April 2010 notify syslog To enable the sending of notifications of configuration changes to a remote system message logging (syslog), use the notify syslog command in configuration change logger configuration mode. To disable the sending of notifications of configuration changes to the syslog, use the no form of this command. notify syslog [contenttype {plaintext | xml}] no notify syslog [contenttype {plaintext | xml}] Syntax Description Command Default Notifications are not sent to the syslog. Command Modes Configuration change logger configuration (config-archive-log-config) Command History Usage Guidelines Enable the notify syslog command if you use the syslog to monitor your router. Syslog monitoring prevents the need to gather configuration log information manually. Examples The following example shows how to enable the router to send notifications (in XML format) to the syslog: Router# configure terminal ! Router(config)# archive Router(config-archive)# log config Router(config-archive-log-config)# notify syslog contenttype xml Router(config-archive-log-config)# end contenttype (Optional) Allows you to choose a format for the configuration change messages that are sent via syslog. plaintext (Optional) Specifies that the configuration change messages are sent as plain text. xml (Optional) Specifies that the configuration change messages are sent in XML format. Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA The contenttype, plaintext, and xml keywords were added. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. notify syslog CF-395 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description archive Enters archive configuration mode. hidekeys Suppresses the display of password information in configuration log files. log config Enters configuration change logger configuration mode. logging enable Enables the logging of configuration changes. logging size Specifies the maximum number of entries retained in the configuration log. show archive log config Displays entries from the configuration log. padding CF-396 Cisco IOS Configuration Fundamentals Command Reference April 2010 padding To set the padding on a specific output character, use the padding command in line configuration mode. To remove padding for the specified output character, use the no form of this command. padding ascii-number count no padding ascii-number Syntax Description Defaults No padding Command Modes Line configuration Command History Usage Guidelines Use this command when the attached device is an old terminal that requires padding after certain characters (such as ones that scrolled or moved the carriage). See the “ASCII Character Set and Hex Values” appendix for a list of ASCII characters. Examples In the following example, the Return (decimal character 13) is padded with 25 NULL bytes on the console line: Router(config)# line console Router(config-line)# padding 13 25 Related Commands ascii-number ACII decimal representation of the character. count Number of NULL bytes sent after the specified character, up to 255 padding characters in length. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description terminal padding Changes the character padding on a specific output character for the current session. parity CF-397 Cisco IOS Configuration Fundamentals Command Reference April 2010 parity To define generation of a parity bit, use the parity command in line configuration mode. To specify no parity, use the no form of this command. parity {none | even | odd | space | mark} no parity Syntax Description Defaults No parity. Command Modes Line configuration Command History Usage Guidelines Communication protocols provided by devices such as terminals and modems sometimes require a specific parity bit setting. Refer to the documentation for your device to determine required parity settings. If you use this command to set parity on Cisco AS5350 and Cisco AS5400 NextPort lines, do not also set parity by means of S-register settings in a modemcap. (A modemcap is a series of parameter settings that are sent to your modem to configure it to interact with a Cisco device in a specified way. Cisco IOS software defines modemcaps that have been found to properly initialize most modems so that they function properly with Cisco routers and access servers.) Examples In the following example, even parity is configured for line 34: Router(config)# line 34 Router(config-line)# parity even none No parity. This is the default. even Even parity. odd Odd parity. space Space parity. mark Mark parity. Release Modification 10.0 This command was introduced. 12.4 This command was modified to enable parity setting on Cisco AS5350 and Cisco AS5400 NextPort lines. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. parity CF-398 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description terminal parity Defines the generation of the parity bit for the current for the current session and line. parser cache CF-399 Cisco IOS Configuration Fundamentals Command Reference April 2010 parser cache To reenable the Cisco IOS software parser cache after disabling it, use the parser cache command in global configuration mode. To disable the parser cache, use the no form of this command. parser cache no parser cache Syntax Description This command has no arguments or keywords. Defaults Parser cache is enabled by default. Command Modes Global configuration Command History Usage Guidelines The Parser Cache feature optimizes the parsing (translation and execution) of Cisco IOS software configuration command lines by remembering how to parse recently encountered command lines, decreasing the time required to process large configuration files. The parser cache is enabled by default. However, if you wish to disable the parser cache, you may do so using the no parser cache command in global configuration mode. To reenable the parser cache after it has been disabled, use the parser cache command. When the no parser cache is issued, the command line appears in the running configuration file. However, if the parser cache is reenabled, no command line appears in the running configuration file. Examples In the following example, the Cisco IOS software Parser Cache feature is disabled: Router(config)# no parser cache Related Commands Release Modification 12.1(5)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description clear parser cache Clears the parse cache entries and hit/miss statistics stored for the Parser Cache feature. show parser statistics Displays statistics about the last configuration file parsed and the status of the Parser Cache feature. parser command serializer CF-400 Cisco IOS Configuration Fundamentals Command Reference April 2010 parser command serializer To enable configuration access only to the users holding a configuration lock and to prevent other clients from accessing the running configuration, use the parser command serializer command in global configuration mode. To disable this configuration, use the no form of this command. parser command serializer no parser command serializer Syntax Description This command has no arguments or keywords. Command Default Access is granted only to the user holding the lock. Command Modes Global configuration (config) Command History Usage Guidelines The Parser Concurrency and Locking Improvements feature ensures that exclusive access is granted only to a requested process and prevents other users from concurrently accessing the Cisco IOS configuration. That is, it prevents simultaneous execution of two or more commands. Use the parser command serializer command to configure the Parser Concurrency and Locking Improvements feature. Examples The following example shows how to configure the Parser Concurrency and Locking Improvements feature: Router# configure terminal Router(config)# parser command serializer Related Commands Release Modification 12.2(33)SRE This command was introduced. Command Description configuration mode exclusive Enables single-user (exclusive) access functionality for the Cisco IOS CLI. configure terminal lock Locks the running configuration into exclusive configuration mode for the duration of your configuration session. test parser session-lock Tests the behavior of the Parser Concurrency and Locking Improvements feature. parser config cache interface CF-401 Cisco IOS Configuration Fundamentals Command Reference April 2010 parser config cache interface To reduce the time required for the command-line interpreter to execute commands that manage the running system configuration files, use the parser config cache interface command in global configuration mode. To disable the reduced command execution time functionality, use the no form of this command. parser config cache interface no parser config cache interface Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration (config) Command History Usage Guidelines Enable the parser config cache interface command to reduce the execution time required for running configuration management commands such as the show running-configuration, write terminal, and copy system:running-configuration commands. Information for these configuration management commands is supplied by nonvolatile generation (NVGEN) processes that query the system for configuration details. The parser config cache interface command is especially useful for managing large system configurations that contain numerous interface configurations. Once enabled, the command provides faster execution of the NVGEN commands that process the running system configuration by caching interface configurations in system memory, and by retrieving only configuration information that has changed. For this reason, the device on which this command is enabled must have enough memory available to store the interface configuration. For example, if the interface configurations take up 15 KB of memory, using this command would require having an additional 15 KB of memory space available. The first time you display the configuration file, you will not see much evidence of improvement in performance because the interface cache will be filled up. However, you will notice performance improvements when you enter subsequent NVGEN-type commands such as the show running-configuration EXEC command. Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRC This command was integrated into Cisco IOS Release 12.2(33)SRC. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. parser config cache interface CF-402 Cisco IOS Configuration Fundamentals Command Reference April 2010 Each time the interface configuration is changed, the interface cache is flushed. Entering an NVGEN-type command after modifying the interface configuration will once again not show any performance improvement until the next NVGEN-type command is entered. Examples The following example shows how to enable the functionality for reducing the time required for the command-line interpreter to execute commands that manage the running system configuration files: Router(config)# parser config cache interface Related Commands Command Description copy system:running-configuration Copies the running configuration to another destination. show running-configuration Displays the configuration currently running on the terminal. write terminal Displays the configuration currently running on the terminal. parser config partition CF-403 Cisco IOS Configuration Fundamentals Command Reference April 2010 parser config partition To enable configuration partitioning, use the parser config partition command. To disable the partitioning of the running configuration, use the no form of this command. parser config partition no parser config partition Syntax Description No arguments or keywords. Command Default This command is enabled by default. Command Modes Global configuration (config) Command History Usage Guidelines This command controls (enables or disables) the Configuration Partitioning feature. Note This command is not related to disk partitions or disk partitioning. To display the list of commands that make up the current running configuration for a specific part (“partition”) of the system’s global running configuration, use the show running-config partition command in privileged Exec mode. The Configuration Partitioning feature uses a small amount of system resources. The no parser config partition command allows you to disable this feature if the feature is not needed on your system. Note Only the no form of this command will appear in configuration files. To determine if config partitioning is supported on your system and whether it is enabled, use the show running-config parser ? command. Examples The following example shows how to disable partitioning of the system running configuration: Router> enable Router# config t Enter configuration commands, one per line. End with CNTL/Z. Release Modification 12.2(33)SRB This command was introduced as part of the Configuration Partitioning feature. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. parser config partition CF-404 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router(config)# no parser config partition System configured Related Commands Command Description show running-config partition Displays the list of commands that make up the current running configuration for a specific part of the system’s global running configuration. When used with the ? CLI help keyword, can also be used to determine the availability and status of the Configuration Partitioning feature. partition CF-405 Cisco IOS Configuration Fundamentals Command Reference April 2010 partition To separate Flash memory into partitions on Class B file system platforms, use the partition command in global configuration mode. To undo partitioning and to restore Flash memory to one partition, use the no form of this command. Cisco 1600 Series and Cisco 3600 Series Routers partition flash-filesystem: [number-of-partitions][partition-size] no partition flash-filesystem: All Other Class B Platforms partition flash partitions [size1 size2] no partition flash Syntax Description Defaults Flash memory consists of one partition. If the partition size is not specified, partitions of equal size are created. Command Modes Global configuration Command History flash-filesystem: One of the following Flash file systems, which must be followed by a colon (:). The Cisco 1600 series can only use the flash: keyword. • flash:—Internal Flash memory • slot0:—Flash memory card in PCMCIA slot 0 • slot1:—Flash memory card in PCMCIA slot 1 number-of-partitions (Optional) Number of partitions in Flash memory. partition-size (Optional) Size of each partition. The number of partition size entries must be equal to the number of specified partitions. partitions Number of partitions in Flash memory. Can be 1 or 2. size1 (Optional) Size of the first partition (in megabytes). size2 (Optional) Size of the second partition (in megabytes). Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. partition CF-406 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines For the Cisco 1600 series and Cisco 3600 series routers, to undo partitioning, use the partition flash-filesystem:1 or no partition flash-filesystem: command. For other Class B platforms, use either the partition flash 1 or no partition flash command. If there are files in a partition other than the first, you must use the erase flash-filesystem:partition-number command to erase the partition before reverting to a single partition. When creating two partitions, you must not truncate a file or cause a file to spill over into the second partition. Examples The following example creates two partitions of 4 MB each in Flash memory: Router(config)# partition flash 2 4 4 The following example divides the Flash memory card in slot 0 into two partitions, each 8 MB in size on a Cisco 3600 series router: Router(config)# partition slot0: 2 8 8 The following example creates four partitions of equal size in the card on a Cisco 1600 series router: Router(config)# partition flash: 4 path (archive configuration) CF-407 Cisco IOS Configuration Fundamentals Command Reference April 2010 path (archive configuration) To specify the location and filename prefix for the files in the Cisco IOS configuration archive, use the path command in archive configuration mode. To disable this function, use the no form of this command. path url no path url Syntax Description Command Default If this command is not configured, no location or filename prefix is specified for files in the Cisco IOS configuration archive. Command Modes Archive configuration (config-archive) Command History Usage Guidelines When this command is entered, an archive file of the running configuration is saved when the archive config, write-memory, or copy running-config startup-config command is entered. URLs are commonly used to specify files or location on the World Wide Web. On Cisco routers, URLs can be used to specify the location of a file or directory on a router or a remote file server. The path command uses a URL to specify the location and filename prefix for the Cisco IOS configuration archive. The locations or file systems that you can specify in the url argument are as follows: • If your platform has disk0—disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp: • If your platform does not have disk0—ftp:, http:, pram:, rcp:, or tftp: The colon is required in the location format. The filename of the first archive file is the filename specified in the url argument followed by -1. The filename of the second archive file is the filename specified in the url argument followed by -2 and so on. url URL (accessible by the Cisco IOS file system) used for saving archive files of the running configuration file in the Cisco IOS configuration archive. Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. path (archive configuration) CF-408 Cisco IOS Configuration Fundamentals Command Reference April 2010 Because some file systems are incapable of storing the date and time that a file was written, the filename of the archive file can contain the date, time, and router hostname. To include the router hostname in the archive file filename, enter the characters $h (for example, disk0:$h). To include the date and time in the archive file filename, enter the characters $t. When a configuration archive operation is attempted on a local file system, the file system is tested to determine if it is writable and if it has sufficient space to save an archive file. If the file system is read-only or if there is not enough space to save an archive file, an error message is displayed. If you specify the tftp: file server as the location with the path command, you need to create the configuration file on the TFTP file server and change the file’s privileges before the archive config command works properly. Examples The following example of the path command shows how to specify the hostname, date, and time as the filename prefix for which to save archive files of the running configuration. In this example, the time-period command is also configured to automatically save an archive file of the running configuration every 20 minutes. configure terminal ! archive path disk0:$h$t time-period 20 end The following is sample output from the show archive command illustrating the format of the resulting configuration archive filenames. Router# show archive There are currently 3 archive configurations saved. The next archive file will be named routerJan-16-01:12:23.019-4 Archive # Name 0 1 disk0:routerJan-16-00:12:23.019-1 2 disk0:routerJan-16-00:32:23.019-2 3 disk0:routerJan-16-00:52:23.019-3 <- Most Recent 4 5 6 7 8 9 10 11 12 13 14 Cisco IOS Configuration Archive on the TFTP File Server The following example shows how to use the path command to specify the TFTP file server, address 10.48.71.226, as the archive configuration location and router-cfg as the configuration filename. First you create the configuration file on the TFTP server and change the file’s privileges, then you can save the configuration file to the configuration archive. The following example shows the commands to use to create the file and change the file’s privileges on the TFTP server (UNIX commands): > touch router-cfg-1 path (archive configuration) CF-409 Cisco IOS Configuration Fundamentals Command Reference April 2010 > chmod 777 router-cfg-1 The following example show how to create the configuration archive, save the running configuration to the archive, and display the files in the archive: configure terminal ! archive path tftp://10.48.71.226/router-cfg exit exit ! archive config Router# show archive The next archive file will be named tftp://10.48.71.226/router-cfg-2 Archive # Name 0 1 tftp://10.48.71.226/router-cfg-1 <- Most Recent 2 3 4 5 6 7 8 9 10 11 12 13 14 The following is sample output from the show archive command if you did not create the configuration file on the TFTP server before attempting to archive the current running configuration file: configure terminal ! archive path tftp://10.48.71.226/router-cfg exit exit archive config Router# show archive The next archive file will be named tftp://10.48.71.226/router-cfg-1 Archive # Name 0 1 2 3 4 5 6 7 8 9 10 11 12 path (archive configuration) CF-410 Cisco IOS Configuration Fundamentals Command Reference April 2010 13 14 Related Commands Command Description archive Enters archive configuration mode. archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure confirm Confirms replacement of the current running configuration with a saved Cisco IOS configuration file. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. show archive Displays information about the files saved in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. periodic CF-411 Cisco IOS Configuration Fundamentals Command Reference April 2010 periodic To specify a recurring (weekly) time range for functions that support the time-range feature, use the periodic command in time-range configuration mode. To remove the time limitation, use the no form of this command. periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm no periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm Syntax Description Defaults No recurring time range is defined. Command Modes Time-range configuration (config-time-range) Command History Usage Guidelines For Cisco IOS Release 12.2(11)T, IP and Internetwork Packet Exchange (IPX) extended access lists are the only functions that can use time ranges. For further information on using these functions, refer to the Cisco IOS IP Configuration Guide and the Cisco IOS AppleTalk and Novell IPX Configuration Guide. days-of-the-week The first occurrence of this argument is the starting day or day of the week that the associated time range is in effect. The second occurrence is the ending day or day of the week the associated statement is in effect. This argument can be any single day or combinations of days: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday. Other possible values are: • daily—Monday through Sunday • weekdays—Monday through Friday • weekend—Saturday and Sunday If the ending days of the week are the same as the starting days of the week, they can be omitted. hh:mm The first occurrence of this argument is the starting hours:minutes that the associated time range is in effect. The second occurrence is the ending hours:minutes the associated statement is in effect. The hours:minutes are expressed in a 24-hour clock. For example, 8:00 is 8:00 a.m. and 20:00 is 8:00 p.m. to Entry of the to keyword is required to complete the range “from start-time to end-time.” Release Modification 12.0(1)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. periodic CF-412 Cisco IOS Configuration Fundamentals Command Reference April 2010 The periodic command is one way to specify when a time range is in effect. Another way is to specify an absolute time period with the absolute command. Use either of these commands after the time-range global configuration command, which specifies the name of the time range. Multiple periodic entries are allowed per time-range command. If the end days-of-the-week value is the same as the start value, they can be omitted. If a time-range command has both absolute and periodic values specified, then the periodic items are evaluated only after the absolute start time is reached, and are not further evaluated after the absolute end time is reached. Note All time specifications are taken as local time. To ensure that the time range entries take effect at the desired times, you should synchronize the system software clock using Network Time Protocol (NTP). Table 39 lists some typical settings for your convenience: Examples The following example configuration denies HTTP traffic on Monday through Friday from 8:00 a.m. to 6:00 p.m.: Router# show startup-config . . . time-range no-http periodic weekdays 8:00 to 18:00 ! ip access-list extended strict deny tcp any any eq http time-range no-http ! interface ethernet 0 ip access-group strict in . . . The following example configuration permits Telnet traffic on Mondays, Tuesdays, and Fridays from 9:00 a.m. to 5:00 p.m.: Router# show startup-config . . . Table 39 Typical Examples of periodic Command Syntax If you want: Configure this: Monday through Friday, 8:00 a.m. to 6:00 p.m. only periodic weekday 8:00 to 18:00 Every day of the week, from 8:00 a.m. to 6:00 p.m. only periodic daily 8:00 to 18:00 Every minute from Monday 8:00 a.m. to Friday 8:00 p.m. periodic monday 8:00 to friday 20:00 All weekend, from Saturday morning through Sunday night periodic weekend 00:00 to 23:59 Saturdays and Sundays, from noon to midnight periodic weekend 12:00 to 23:59 periodic CF-413 Cisco IOS Configuration Fundamentals Command Reference April 2010 time-range testing periodic Monday Tuesday Friday 9:00 to 17:00 ! ip access-list extended legal permit tcp any any eq telnet time-range testing ! interface ethernet 0 ip access-group legal in . . . Related Commands Command Description absolute Specifies an absolute start and end time for a time range. access-list (extended) Defines an extended IP access list. deny (IP) Sets conditions under which a packet does not pass a named IP access list. permit (IP) Sets conditions under which a packet passes a named IP access list. time-range Enables time-range configuration mode and names a time range definition. ping CF-414 Cisco IOS Configuration Fundamentals Command Reference April 2010 ping To diagnose basic network connectivity on AppleTalk, ATM, Connectionless Network Service (CLNS), DECnet, IP, Novell IPX, or source-route bridging (SRB) networks, use the ping command in user EXEC or privileged EXEC mode. ping [[protocol [tag] {host-name | system-address}] Syntax Description Command Default This command has no default values. Command Modes User EXEC (>) Privileged EXEC (#) Command History protocol (Optional) Protocol keyword, either appletalk, atm, clns, decnet, ipx, or srb. If a protocol is not specified, a basic ping will be sent using IP (IPv4). For extended options for ping over IP, see the documentation for the ping ip command. The ping atm interface atm, ping ip, ping ipv6, ping sna, and ping vrf commands are documented separately. tag (Optional) Specifies a tag encapsulated IP (tagIP) ping. host-name Hostname of the system to ping. If a host-name or system-address is not specified at the command line, it will be required in the ping system dialog. system-address Address of the system to ping. If a host-name or system-address is not specified at the command line, it will be required in the ping system dialog. Release Modification 10.0 This command was introduced. 12.0(7)T The ping sna command was introduced. 12.1(12c)E The ping vrf command was introduced. 12.2(2)T Support for the IPv6 protocol was added. 12.2(13)T The atm protocol keyword was added. The following keywords were removed because the Apollo Domain, Banyan VINES, and XNS protocols are no longer supported in Cisco IOS software: • apollo • vines • xns 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(25)SG This command was integrated into Cisco IOS Release 12.2(25)SG. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. ping CF-415 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines The ping command sends an echo request packet to an address then waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. For example, the ping clns command sends International Organization for Standardization (ISO) CLNS echo packets to test the reachability of a remote router over a connectionless Open System Interconnection (OSI) network. If you enter the ping command without any keywords or argument values, an interactive system dialog prompts you for the additional syntax appropriate to the protocol you specify. (See the “Examples” section.) To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The default escape sequence is Ctrl-^, X (Simultaneously press and release the Ctrl, Shift, and 6 keys and then press the X key). The escape sequence will vary depending on your line configuration. For example, another commonly used escape sequence is Ctrl-c. Table 40 describes the test characters sent by the ping facility. Note Not all protocols require hosts to support pings. For some protocols, the pings are Cisco defined and can be answered only by another Cisco router. The availability of protocol keywords depends on what protocols are enabled on your system. Issuing the ping command in user EXEC mode will generally offer fewer syntax options than issuing the ping command in privileged EXEC mode. Examples After you enter the ping command in privileged EXEC mode, the system prompts you for a protocol keyword. The default protocol is IP. If you enter a hostname or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address. The following example is sample dialog from the ping command using default values. The specific dialog varies somewhat from protocol to protocol. Router# ping Protocol [ip]: Table 40 ping Test Characters Character Description ! Each exclamation point indicates receipt of a reply. . Each period indicates that the network server timed out while waiting for a reply. U A destination unreachable error protocol data unit (PDU) was received. C A congestion experienced packet was received. I User interrupted test. M A destination unreachable error protocol data unit (PDU) was received (Type 3) MTU required but DF bit set (code 4) with the “Next-Hop MTU” set to a non-zero value. If the “Next-hop MTU“ is zero then ‘U’ is printed. ? Unknown packet type. & Packet lifetime exceeded. ping CF-416 Cisco IOS Configuration Fundamentals Command Reference April 2010 Target IP address: 192.168.7.27 Repeat count [5]: Datagram size [100]: Timeout in seconds [2]: Extended commands [n]: Sweep range of sizes [n]: Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds: !!!!! Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms Table 41 describes the significant fields shown in the display. The following example verifies connectivity to the neighboring ATM device for the ATM permanent virtual circuit (PVC) with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16: Router# ping Protocol [ip]:atm Table 41 ping Field Descriptions for IP Field Description Protocol [ip]: Prompt for a supported protocol. Default: ip. Target IP address: Prompt for the IP address or hostname of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here. Default: none. Repeat count [5]: Number of ping packets that will be sent to the destination address. Default: 5. Datagram size [100]: Size of the ping packet (in bytes). Default: 100 bytes. Timeout in seconds [2]: Timeout interval. Default: 2 (seconds). Extended commands [n]: Specifies whether a series of additional commands appears. Sweep range of sizes [n]: Allows you to vary the sizes of the echo packets being sent. This capability is useful for determining the minimum sizes of the maximum transmission units (MTUs) configured on the nodes along the path to the destination address. Packet fragmentation contributing to performance problems can then be reduced. !!!!! Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type. Success rate is 100 percent Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic. round-trip min/avg/max = 1/2/4 ms Round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds). ping CF-417 Cisco IOS Configuration Fundamentals Command Reference April 2010 ATM Interface:atm1/0 VPI value [0]: VCI value [1]:16 Loopback - End(0), Segment(1) [0]:1 Repeat Count [5]: Timeout [2]: Type escape sequence to abort. Sending 5, 53-byte segment OAM echoes, timeout is 2 seconds: !!!!! Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/1 ms Table 42 describes the default ping fields shown in the display. Related Commands Table 42 ping Field Descriptions for ATM Field Description Protocol [ip]: Prompt for a supported protocol. Default: ip. ATM Interface: Prompt for the ATM interface. VPI value [0]: Prompt for the virtual path identifier. Default: 0. VCI value [1]: Prompt for the virtual channel identifier. Default:1. Loopback - End(0), Segment(1) [0]: Prompt to specify end loopback, which verifies end-to-end PVC integrity, or segment loopback, which verifies PVC integrity to the neighboring ATM device. Default: segment loopback. Repeat Count [5]: Number of ping packets that will be sent to the destination address. Default: 5. Timeout [2]: Timeout interval. Default: 2 (seconds). !!!!! Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type. Success rate is 100 percent Percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic. round-trip min/avg/max = 1/1/1 ms Round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds). Command Description ping atm interface atm Tests the connectivity of a specific PVC. ping ip Tests network connectivity on IP networks. ping ipv6 Tests the connection to a remote host on the network using IPv6. ping sna Tests network integrity and timing characteristics over an SNA Switching network. ping vrf Tests the connection in the context of a specific VPN (VRF). ping (privileged) CF-418 Cisco IOS Configuration Fundamentals Command Reference April 2010 ping (privileged) To diagnose basic network connectivity on Apollo, AppleTalk, Connectionless Network Service (CLNS), DECnet, IP, Novell IPX, VINES, or XNS networks, use the ping command in privileged EXEC command mode. ping [hostname | system-address | [protocol | tag] {hostname | system-address}] [data [hex-data-pattern] | df-bit | repeat [repeat-count] | size [datagram-size] | source [source-address | async | bvi | ctunnel | dialer | ethernet | fastethernet | lex | loopback | multilink | null | port-channel | tunnel | vif | virtual-template | virtual-tokenring | xtagatm] | timeout [seconds] | validate] Syntax Description hostname (Optional) Hostname of the system to ping. system-address (Optional) Address of the system to ping. protocol (Optional) Protocol to use for the ping. Valid values are: apollo, appletalk, clns, decnet, ethernet, ip, ipv6, ipx, srb, vines, xns. tag (Optional) Specifies a tag encapsulated IP ping. data (Optional) Specifies the data pattern. hex-data-pattern (Optional) Hexidecimal value of the data in the range of 0 to FFFF. df-bit (Optional) Enables the “do not fragment” bit in the IP header. repeat (Optional) Specifies the number of times the ping should be sent. repeat-count (Optional) Integer in the range of 1 to 2147483647. The default is 5. size (Optional) Size, in bytes, of the ping datagram. datagram-size (Optional) Integer in the range of 40 to 18024. source (Optional) Device sending the ping source-address (Optional) Address or name of the device sending the ping. async (Optional) Asynchronous interface. bvi (Optional) Bridge-Group Virtual interface. ctunnel (Optional) CTunnel interface. dialer (Optional) Dialer interface. ethernet (Optional) Ethernet IEEE 802.3 interface. fastethernet (Optional) FastEthernet IEEE 802.3 interface. lex (Optional) Lex interface. loopback (Optional) Loopback interface. multilink (Optional) Multilink-group interface. null (Optional) Null interface. port-channel (Optional) Ethernet channel of interfaces. tunnel (Optional) Tunnel interface vif (Optional) Pragmatic General Multicast (PGM) host interface virtual-template (Optional) Virtual Template interface. virtual-tokenring (Optional) Virtual TokenRing. xtagatm (Optional) Extended Tag ATM interface. timeout (Optional) Specifies the timeout interval in seconds. ping (privileged) CF-419 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default A ping operation is not performed. Command Modes Privileged EXEC Command History Usage Guidelines The ping (packet internet groper) command tests the reachability of a remote router over a connectionless Open System Interconnection (OSI) network. The command sends ISO CLNS echo packets to an address and waits for a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. When you type the ping command, you are prompted to enter options before the ping command executes. The characters in brackets ([]) indicate default values. When you want to use a default value, press Enter on your keyboard. If you enter a hostname or system address when you enter the ping command, the default action is taken for the protocol type of that hostname or system address. The optional data, df-bit, repeat, size, source, timeout, and validate keywords can be used to prevent extended ping command output. You can use as many of these keywords as you need, and you can use them in any order after the hostname or system-address arguments. When you enter the ethernet protocol option, you will be prompted to enter MAC address and maintenance domain in addition to the information common across protocols. To terminate a ping session before it completes, type the escape sequence (Ctrl-^ X) by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys and then pressing the X key. Note Not all protocols require hosts to support pings. For some protocols, the pings are defined by Cisco and answered only by a Cisco router. Table 43 describes the test characters that the ping operation uses. ng seconds (Optional) Integer in the range of 0 to 3600. The default is 2. validate (Optional) Validates the reply data. Release Modification 10.0 This command was introduced. 12.0 The following keywords were added in Cisco IOS Release 12.0: data, df-bit, repeat, size, source, timeout, validate. 12.2(33)SRA The ethernet option for protocol was added in Cisco IOS Release 12.2(33)SRA. Table 43 ping Command Response Characters and Their Meanings Character Description ! Receipt of a reply. . Network server timed out while waiting for a reply. ping (privileged) CF-420 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows a ping command and output. The precise dialog varies from protocol to protocol, but all are similar to the ping session shown here using default values. Router# ping Protocol [ip]: Target IP address: 192.168.7.27 Repeat count [5]: Datagram size [100]: Timeout in seconds [2]: Extended commands [n]: Sweep range of sizes [n]: Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds: !!!! Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms The following example shows how to send a ping specifying the ethernet protocol option, MAC address, and maintenance domain and using the default values for the remaining parameters: Router# ping Protocol [ip]: ethernet Mac Address : aabb.cc00.0410 Maintenance Domain : DOMAIN_PROVIDER_L5_1 VLAN [0]: 2 Source MPID [1522]: Repeat Count [5]: Datagram Size [107]: Timeout in seconds [2]: Sweep range of sizes [n]: Type escape sequence to abort. Sending 5 Ethernet CFM loopback messages, timeout is 2 seconds: !!!!! Success rate is 100 percent (5/5), round-trip min/avg/max = 1/4/8 ms. Related Commands U Destination unreachable error protocol data unit (PDU) was received. C Congestion experienced packet was received. I User interrupted test. ? Unknown packet type. & Packet lifetime exceeded. Table 43 ping Command Response Characters and Their Meanings (continued) Character Description Command Description ping ethernet Sends Ethernet CFM loopback messages to a destination MAC address. ping (user) Tests the connection to a remote host on the network. ping vrf Tests the connection to a remote device in a VPN. ping ip CF-421 Cisco IOS Configuration Fundamentals Command Reference April 2010 ping ip To test network connectivity on IP networks, use the ping ip command in privileged EXEC mode. ping ip {host-name | ip-address} [data [hex-data-pattern] | df-bit | repeat [repeat-count] | size [datagram-size] [source {source-address | source-interface} ] [timeout seconds] [validate] [verbose] Syntax Description host-name Host name of the system to ping. system-address Address of the system to ping. data hex-data-pattern (Optional) Specifies the data pattern. Range is from 0 to FFFF. df-bit (Optional) Enables the “do-not-fragment” bit in the IP header. repeat repeat-count (Optional) Specifies the number of pings sent. The range is from 1 to 2147483647. The default is 5. size (Optional) Specifies the datagram size. Datagram size is the number of bytes in each ping. datagram-size (Optional) Range is from 40 to 18024. source (Optional) Specifies the source address or source interface. source-address (Optional) IP address to use as the source in the ping packets. source-interface (Optional) Name of the interface from which the ping should be sent, and the Interface ID (slot/port/number). Interface name keywords include the following: • async (Asynchronous Interface) • bvi (Bridge-Group Virtual Interface) • ctunnel • dialer • ethernet • fastEthernet • lex • loopback • multilink (Multilink-group interface) • null • port-channel (Ethernet channel of interfaces) • tunnel • vif (PGM Multicast Host interface) • virtual-template • virtual-tokenring • xtagatm (Extended Tag ATM interface) The availability of these keywords depends on your system hardware. timeout seconds (Optional) Specifies the timeout interval in seconds. The default is 2 seconds. Range is from 0 to 3600. ping ip CF-422 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes Privileged Exec Command History Usage Guidelines The ping command sends an echo request packet to an address, then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. To abnormally terminate a ping session, type the escape sequence—by default, Ctrl-^ X. You type the default by simultaneously pressing and releasing the Ctrl, Shift, and 6 keys, and then pressing the X key. Table 44 describes the test characters that the ping facility sends. Note Not all protocols require hosts to support pings. For some protocols, the pings are Cisco-defined and are only answered by another Cisco router. Examples After you enter the ping command in privileged mode, the system prompts you for a protocol keyword. The default protocol is IP. If you enter a host name or address on the same line as the ping command, the default action is taken as appropriate for the protocol type of that name or address. validate (Optional) Validates the reply data. verbose (Optional) Enables verbose output, which lists individual ICMP packets, as well as Echo Responses. Release Modification 10.0 This command was introduced. 12.0 The data, df-bit, repeat, size, source, timeout, and validate keywords were added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 44 ping Test Characters Character Description ! Each exclamation point indicates receipt of a reply. . Each period indicates that the network server timed out while waiting for a reply. U A destination unreachable error protocol data unit (PDU) was received. C A congestion experienced packet was received. I User interrupted test. ? Unknown packet type. & Packet lifetime exceeded. ping ip CF-423 Cisco IOS Configuration Fundamentals Command Reference April 2010 The optional data, df-bit, repeat, size, source, timeout, and validate keywords can be used to avoid extended ping command output. You can use as many of these keywords as you need, and you can use them in any order after the host-name or system-address arguments. Although the precise dialog varies somewhat from protocol to protocol, all are similar to the ping session using default values shown in the following output: Router# ping Protocol [ip]: Target IP address: 192.168.7.27 Repeat count [5]: Datagram size [100]: Timeout in seconds [2]: Extended commands [n]: Sweep range of sizes [n]: Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds: !!!!! Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms Table 45 describes the default ping fields shown in the display. Table 45 ping Field Descriptions Field Description Protocol [ip]: Prompts for a supported protocol. The default is IP. Target IP address: Prompts for the IP address or host name of the destination node you plan to ping. If you have specified a supported protocol other than IP, enter an appropriate address for that protocol here. The default is none. Repeat count [5]: Prompts for the number of ping packets that will be sent to the destination address. The default is 5 packets. Datagram size [100]: Prompts for the size of the ping packet (in bytes). The default is 100 bytes. Timeout in seconds [2]: Prompts for the timeout interval. The default is 2 seconds. Extended commands [n]: Specifies whether a series of additional commands appears. Sweep range of sizes [n]: Allows you to vary the sizes of the echo packets being sent. This capability is useful for determining the minimum sizes of the MTUs configured on the nodes along the path to the destination address. Packet fragmentation contributing to performance problems can then be reduced. !!!!! Each exclamation point (!) indicates receipt of a reply. A period (.) indicates that the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type. Success rate is 100 percent Indicates the percentage of packets successfully echoed back to the router. Anything less than 80 percent is usually considered problematic. round-trip min/avg/max = 1/2/4 ms Indicates the round-trip travel time intervals for the protocol echo packets, including minimum/average/maximum (in milliseconds). ping ip CF-424 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description ping ipv6 Tests the connection to a remote host on the network using IPv6. ping vrf Tests the connection in the context of a specific VPN (VRF). ping vrf CF-425 Cisco IOS Configuration Fundamentals Command Reference April 2010 ping vrf To test a connection in the context of a specific VPN connection, use the ping vrf command in user EXEC or privileged EXEC mode. ping vrf vrf-name [tag] [connection] target-address [connection-options] Syntax Description Command Default The default connection type for ping is IPv4. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines A VPN routing/forwarding (VRF) instance is used to identify a VPN. To check if a configured VRF is working, you can use the ping vrf command. When attempting to ping from a provider edge (PE) router to a customer edge (CE) router, or from a PE router to PE router, the standard ping command will not usually work. The ping vrf command allows you to ping the IP addresses of LAN interfaces on CE routers. If you are on a PE router, be sure to indicate the specific VRF (VPN) name, as shown in the “Examples” section. If all required information is not provided at the command line, the system will enter the interactive dialog (extended mode) for ping. vrf-name The name of the VPN (VRF context). tag (Optional) Specifies a tag encapsulated IP (tagIP) ping. connection (Optional) Connection options include atm, clns, decnet, ip, ipv6, ipx, sna, or srb. The default is ip. target-address The destination ID for the ping operation. Usually, this is the IPv4 address of the host. For example, the target for an IPv4 ping in a VRF context would be the IPv4 address or domain name of the target host. The target for an IPv6 ping in a VRF context would be the IPv6 prefix or domain name of the target host. • If the target address is not specified, the CLI will enter the interactive dialog for ping. connection-options (Optional) Each connection type may have its own set of connection options. For example, connection options for IPv4 include source, df-bit, and timeout. See the appropriate ping command documentation for details. Release Modification 12.1(12c)E, 12.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. ping vrf CF-426 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the target host in the domain 209.165.201.1 is pinged (using IP/ICMP) in the context of the “Customer_A” VPN connection. Router# ping vrf Customer_A 209.165.201.1 Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 209.165.201.1, timeout is 2 seconds: !!!!! Success rate is 100 percent (5/5), round-trip min/avg/max = 176/264/576 ms Pressing the Enter key before providing all of the required options will begin the interactive dialog for ping. In the following example, the interactive dialog is started after the “ip” protocol is specified, but no address is given: Router# ping vrf Customer_B ip Target IP address: 209.165.200.225 Repeat count [5]: Datagram size [100]: Timeout in seconds [2]: Extended commands [n]: y Source address or interface: Type of service [0]: Set DF bit in IP header? [no]: Validate reply data? [no]: Data pattern [0xABCD]: Loose, Strict, Record, Timestamp, Verbose[none]: Record Number of hops [ 9 ]: Loose, Strict, Record, Timestamp, Verbose[RV]: Sweep range of sizes [n]: Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 209.165.200.225, timeout is 2 seconds: Packet has IP options: Total option bytes= 39, padded length=40 Record route: <> (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) (0.0.0.0) . . . Success rate is 100 percent (5/5), round-trip min/avg/max = 4/4/4 ms The following example shows the various options for IP in the ping vrf command: Router# show parser dump exec | include ping vrf 1 ping vrf 1 ping vrf ip 1 ping vrf ip (interactive) 1 ping vrf ip 1 ping vrf ip source
1 ping vrf ip source 1 ping vrf ip repeat <1-2147483647> 1 ping vrf ip size Number 1 ping vrf ip df-bit 1 ping vrf ip validate 1 ping vrf ip data <0-65535> 1 ping vrf ip timeout <0-3600> ping vrf CF-427 Cisco IOS Configuration Fundamentals Command Reference April 2010 1 ping vrf ip verbose 1 ping vrf ip data <0-65535> 1 ping vrf ip timeout <0-3600> 1 ping vrf tag 1 ping vrf atm 1 ping vrf ipv6 1 ping vrf appletalk 1 ping vrf decnet 1 ping vrf clns 1 ping vrf ipx 1 ping vrf sna 1 ping vrf srb Related Commands Command Description ping Diagnoses basic network connectivity to a specific host. ping atm interface atm Tests the connectivity of a specific PVC. ping ip Tests the connection to a remote host on the network using IPv4. ping ipv6 Tests the connection to a remote host on the network using IPv6. ping sna Tests network integrity and timing characteristics over an SNA Switching network. platform shell CF-428 Cisco IOS Configuration Fundamentals Command Reference April 2010 platform shell To grant shell access and enter shell access grant configuration mode, use the platform shell command in global configuration mode. To disable this function, use the no form of this command. platform shell no platform shell Syntax Description This command has no arguments or keywords. Command Default This command is disabled. Command Modes Global configuration (config) Command History Usage Guidelines This command should be entered before using the request platform software system shell command. Examples The following example shows how to grant shell access: Router(config)# platform shell Router(config)# Related Commands Release Modification 12.2(33)XNC This command was introduced. Command Description request platform software system shell Requests platform shelll access. power enable CF-429 Cisco IOS Configuration Fundamentals Command Reference April 2010 power enable To turn on power for the modules, use the power enable command in global configuration mode. To power down a module, use the no form of this command. power enable module slot no power enable module slot Syntax Description Defaults Enabled Command Modes Global configuration Command History Usage Guidelines When you enter the no power enable module slot command to power down a module, the module’s configuration is not saved. When you enter the no power enable module slot command to power down an empty slot, the configuration is saved. The slot argument designates the module number. Valid values for slot depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13. Examples This example shows how to turn on the power for a module that was previously powered down: Router(config)# power enable module 5 Router(config)# This example shows how to power down a module: Router(config)# no power enable module 5 Router(config)# Related Commands module slot Specifies a module slot number; see the “Usage Guidelines” section for valid values. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(18)SXD This command was changed to allow you to disable power to empty slots. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show power Displays information about the power status. power redundancy-mode CF-430 Cisco IOS Configuration Fundamentals Command Reference April 2010 power redundancy-mode To set the power-supply redundancy mode, use the power redundancy-mode command in global configuration mode. power redundancy-mode {combined | redundant} Syntax Description Defaults redundant Command Modes Global configuration Command History Examples This example shows how to set the power supplies to the no-redundancy mode: Router(config)# power redundancy-mode combined Router(config)# This example shows how to set the power supplies to the redundancy mode: Router(config)# power redundancy-mode redundant Router(config)# Related Commands combined Specifies no redundancy (combine power-supply outputs). redundant Specifies redundancy (either power supply can operate the system). Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show power Displays information about the power status. printer CF-431 Cisco IOS Configuration Fundamentals Command Reference April 2010 printer To configure a printer and assign a server tty line (or lines) to it, use the printer command in global configuration mode. To disable printing on a tty line, use the no form of this command. printer printer-name {line number | rotary number} [newline-convert | formfeed] no printer Syntax Description Defaults No printers are defined by default. Command Modes Global configuration Command History Usage Guidelines This command enables you to configure a printer for operations and assign either a single tty line or a group of tty lines to it. To make multiple printers available through the same printer name, specify the number of a rotary group. In addition to configuring the printer with the printer command, you must modify the file /etc/printcap on your UNIX system to include the definition of the remote printer in the Cisco IOS software. Refer to the Cisco IOS Configuration Fundamentals Configuration Guide for additional information. Use the optional newline-convert keyword in UNIX environments that cannot handle single-character line terminators. This converts newline characters to a carriage-return, linefeed sequence. Use the formfeed keyword when using the line printer daemon (lpd) protocol to print and your system is unable to separate individual output jobs with a form feed (page eject). You can enter the newline-convert and formfeed keywords together and in any order. Examples In the following example a printer named printer1 is configured and output is assigned to tty line 4: Router(config)# printer printer1 line 4 printer-name Printer name. line number Assigns a tty line to the printer. rotary number Assigns a rotary group of tty lines to the printer. newline-convert (Optional) Converts newline (linefeed) characters to a two-character sequence “carriage-return, linefeed” (CR+LF). formfeed (Optional) Causes the Cisco IOS software to send a form-feed character (ASCII 0x0C) to the printer tty line immediately following each print job received from the network. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. printer CF-432 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description clear line Returns a terminal line to idle state. private CF-433 Cisco IOS Configuration Fundamentals Command Reference April 2010 private To save user EXEC command changes between terminal sessions, use the private command in line configuration mode. To restore the default condition, use the no form of this command. private no private Syntax Description This command has no arguments or keywords. Defaults User-set configuration options are cleared with the exit EXEC command or when the interval set with the exec-timeout line configuration command has passed. Command Modes Line configuration Command History Usage Guidelines This command ensures that the terminal parameters set by the user remain in effect between terminal sessions. This behavior is desirable for terminals in private offices. Examples In the following example, line 15 (in this example, vty 1) is configured to keep all user-supplied settings at system restarts: Router(config)# line 15 Router(config-line)# private Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description exec-timeout Sets the interval that the EXEC command interpreter waits until user input is detected. exit Exits any configuration mode, or closes an active terminal session and terminates the EXEC. privilege CF-434 Cisco IOS Configuration Fundamentals Command Reference April 2010 privilege To configure a new privilege level for users and associate commands with that privilege level, use the privilege command in global configuration mode. To reset the privilege level of the specified command or commands to the default and remove the privilege level configuration from the running configuration file, use the no form of this command. Note As of Cisco IOS Releases 12.3(6) and 12.3(6)T, the no form of the privilege command and the reset keyword perform the same functions. privilege mode [all] {level level | reset} command-string no privilege mode [all] {level level | reset} command-string Syntax Description Defaults User EXEC mode commands are privilege level 1. Privileged EXEC mode and configuration mode commands are privilege level 15. Command Modes Global configuration mode Configuration mode for the specified command. See Table 46 in the “Usage Guidelines” section for a list of options for this argument. all (Optional) Changes the privilege level for all the suboptions to the same level. level level Specifies the privilege level you are configuring for the specified command or commands. The level argument must be a number from 0 to 15. reset Resets the privilege level of the specified command or commands to the default and removes the privilege level configuration from the running configuration file. Note For Cisco IOS software releases earlier than Release 12.3(6) and Release 12.3(6)T, you use the no form of this command to reset the privilege level to the default. The default form of this command will still appear in the configuration file. To completely remove a privilege configuration, use the reset keyword. command-string Command associated with the specified privilege level. If the all keyword is used, specifies the command and subcommands associated with the privilege level. privilege CF-435 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines The password for a privilege level defined using the privilege global configuration command is configured using the enable secret command. Level 0 can be used to specify a more-limited subset of commands for specific users or lines. For example, you can allow user “guest” to use only the show users and exit commands. Note There are five commands associated with privilege level 0: disable, enable, exit, help, and logout. If you configure AAA authorization for a privilege level greater than 0, these five commands will not be included. When you set the privilege level for a command with multiple words, note that the commands starting with the first word will also have the specified access level. For example, if you set the show ip route command to level 15, the show commands and show ip commands are automatically set to privilege level 15—unless you set them individually to different levels. This is necessary because you can’t execute, for example, the show ip command unless you have access to show commands. To change the privilege level of a group of commands, use the all keyword. When you set a group of commands to a privilege level using the all keyword, all commands which match the beginning string are enabled for that level, and all commands which are available in submodes of that command are enabled for that level. For example, if you set the show ip keywords to level 5, show and ip will be changed to level 5 and all the options that follow the show ip string (such as show ip accounting, show ip aliases, show ip bgp, and so on) will be available at privilege level 5. Table 46 shows some of the keyword options for the mode argument in the privilege command. The available mode keywords will vary depending on your hardware and software version. To see a list of available mode options on your system, use the privilege ? command. . Release Modification 10.3 This command was introduced. 12.0(22)S, 12.2(13)T The all keyword was added. 12.3(6), 12.3(6)T The no form of the command performs the same function as the reset keyword. 12.2(33)SRA This command was integrated into Cisco IOS release 12.(33)SRA. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. 12.2(33)SRE This command was integrated into Cisco IOS release 12.(33)SRE. Table 46 mode Argument Options Command Description accept-dialin VPDN group accept dialin configuration mode accept-dialout VPDN group accept dialout configuration mode address-family Address Family configuration mode alps-ascu ALPS ASCU configuration mode alps-circuit ALPS circuit configuration mode atm-bm-config ATM bundle member configuration mode privilege CF-436 Cisco IOS Configuration Fundamentals Command Reference April 2010 atm-bundle-config ATM bundle configuration mode atm-vc-config ATM virtual circuit configuration mode atmsig_e164_table_mode ATMSIG E164 Table cascustom Channel-associated signalling (cas) custom configuration mode config-rtr-http RTR HTTP raw request Configuration configure Global configuration mode controller Controller configuration mode crypto-map Crypto map config mode crypto-transform Crypto transform config modeCrypto transform configuration mode dhcp DHCP pool configuration mode dspfarm DSP farm configuration mode exec Exec mode flow-cache Flow aggregation cache configuration mode gateway Gateway configuration mode interface Interface configuration mode interface-dlci Frame Relay DLCI configuration mode ipenacl IP named extended access-list configuration mode ipsnacl IP named simple access-list configuration mode ip-vrf Configure IP VRF parameters lane ATM Lan Emulation Lecs Configuration Table line Line configuration mode map-class Map class configuration mode map-list Map list configuration mode mpoa-client MPOA Client mpoa-server MPOA Server null-interface Null interface configuration mode preaut AAA Preauth definitions request-dialin VPDN group request dialin configuration mode request-dialout VPDN group request dialout configuration mode route-map Route map configuration mode router Router configuration mode rsvp_policy_local rtr RTR Entry Configuration sg-radius RADIUS server group definition sg-tacacs+ TACACS+ server group Table 46 mode Argument Options (continued) Command Description privilege CF-437 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to set the configure command to privilege level 14 and establish SecretPswd14 as the password users must enter to use level 14 commands: privilege exec level 14 configure enable secret level 14 SecretPswd14 The following example shows how to set the show and ip keywords to level 5. The suboptions coming under ip will also be allowed to users with privilege level 5 access: Router(config)# privilege exec all level 5 show ip The following two examples demonstate the difference in behavior between the no form of the command and the use of the reset keyword when using Cisco IOS software releases earlier than Releases 12.3(6) and Release 12.3(6)T. Note As of Cisco IOS Releases 12.3(6) and 12.3(6)T, the no form of the privilege command and the reset keyword perform the same functions. ! show currently configured privilege commands Router# show running-config | include priv privilege configure all level 3 interface privilege exec level 3 configure terminal privilege exec level 3 configure Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# no privilege exec level 3 configure terminal Router(config)# end ! show currently configured privilege commands Router# show running-config | include priv privilege configure all level 3 interface privilege exec level 15 configure terminal privilege exec level 15 configure sip-ua SIP UA configuration mode subscriber-policy Subscriber policy configuration mode tcl Tcl mode tdm-conn TDM connection configuration mode template Template configuration mode translation-rule Translation Rule configuration mode vc-class VC class configuration mode voiceclass Voice Class configuration mode voiceport Voice configuration mode voipdialpeer Dial Peer configuration mode vpdn-group VPDN group configuration mode Table 46 mode Argument Options (continued) Command Description privilege CF-438 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note that in the show running-config output above, the privilege command for “configure terminal” still appears, but now has the default privilege level assigned. To remove a previously configured privilege command entirely from the configuration, use the reset keyword, as shown in the following example: ! show currently configured privilege commands Router# show running-config | include priv privilege configure all level 3 interface privilege exec level 3 configure terminal privilege exec level 3 configure Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# privilege exec reset configure terminal Router(config)# Router# show running-config | include priv privilege configure all level 3 interface Router# Related Commands Command Description enable password Sets a local password to control access to various privilege levels. enable secret Specifies an additional layer of security over the enable password command. privilege level Sets the default privilege level for a line. process cpu statistics limit entry-percentage CF-439 Cisco IOS Configuration Fundamentals Command Reference April 2010 process cpu statistics limit entry-percentage To set the process entry limit and the size of the history table for CPU utilization statistics, use the process cpu statistics limit entry-percentage command in global configuration mode. To disable CPU utilization statistics, use the no form of this command. process cpu statistics limit entry-percentage number [size seconds] no process cpu statistics limit entry-percentage Syntax Description Command Default size seconds: 600 seconds Command Modes Global configuration Command History Usage Guidelines Use the process cpu statistics limit entry-percentage command to set the entry limit and size of CPU utilization statistics. Examples The following example shows how to set an entry limit at 40 percent and a size of 300 seconds: configure terminal ! process cpu statistics limit entry-percentage 40 size 300 end Related Commands number Integer from 1 to 100 that indicates the percentage of CPU utilization that a process must use to become part of the history table. size seconds (Optional) Changes the duration of time in seconds for which CPU statistics are stored in the history table. Valid values are 5 to 86400. The default is 600. Release Modification 12.0(26)S This command was introduced. 12.3(4)T This command was integrated into Cisco IOS Release 12.3(4)T. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. Command Description process cpu threshold type Defines CPU usage thresholds that, when crossed, cause a CPU threshold notification. snmp-server enable traps cpu Enables CPU threshold violations traps. snmp-server host Specifies the recipient of SNMP notifications. process cpu threshold type CF-440 Cisco IOS Configuration Fundamentals Command Reference April 2010 process cpu threshold type To set CPU thresholding notification types and values, use the process cpu threshold type command in global configuration mode. To disable CPU thresholding notifications, use the no form of this command. process cpu threshold type {total | process | interrupt} rising percentage interval seconds [falling fall-percentage interval seconds] no process cpu threshold type {total | process | interrupt} Syntax Description Command Default CPU thresholding notifications are disabled. Command Modes Global configuration Command History Usage Guidelines This command defines CPU usage thresholds that, when crossed, cause a CPU thresholding notification. When this command is enabled, Cisco IOS software polls the system at the configured interval. Notification occurs in two situations: • When a configured CPU usage threshold is exceeded (rising percentage) • When CPU usage falls below the configured threshold (falling fall-percentage) total Sets the CPU threshold type to total CPU utilization. process Sets the CPU threshold type to CPU process utilization. interrupt Sets the CPU threshold type to CPU interrupt utilization. rising percentage The percentage (1 to 100) of CPU resources that, when exceeded for the configured interval, triggers a CPU thresholding notification. interval seconds The duration of the CPU threshold violation, in seconds (5 to 86400), that must be met to trigger a CPU thresholding notification. falling fall-percentage (Optional) The percentage (1 to 100) of CPU resources that, when usage falls below this level for the configured interval, triggers a CPU thresholding notification. • This value must be equal to or less than the rising percentage value. • If not specified, the falling fall-percentage value is set to the same value as the rising percentage value. Release Modification 12.0(26)S This command was introduced. 12.3(4)T This command was integrated into Cisco IOS Release 12.3(4)T. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. process cpu threshold type CF-441 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to set the total CPU utilization notification threshold at 80 percent for a rising threshold notification and 20 percent for a falling threshold notification, with a 5-second polling interval: configure terminal ! process cpu threshold type total rising 80 interval 5 falling 20 interval 5 end Related Commands Command Description process cpu statistics limit entry Sets the entry limit and size of CPU utilization statistics. snmp-server enable traps cpu Enables CPU threshold violations traps. snmp-server host Specifies the recipient of SNMP notifications. process-max-time CF-442 Cisco IOS Configuration Fundamentals Command Reference April 2010 process-max-time To configure the amount of time after which a process should voluntarily yield to another process, use the process-max-time command in global configuration mode. To reset this value to the system default, use the no form of this command. process-max-time milliseconds no process-max-time milliseconds Syntax Description Defaults The default maximum process time is 200 milliseconds. Command Modes Global configuration Command History Usage Guidelines Lowering the maximum time a process can run is useful in some circumstances to ensure equitable division of CPU time among different tasks. Only use this command if recommended to do so by the Cisco Technical Assistance Center (TAC). Examples The following example limits the duration that a process will run to 100 milliseconds: Router(config)# process-max-time 100 milliseconds Maximum duration (in milliseconds) that a process can run before suspension. The range is from 20to 200 milliseconds. Release Modification 12.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. prompt CF-443 Cisco IOS Configuration Fundamentals Command Reference April 2010 prompt To customize the CLI prompt, use the prompt command in global configuration mode. To revert to the default prompt, use the no form of this command. prompt string no prompt [string] Syntax Description Defaults The default prompt is either Router or the name defined with the hostname global configuration command, followed by an angle bracket (>) for user EXEC mode or a pound sign (#) for privileged EXEC mode. Command Modes Global configuration Command History Usage Guidelines You can include customized variables when specifying the prompt. All prompt variables are preceded by a percent sign (%). Table 47 lists the available prompt variables. Issuing the prompt %h command has the same effect as issuing the no prompt command. string Text that will be displayed on screen as the CLI prompt, including any desired prompt variables. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 47 Custom Prompt Variables Prompt Variable Interpretation %h Host name. This is either Router or the name defined with the hostname global configuration command. %n Physical terminal line (tty) number of the EXEC user. %p Prompt character itself. It is either an angle bracket (>) for user EXEC mode or a pound sign (#) for privileged EXEC mode. %s Space. %t Tab. %% Percent sign (%) prompt CF-444 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example changes the EXEC prompt to include the tty number, followed by the name and a space: Router(config)# prompt TTY%n@%h%s%p The following are examples of user and privileged EXEC prompts that result from the previous command: TTY17@Router1 > enable TTY17@Router1 # Related Commands Command Description hostname Specifies or modifies the host name for the network server. pwd CF-445 Cisco IOS Configuration Fundamentals Command Reference April 2010 pwd To show the current setting of the cd command, use the pwd command in EXEC mode. pwd Syntax Description This command has no arguments or keywords. Command Modes User EXEC Priviledged EXEC Command History Usage Guidelines Use the pwd command to show which directory or file system is specified as the default by the cd command. For all EXEC commands that have an optional filesystem argument, the system uses the file system specified by the cd command when you omit the optional filesystem argument. For example, the dir command contains an optional filesystem argument and displays a list of files on a particular file system. When you omit this filesystem argument, the system shows a list of the files on the file system specified by the cd command. Examples The following example shows that the present working file system specified by the cd command is slot 0: Router> pwd slot0:/ The following example uses the cd command to change the present file system to slot 1 and then uses the pwd command to display that present working file system: Router> cd slot1: Router> pwd slot1:/ Related Commands Release Modification 11.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description cd Changes the default directory or file system. dir Displays a list of files on a file system. refuse-message CF-446 Cisco IOS Configuration Fundamentals Command Reference April 2010 refuse-message To define and enable a line-in-use message, use the refuse-message command in line configuration mode. To disable the message, use the no form of this command. refuse-message d message d no refuse-message Syntax Description Defaults Disabled (no line-in-use message is displayed). Command Modes Line configuration Command History Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter one or more lines of text, terminating the message with the second occurrence of the delimiting character. You cannot use the delimiting character within the text of the message. When you define a message using this command, the Cisco IOS software performs the following steps: 1. Accepts the connection. 2. Prints the custom message. 3. Clears the connection. Examples In the following example, line 5 is configured with a line-in-use message, and the user is instructed to try again later: line 5 refuse-message /The dial-out modem is currently in use. Please try again later./ d Delimiting character of your choice—a pound sign (#), for example. You cannot use the delimiting character in the message. message Message text. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. reload CF-447 Cisco IOS Configuration Fundamentals Command Reference April 2010 reload To reload the operating system, use the reload command in privileged EXEC or diagnostic mode. reload [/verify | /noverify] [line | in [hhh:mm | mmm [text]] | at hh:mm [text] | reason [reason string] | cancel] Syntax Description Command Modes Privileged EXEC (#) Diagnostic (diag) Command History /verify (Optional) Verifies the digital signature of the file that will be loaded onto the operating system. /noverify (Optional) Does not verify the digital signature of the file that will be loaded onto the operating system. Note This keyword is often issued if the file verify auto command is enabled, which automatically verifies the digital signature of all images that are copied. line (Optional) Reason for reloading; the string can be from 1 to 255 characters long. in hhh:mm | mmm (Optional) Schedules a reload of the software to take effect in the specified minutes or hours and minutes. The reload must take place within approximately 24 days. text (Optional) Reason for reloading; the string can be from 1 to 255 characters long. at hh:mm (Optional) Schedules a reload of the software to take place at the specified time (using a 24-hour clock). If you specify the month and day, the reload is scheduled to take place at the specified time and date. If you do not specify the month and day, the reload takes place at the specified time on the current day (if the specified time is later than the current time) or on the next day (if the specified time is earlier than the current time). Specifying 00:00 schedules the reload for midnight. The reload must take place within 24 days. day (Optional) Number of the day in the range from 1 to 31. reason reason string (Optional) Used to specify a reason for reloading. cancel (Optional) Cancels a scheduled reload. Release Modification 10.0 This command was introduced. 12.2(14)SX Support for this command was added for the Supervisor Engine 720. 12.3(2)T The warm keyword was added. 12.2(18)S This command was integrated into Cisco IOS Release 12.2(18)S. The /verify and /noverify keywords were added. 12.2(20)S Support was added for the Cisco 7304 router. The Cisco 7500 series router in not supported in Cisco IOS Release 12.2(20)S. 12.0(26)S The /verify and /noverify keywords were integrated into Cisco IOS Release 12.0(26)S. reload CF-448 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines The reload command halts the system. If the system is set to restart on error, it reboots itself. Use the reload command after configuration information is entered into a file and saved to the startup configuration. You cannot reload from a virtual terminal if the system is not set up for automatic booting. This restriction prevents the system from using an image stored in the ROM monitor and taking the system out of the remote user’s control. If you modify your configuration file, the system prompts you to save the configuration. During a save operation, the system prompts whether you want to proceed with the save if the CONFIG_FILE variable points to a startup configuration file that no longer exists. If you respond “yes” in this situation, the system enters setup mode upon reload. When you schedule a reload to occur at a later time (using the in keyword), it must take place within 24 days. The at keyword can be used only if the system clock has been set on the router (either through Network Time Protocol [NTP], the hardware calendar, or manually). The time is relative to the configured time zone on the router. To schedule reloads across several routers to occur simultaneously, synchronize the time on each router with NTP. When you specify the reload time using the at keyword, if you specify the month and day, the reload takes place at the specified time and date. If you do not specify the month and day, the reload takes place at the specified time on the current day (if the specified time is later than the current time), or on the next day (if the specified time is earlier than the current time). Specifying 00:00 schedules the reload for midnight. The reload must take place within 24 days. To display information about a scheduled reload, use the show reload command. The /verify and /noverify Keywords If the /verify keyword is specified, the integrity of the image will be verified before it is reloaded onto a router. If verification fails, the image reload will not occur. Image verification is important because it assures the user that the image is protected from accidental corruption, which can occur at any time during transit, starting from the moment the files are generated by Cisco until they reach the user. The /noverify keyword overrides any global automatic image verification that may be enabled via the file verify auto command. 12.3(4)T The /verify and /noverify keywords were integrated into Cisco IOS Release 12.3(4)T. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.3(11)T The file keyword and url argument were added. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 15.0(1)M The reason keyword and reason string argument were added. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Router and was made available in diagnostic mode. Release Modification reload CF-449 Cisco IOS Configuration Fundamentals Command Reference April 2010 The warm Keyword If you issue the reload command after you have configured the warm-reboot global configuration command, a cold reboot will occur. Thus, if you want to reload your system, but do not want to override the warm reboot functionality, you should specify the warm keyword with the reload command. The warm reboot functionality allows a Cisco IOS image to reload without ROM monitor intervention. That is, read-write data is saved in RAM during a cold startup and restored during a warm reboot. Warm rebooting allows the router to reboot quicker than conventional rebooting (where control is transferred to ROM monitor and back to the image) because nothing is copied from flash to RAM. Examples The following example shows how to immediately reload the software on the router: Router# reload The following example shows how to reload the software on the router in 10 minutes: Router# reload in 10 Router# Reload scheduled for 11:57:08 PDT Fri Apr 21 1996 (in 10 minutes) Proceed with reload? [confirm] The following example shows how to reload the software on the router at 1:00 p.m. today: Router# reload at 13:00 Router# Reload scheduled for 13:00:00 PDT Fri Apr 21 1996 (in 1 hour and 2 minutes) Proceed with reload? [confirm] The following example shows how to reload the software on the router on April 21 at 2:00 a.m.: Router# reload at 02:00 apr 21 Router# Reload scheduled for 02:00:00 PDT Sat Apr 21 1996 (in 38 hours and 9 minutes) Proceed with reload? [confirm] The following example shows how to cancel a pending reload: Router# reload cancel %Reload cancelled. The following example shows how to perform a warm reboot at 4:00 today: Router# reload warm at 4:00 The following example shows how to specify a reason for the reload: Router# reload reason reason string The following example shows how to specify image verification via the /verify keyword before reloading an image onto the router: Router# reload /verify Verifying file integrity of bootflash:c7200-kboot-mz.121-8a.E %ERROR:Signature not found in file bootflash:c7200-kboot-mz.121-8a.E. Signature not present. Proceed with verify? [confirm] Verifying file disk0:c7200-js-mz .......................................................................... ............................................................Done! Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCD reload CF-450 Cisco IOS Configuration Fundamentals Command Reference April 2010 Computed Hash MD5 :CFA258948C4ECE52085DCF428A426DCD CCO Hash MD5 :44A7B9BDDD9638128C35528466318183 Signature Verified Proceed with reload? [confirm]n Related Commands Command Description copy system:running-config nvram:startup-config Copies any file from a source to a destination. file verify auto Enables automatic image verification. show reload Displays the reload status on the router. warm-reboot Enables router reloading with reading images from storage. remote command CF-451 Cisco IOS Configuration Fundamentals Command Reference April 2010 remote command To execute a Cisco 7600 series router command directly on the switch console or a specified module without having to log into the Cisco 7600 series router first, use the remote command command in privileged EXEC mode. remote command {module num | standby-rp | switch} command Syntax Description Defaults This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines The module num keyword and argument designate the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values are from 1 to 13. The module num keyword and argument are supported on DFC-equipped modules and the standby supervisor engine only. When you execute the remote command switch command, the prompt changes to Switch-sp#. This command is supported on DFC-equipped modules and the supervisor engine only. This command does not support command completion, but you can use shortened forms of the command (for example, entering sh for show). Examples This example shows how to execute the show calendar command from the standby route processor: Router# remote command standby-rp show calendar Switch-sp# 09:52:50 UTC Mon Nov 12 2001 Router# module num Specifies the module to access; see the “Usage Guidelines” section for valid values. standby-rp Specifies the standby route processor. switch Specifies the active switch processor. command Command to be executed. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(18)SXD The standby-rp keyword was added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. remote command CF-452 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description remote login Accesses the Cisco 7600 series router console or a specific module. remote login CF-453 Cisco IOS Configuration Fundamentals Command Reference April 2010 remote login To access the Cisco 7600 series router console or a specific module, use the remote login command in privileged EXEC mode. remote login {module num | standby-rp | switch} Syntax Description Defaults This command has no default settings. Command Modes Privileged EXEC Command History Usage Guidelines Caution When you enter the attach or remote login command to access another console from your switch, if you enter global or interface configuration mode commands, the switch might reset. The module num keyword and argument designate the module number. Valid values depend on the chassis that is used. For example, if you have a 13-slot chassis, valid values are from 1 to 13. The module num keyword and argument are supported on DFC-equipped modules and the standby supervisor engine only. When you execute the remote login module num command, the prompt changes to Router-dfcx# or Switch-sp#, depending on the type of module to which you are connecting. When you execute the remote login standby-rp command, the prompt changes to Router-sdby#. When you execute the remote login switch command, the prompt changes to Switch-sp#. The remote login module num command is identical to the attach command. There are two ways to end the session: • You can enter the exit command as follows: Switch-sp# exit module num Specifies the module to access; see the “Usage Guidelines” section for valid values. standby-rp Specifies the standby route processor. switch Specifies the active switch processor. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(18)SXD This command was changed to include the standby-rp keyword. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. remote login CF-454 Cisco IOS Configuration Fundamentals Command Reference April 2010 [Connection to Switch closed by foreign host] Router# • You can press Ctrl-C three times as follows: Switch-sp# ^C Switch-sp# ^C Switch-sp# ^C Terminate remote login session? [confirm] y [Connection to Switch closed by local host] Router# Examples This example shows how to perform a remote login to a specific module: Router# remote login module 1 Trying Switch ... Entering CONSOLE for Switch Type "^C^C^C" to end this session Switch-sp# This example shows how to perform a remote login to the Cisco 7600 series router processor: Router# remote login switch Trying Switch ... Entering CONSOLE for Switch Type "^C^C^C" to end this session Switch-sp# This example shows how to perform a remote login to the standby route processor: Router# remote login standby-rp Trying Switch ... Entering CONSOLE for Switch Type "^C^C^C" to end this session Router-sdby# Related Commands Command Description attach Connects to a specific module from a remote location. remote-span CF-455 Cisco IOS Configuration Fundamentals Command Reference April 2010 remote-span To configure a virtual local area network (VLAN) as a remote switched port analyzer (RSPAN) VLAN, use the remote-span command in config-VLAN mode. To remove the RSPAN designation, use the no form of this command. remote-span no remote-span Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes Config-VLAN mode Command History Usage Guidelines This command is not supported in the VLAN database mode. You can enter the show vlan remote-span command to display the RSPAN VLANs in the Cisco 7600 series router. Examples This example shows how to configure a VLAN as an RSPAN VLAN: Router(config-vlan)# remote-span Router(config-vlan) This example shows how to remove the RSPAN designation: Router(config-vlan)# no remote-span Router(config-vlan) Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Connect Description show vlan remote-span Displays a list of RSPAN VLANs. rename CF-456 Cisco IOS Configuration Fundamentals Command Reference April 2010 rename To rename a file in a Class C Flash file system, use the rename command in EXEC, privileged EXEC, or diagnostic mode. rename url1 url2 Syntax Description Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command is valid only on Class C Flash file systems. Examples In the following example, the file named Karen.1 is renamed test: Router# dir Directory of disk0:/Karen.dir/ 0 -rw- 0 Jan 21 1998 09:51:29 Karen.1 0 -rw- 0 Jan 21 1998 09:51:29 Karen.2 0 -rw- 0 Jan 21 1998 09:51:29 Karen.3 0 -rw- 0 Jan 21 1998 09:51:31 Karen.4 243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur 340492288 bytes total (328400896 bytes free) Router# rename disk0:Karen.dir/Karen.1 disk0:Karen.dir/test Router# dir Directory of disk0:/Karen.dir/ 0 -rw- 0 Jan 21 1998 09:51:29 Karen.2 0 -rw- 0 Jan 21 1998 09:51:29 Karen.3 0 -rw- 0 Jan 21 1998 09:51:31 Karen.4 243 -rw- 165 Jan 21 1998 09:53:17 Karen.cur 0 -rw- 0 Apr 24 1998 09:49:19 test 340492288 bytes total (328384512 bytes free) url1 The original path and filename. url2 The new path and filename. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR 1000 Series Router and was made available in diagnostic mode. request platform software package describe file CF-457 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package describe file To gather descriptive information about an individual module or a Cisco IOS-XE image file, use the request platform software package describe file command in privileged EXEC or diagnostic mode. request platform software package describe file URL [detail] [verbose] Syntax Description Command Default No default behavior or values. Command Modes Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command can only be used to gather information on individual module and Cisco IOS-XE image files. Using this command to collect information on any other file will generate output, but the generated output is useless. The output of this command can be used for the following functions: • To confirm the individual module files that are part of a Cisco IOS-XE image. • To confirm whether or not a file is bootable. • To confirm the contexts in which a file must be reloaded or booted. • To confirm whether or not a file is corrupted. • To confirm file and header sizes, build dates, and various other general information. Examples In the following example, this command is entered to gather information about an individual SIP Base module file on the bootflash: file system. Router# request platform software package describe file bootflash:asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Package: asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 36954316 Timestamp: 2007-12-05 15:36:27 UTC Canonical path: /bootflash/asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg URL Specifies the URL to the file. The URL contains the file system, directories, and the filename. detail Specifies detailed output. verbose Displays verbose information, meaning all information that can be displayed on the console about the file will be displayed. Release Modification IOS XE Release 2.1 This command was introduced. request platform software package describe file CF-458 Cisco IOS Configuration Fundamentals Command Reference April 2010 Raw disk-file SHA1sum: 3ee37cdbe276316968866b16df7d8a5733a1502e Computed SHA1sum: f2db80416a1245a5b1abf2988088860b38ce7898 Contained SHA1sum: f2db80416a1245a5b1abf2988088860b38ce7898 Hashes match. Package is valid. Header size: 204 bytes Package type: 10000 Package flags: 0 Header version: 0 Internal package information: Name: cc BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: sipbase Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is bootable on SIP when specified by packages provisioning file. In the following example, this command is used to gather information about a Cisco IOS-XE image on the bootflash: file system. Router# request platform software package describe file bootflash:ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin Package: ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin Size: 218783948 Timestamp: 2007-12-04 17:14:09 UTC Canonical path: /bootflash/ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin Raw disk-file SHA1sum: d2999fc7e27e01344903a42ffacd62c156eba4cc Computed SHA1sum: 5f8cda8518d01d8282d80ecd34f7715783f4a813 Contained SHA1sum: 5f8cda8518d01d8282d80ecd34f7715783f4a813 Hashes match. Package is valid. Header size: 204 bytes Package type: 30000 Package flags: 0 Header version: 0 Internal package information: Name: rp_super BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: advipservicesk9 Build: v122_33_xn_asr_rls0_throttle_20071204_051318 request platform software package describe file CF-459 Cisco IOS Configuration Fundamentals Command Reference April 2010 Package is bootable from media and tftp. Package contents: Package: asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 52072652 Timestamp: 2007-12-04 13:33:13 UTC Raw disk-file SHA1sum: f1aad6d687256aa327a4efa84deab949fbed12b8 Computed SHA1sum: 15502fd1b8f9ffd4af4014ad4d8026c837929fe6 Contained SHA1sum: 15502fd1b8f9ffd4af4014ad4d8026c837929fe6 Hashes match. Package is valid. Header size: 204 bytes Package type: 20000 Package flags: 0 Header version: 0 Internal package information: Name: fp BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: espbase Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is bootable on ESP when specified by packages provisioning file. Package: asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 21844172 Timestamp: 2007-12-04 13:33:01 UTC Raw disk-file SHA1sum: 025e6159dd91cef9d254ca9fff2602d8ce065939 Computed SHA1sum: ea1b358324ba5815b9ea623b453a98800eae1c78 Contained SHA1sum: ea1b358324ba5815b9ea623b453a98800eae1c78 Hashes match. Package is valid. Header size: 204 bytes Package type: 30004 Package flags: 0 Header version: 0 Internal package information: Name: rp_security BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: rpaccess-k9 Build: v122_33_xn_asr_rls0_throttle_20071204_051318 request platform software package describe file CF-460 Cisco IOS Configuration Fundamentals Command Reference April 2010 Package is not bootable. Package: asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 21520588 Timestamp: 2007-12-04 13:33:06 UTC Raw disk-file SHA1sum: 432dfa61736d8a51baefbb2d70199d712618dcd2 Computed SHA1sum: 83c0335a3adcea574bff237a6c8640a110a045d4 Contained SHA1sum: 83c0335a3adcea574bff237a6c8640a110a045d4 Hashes match. Package is valid. Header size: 204 bytes Package type: 30001 Package flags: 0 Header version: 0 Internal package information: Name: rp_base BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: rpbase Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is bootable on RP when specified by packages provisioning file. Package: asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 24965324 Timestamp: 2007-12-04 13:33:08 UTC Raw disk-file SHA1sum: eb964b33d4959c21b605d0989e7151cd73488a8f Computed SHA1sum: 19b58886f97c79f885ab76c1695d1a6f4348674e Contained SHA1sum: 19b58886f97c79f885ab76c1695d1a6f4348674e Hashes match. Package is valid. Header size: 204 bytes Package type: 30002 Package flags: 0 Header version: 0 Internal package information: Name: rp_daemons BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: rpcontrol Build: v122_33_xn_asr_rls0_throttle_20071204_051318 request platform software package describe file CF-461 Cisco IOS Configuration Fundamentals Command Reference April 2010 Package is not bootable. Package: asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 48515276 Timestamp: 2007-12-04 13:33:13 UTC Raw disk-file SHA1sum: bc13462d6a4af7a817a7346a44a0ef7270e3a81b Computed SHA1sum: f1235d703cc422e53bce850c032ff3363b587d70 Contained SHA1sum: f1235d703cc422e53bce850c032ff3363b587d70 Hashes match. Package is valid. Header size: 204 bytes Package type: 30003 Package flags: 0 Header version: 0 Internal package information: Name: rp_iosd BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: rpios-advipservicesk9 Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is not bootable. Package: asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 36954316 Timestamp: 2007-12-04 13:33:11 UTC Raw disk-file SHA1sum: 3ee37cdbe276316968866b16df7d8a5733a1502e Computed SHA1sum: f2db80416a1245a5b1abf2988088860b38ce7898 Contained SHA1sum: f2db80416a1245a5b1abf2988088860b38ce7898 Hashes match. Package is valid. Header size: 204 bytes Package type: 10000 Package flags: 0 Header version: 0 Internal package information: Name: cc BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: sipbase Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is bootable on SIP when specified request platform software package describe file CF-462 Cisco IOS Configuration Fundamentals Command Reference April 2010 by packages provisioning file. Package: asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Size: 19933388 Timestamp: 2007-12-04 13:33:06 UTC Raw disk-file SHA1sum: 44b6d15cba31fb0e9b27464665ee8a24b92adfd2 Computed SHA1sum: b1d5faf093b183e196c7c8e1023fe1f7aafdd36d Contained SHA1sum: b1d5faf093b183e196c7c8e1023fe1f7aafdd36d Hashes match. Package is valid. Header size: 204 bytes Package type: 10001 Package flags: 0 Header version: 0 Internal package information: Name: cc_spa BuildTime: 2007-12-04_05.24 ReleaseDate: Tue 04-Dec-07 01:00 RouteProcessor: rp1 Platform: ASR1000 User: mcpre PackageName: sipspa Build: v122_33_xn_asr_rls0_throttle_20071204_051318 Package is not bootable. Related Commands Command Description request platform software package install file Upgrades an individual package or a superpackage file. request platform software package expand file CF-463 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package expand file To extract the individual modules from a Cisco IOS-XE image, use the request platform software package expand file command in privileged EXEC or diagnostic mode. request platform software package expand file source-URL [to destination-URL] [force] [verbose] [wipe] Syntax Description Command Default No default behavior or values Command Modes Privileged EXEC (#) Diagnostic Mode (diag) Command History Usage Guidelines This command only extracts individual module files and a provisioning file from the Cisco IOS-XE image. Additional configuration is needed to configure the router to boot using the provisioning files and run using the individual modules. When this command is used, copies of each module and the provisioning file within the Cisco IOS-XE image are copied and placed on the destination directory. The Cisco IOS-XE image file is unchanged after the operation is complete. If the to destination-URL option is not entered, the Cisco IOS-XE image contents will be extracted onto the same directory where the Cisco IOS-XE image is currently stored. If this command is used to extract individual module files onto a directory that already contains individual module files, the files that would have been extracted onto the same directory are instead extracted to an automatically created directory on the destination device. source-URL Specifies the URL to the Cisco IOS-XE file that stores the contents that will be extracted. to destination-URL Specifies the destination URL where the files that were extracted from the Cisco IOS-XE file are left after the operation is complete. If this option is not entered, the Cisco IOS-XE image file contents are extracted onto the same directory where the Cisco IOS-XE image file is currently stored. force (Optional) Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages. verbose (Optional) Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed. wipe (Optional) Erases all content on the destination snapshot directory before extracting the files and placing them on the snapshot directory. Release Modification IOS XE Release 2.1 This command was introduced. request platform software package expand file CF-464 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to extract the individual modules and the provisioning file from a Cisco IOS-XE image that has already been placed in the directory where the user wants to store the individual modules and the provisioning file. Output of the directory before and after the extraction is given to confirm the files were extracted. Router# dir bootflash: Directory of bootflash:/ 11 drwx 16384 Dec 4 2007 11:26:07 +00:00 lost+found 14401 drwx 4096 Dec 4 2007 11:27:41 +00:00 .installer 12 -rw- 218783948 Dec 4 2007 12:12:16 +00:00 ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin Router# request platform software package expand file bootflash:ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin Verifying parameters Validating package type Copying package files Router# dir bootflash: Directory of bootflash:/ 11 drwx 16384 Dec 4 2007 11:26:07 +00:00 lost+found 14401 drwx 4096 Dec 4 2007 11:27:41 +00:00 .installer 12 -rw- 218783948 Dec 4 2007 12:12:16 +00:00 ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin 28803 -rw- 52072652 Dec 4 2007 12:14:17 +00:00 asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28804 -rw- 21844172 Dec 4 2007 12:14:17 +00:00 asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28805 -rw- 21520588 Dec 4 2007 12:14:18 +00:00 asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28806 -rw- 24965324 Dec 4 2007 12:14:19 +00:00 asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28807 -rw- 48515276 Dec 4 2007 12:14:20 +00:00 asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28808 -rw- 36954316 Dec 4 2007 12:14:21 +00:00 asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28809 -rw- 19933388 Dec 4 2007 12:14:22 +00:00 asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg 28802 -rw- 7145 Dec 4 2007 12:14:22 +00:00 packages.conf 928833536 bytes total (483700736 bytes free) The following example shows how to extract the individual modules and the provisioning file from a Cisco IOS-XE image that has already been placed on the router in a directory that will not store the individual modules and the provisioning file. In this particular example, the contents of a Cisco IOS-XE image stored in usb0: are extracted into bootflash:. Output of the bootflash: directory before and after the extraction is given to confirm the files were extracted. Router# dir usb0: Directory of usb0:/ 1120 -rwx 213225676 Dec 4 2007 10:50:36 +00:00 asr1000rp1-advipservicesk9.v122_33_xn_asr_rls0_throttle.bin Router# dir bootflash: Directory of bootflash:/ 11 drwx 16384 Dec 4 2007 12:32:46 +00:00 lost+found request platform software package expand file CF-465 Cisco IOS Configuration Fundamentals Command Reference April 2010 86401 drwx 4096 Dec 4 2007 14:06:24 +00:00 .ssh 14401 drwx 4096 Dec 4 2007 14:06:36 +00:00 .rollback_timer 43201 drwx 4096 Dec 4 2007 12:34:45 +00:00 .installer Router# request platform software package expand file usb0:asr1000rp1-advipservicesk9.v122_33_xn_asr_rls0_throttle.bin to bootflash: Verifying parameters Validating package type Copying package files Router# dir bootflash: Directory of bootflash:/ 11 drwx 16384 Dec 4 2007 12:32:46 +00:00 lost+found 86401 drwx 4096 Dec 4 2007 14:06:24 +00:00 .ssh 14401 drwx 4096 Dec 4 2007 14:06:36 +00:00 .rollback_timer 43201 drwx 4096 Dec 4 2007 12:34:45 +00:00 .installer 28803 -rw- 51986636 Dec 4 2007 16:40:38 +00:00 asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle.pkg 28804 -rw- 21838028 Dec 4 2007 16:40:39 +00:00 asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle.pkg 28805 -rw- 21508300 Dec 4 2007 16:40:39 +00:00 asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle.pkg 28806 -rw- 24963276 Dec 4 2007 16:40:40 +00:00 asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle.pkg 28807 -rw- 48419020 Dec 4 2007 16:40:41 +00:00 asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle.pkg 28808 -rw- 36946124 Dec 4 2007 16:40:43 +00:00 asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle.pkg 28809 -rw- 14670028 Dec 4 2007 16:40:43 +00:00 asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle.pkg 28802 -rw- 6563 Dec 4 2007 16:40:43 +00:00 packages.conf 928862208 bytes total (708186112 bytes free) Related Commands Command Description request platform software package install file Upgrades an individual module or a Cisco IOS-XE file. request platform software package install commit CF-466 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package install commit To cancel the rollback timer and commit a software upgrade, use the request platform software package install commit command in privileged EXEC or diagnostic mode. request platform software package install rp rp-slot-number commit [verbose] Syntax Description Command Default No default behavior or values. Command Modes Privileged EXEC (#) Diagnostic Mode (diag) Command History Usage Guidelines This command is entered after the request platform software package install rp rp-slot-number file command is used with the auto-rollback minutes option to begin an individual sub-package or a consolidated package upgrade. When the auto-rollback minutes option is used in this context, a rollback timer that cancels the upgrade after the number of specified minutes cancels the upgrade if the request platform software package install rp rp-slot-number commit command is not entered to commit the upgrade. If this command is not entered after the request platform software package install rp rp-slot-number file command is used with the auto-rollback minutes option to upgrade an individual sub-package or a consolidated package and the rollback timer expires, the upgrade does not complete and the router continues running the previous sub-package or consolidated package. Examples In the following example, this command is entered to commit an upgrade: request platform software package install rp 1 commit rp rp-slot-number Specifies the RP slot number. commit Specifies that an upgrade that was done using a rollback timer that has not expired can be committed. verbose (Optional) Displays verbose information, meaning all information that can be displayed on the console during the process will be displayed. Release Modification Cisco IOS XE Release 2.1 This command was introduced. request platform software package install commit CF-467 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description request platform software package install file Upgrades a consolidated package or sub-package. request platform software package install rollback Rolls back a previous software upgrade. request platform software package install file CF-468 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package install file To upgrade a consolidated package or an individual sub-package, use the request platform software package install file command in privileged EXEC or diagnostic mode. request platform software package install rp rp-slot-number file file-URL [auto-rollback minutes] [provisioning-file URL] [slot slot-number] [bay bay-number] [force] [on-reboot] [verbose] Syntax Description Command Default No default behavior or values. Command Modes Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command is used to upgrade consolidated packages and individual sub-packages. When this command is used to upgrade a SIPBASE sub-package, the slot slot-number of the SIP must be specified. When this command is used to upgrade a SIPSPA sub-package, the slot slot-number of the SIP and the bay bay-number of the SPA must be specified. rp rp-slot-number Specifies the RP slot number. file file-URL Specifies the URL to the consolidated package or sub-package. auto-rollback minutes Specifies the setting of a rollback timer, and sets the number of minutes on the rollback timer before the rollback timer expires. provisioning-file provisioning-file-URL Specifies the URL to the provisioning file. A provisioning file is used for booting only when a Cisco ASR 1000 Series Router is booted using individual sub-packages. slot slot-number Specifies the router slot number where a SIP can be installed. bay bay-number Specifies the SPA bay number within a SIP. force Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages. on-reboot Specifies that the installation will not be completed until the next RP reboot. verbose Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed. Release Modification Cisco IOS XE Release 2.1 This command was introduced. request platform software package install file CF-469 Cisco IOS Configuration Fundamentals Command Reference April 2010 When the auto-rollback minutes option is used, the request platform software package install rp rp-slot-number commit command must be entered before the rollback timer expires to complete the upgrade. If this command is not entered, the router rolls back to the previous software version. The rollback timer expires after the number of specified minutes. If the auto-rollback minutes option is not used, the upgrade simply occurs. Examples Managing and Configuring a consolidated package using the request platform package command In the following example, the request platform software package install command is used to upgrade a consolidated package running on RP 0. The force option, which forces the upgrade past any prompt (such as already having the same consolidated package installed), is used in this example. Router# request platform software package install rp 0 file bootflash:ASR1000rp1-advipservicesk9.01.00.00.12-33.XN.bin force --- Starting installation state synchronization --- Finished installation state synchronization --- Starting file path checking --- Finished file path checking --- Starting image file verification --- Checking image file names Verifying image file locations Locating image files and validating name syntax Inspecting image file types Processing image file constraints Extracting super package content Verifying parameters Validating package type Copying package files Checking and verifying packages contained in super package Creating candidate provisioning file WARNING: WARNING: Candidate software will be installed upon reboot WARNING: Finished image file verification --- Starting candidate package set construction --- Verifying existing software set Processing candidate provisioning file Constructing working set for candidate package set Constructing working set for running package set Checking command output Constructing merge of running and candidate packages Finished candidate package set construction --- Starting compatibility testing --- Determining whether candidate package set is compatible WARNING: WARNING: Candidate software combination not found in compatibility database WARNING: request platform software package install file CF-470 Cisco IOS Configuration Fundamentals Command Reference April 2010 Determining whether installation is valid Determining whether installation is valid ... skipped Checking IPC compatibility with running software Checking IPC compatibility with running software ... skipped Checking candidate package set infrastructure compatibility Checking infrastructure compatibility with running software Checking infrastructure compatibility with running software ... skipped Finished compatibility testing --- Starting commit of software changes --- Updating provisioning rollback files Creating pending provisioning file Committing provisioning file Finished commit of software changes SUCCESS: Software provisioned. New software will load on reboot. Router# reload Note A reload must be performed to finish this procedure. SIP Sub-package Installation with Verbose Option In the following example, the SIP sub-package for the SIP in slot 1 is installed using the request platform software package install command. In this example, the force option, which forces the upgrade past any prompt (such as already having the same sub-package installed), and the verbose option, which displays all possible output during the installation, are used. Router# request platform software package install rp 0 file bootflash:asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle.pkg slot 1 force verbose --- Starting installation state synchronization --- Finished installation state synchronization --- Starting file path checking --- Finished file path checking --- Starting image file verification --- Checking image file names ... file names checked Verifying image file locations ... image file locations verified Locating image files and validating name syntax ... image file names validated Inspecting image file types ... image file types acceptable Processing image file constraints ... constraints satisfied Creating candidate provisioning file ... created candidate provisioning file Finished image file verification --- Starting candidate package set construction --- Verifying existing software set ... verified existing software set is valid Processing candidate provisioning file ... candidate provisioning file processed Constructing working set for candidate package set ... working set constructed Constructing working set for running package set request platform software package install file CF-471 Cisco IOS Configuration Fundamentals Command Reference April 2010 ... working set for running package set constructed Checking command output ... command output is consistent with command set Constructing merge of running and candidate packages ... merged running and candidate packages Finished candidate package set construction --- Starting compatibility testing --- Determining whether candidate package set is compatible WARNING: WARNING: Candidate software combination not found in compatibility database WARNING: ... candidate package set is valid Determining whether installation is valid Software is unchanged Software sets are identified as compatible ... installation is valid Checking IPC compatibility with running software calling minime_merge.sh for /tmp/tdlresolve/compat/_tmp_issu_provision_sw_ minime_merge done for /tmp/tdlresolve/compat/_tmp_issu_provision_sw_ ... IPC is compatible with running software Checking candidate package set infrastructure compatibility ... candidate package set infrastructure is compatible Checking infrastructure compatibility with running software ... infrastructure is compatible with running software Finished compatibility testing --- Starting impact testing --- Checking operational impact of change ... operational impact of change is allowable Finished impact testing --- Starting commit of software changes --- Updating provisioning rollback files ... rollback provisioning files updated Creating pending provisioning file Ensuring that cached content is written to media ... cached content flushed to media ... pending provisioning file created Committing provisioning file Ensuring that cached content is written to media ... cached content flushed to media ... running provisioning file committed Finished commit of software changes --- Starting analysis of software changes --- ------------ changes to running software ------------ 0 0 cc ----------------------------------------------------- Finished analysis of software changes --- Starting update running software --- Blocking peer synchronization of operating information ... peer synchronization blocked Creating the command set placeholder directory Finding latest command set ... latest command set identified Assembling CLI output libraries ... CLI output libraries assembled request platform software package install file CF-472 Cisco IOS Configuration Fundamentals Command Reference April 2010 Assembling CLI input libraries ... CLI input libraries assembled Applying interim IPC and database definitions interim IPC and database definitions applied Replacing running software ... running software replaced Replacing CLI software ... CLI software replaced Restarting software Restarting CC0 Restarting CC0 ... software restarted Applying interim IPC and database definitions Oct 9 09:52:25.333: %MCP_OIR-6-OFFLINECARD: Card (cc) offline in slot 0 Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/0, interfaces disabled Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/1, interfaces disabled Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/2, interfaces disabled Oct 9 09:52:25.334: %MCP_OIR-6-REMSPA: SPA removed from subslot 0/3, interfaces disabled ... interim IPC and database definitions applied Notifying running software of updates ... running software notified Unblocking peer synchronization of operating information ... peer synchronization unblocked ... unmount of old packages scheduled Unmounting old packages ... inactive old packages unmounted Cleaning temporary installation files ... temporary installation files cleaned Finished update running software SUCCESS: Finished installing software. Router# Upgrading SIP Sub-package without using the verbose option In the following example, the SIP sub-package for the SIP in slot 1 is installed using the request platform software package install command. In this example, the force option, which forces the upgrade past any prompt (such as already having the same sub-package installed), is used. The verbose option is not used in this example. Router# request platform software package install rp 0 file bootflash:asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle.pkg slot 1 force --- Starting installation state synchronization --- Finished installation state synchronization --- Starting file path checking --- Finished file path checking --- Starting image file verification --- Checking image file names Verifying image file locations Locating image files and validating name syntax Inspecting image file types Processing image file constraints Creating candidate provisioning file Finished image file verification request platform software package install file CF-473 Cisco IOS Configuration Fundamentals Command Reference April 2010 --- Starting candidate package set construction --- Verifying existing software set Processing candidate provisioning file Constructing working set for candidate package set Constructing working set for running package set Checking command output Constructing merge of running and candidate packages Finished candidate package set construction --- Starting compatibility testing --- Determining whether candidate package set is compatible WARNING: WARNING: Candidate software combination not found in compatibility database WARNING: Determining whether installation is valid Software sets are identified as compatible Checking IPC compatibility with running software Checking candidate package set infrastructure compatibility Checking infrastructure compatibility with running software Finished compatibility testing --- Starting impact testing --- Checking operational impact of change Finished impact testing --- Starting commit of software changes --- Updating provisioning rollback files Creating pending provisioning file Committing provisioning file Finished commit of software changes --- Starting analysis of software changes --- Finished analysis of software changes --- Starting update running software --- Blocking peer synchronization of operating information Creating the command set placeholder directory Finding latest command set Assembling CLI output libraries Assembling CLI input libraries Applying interim IPC and database definitions interim IPC and database definitions applied Replacing running software Replacing CLI software Restarting software Restarting CC1 Restarting CC1 Applying interim IPC and database definitions Oct 9 09:54:55.365: %MCP_OIR-6-OFFLINECARD: Card (cc) offline in slot 1 Oct 9 09:54:55.365: %MCP_OIR-6-REMSPA: SPA removed from subslot 1/1, interfaces disabled Oct 9 09:54:55.365: %MCP_OIR-6-REMSPA: SPA removed from subslot 1/2, interfaces disabled Notifying running software of updates Unblocking peer synchronization of operating information Unmounting old packages Cleaning temporary installation files Finished update running software SUCCESS: Finished installing software. request platform software package install file CF-474 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# Upgrading IOS Sub-package In the following example, the request platform software package install command is used to upgrade an IOS sub-package. In this example, the force option, which forces the upgrade past any prompt (such as already having the same module installed), is used. Router# request platform software package install rp 0 file bootflash:asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pk g force --- Starting installation state synchronization --- Finished installation state synchronization --- Starting file path checking --- Finished file path checking --- Starting image file verification --- Checking image file names Verifying image file locations Locating image files and validating name syntax Inspecting image file types WARNING: In-service installation of IOSD package WARNING: requires software redundancy on target RP WARNING: or on-reboot parameter WARNING: Automatically setting the on-reboot flag Processing image file constraints Creating candidate provisioning file Finished image file verification --- Starting candidate package set construction --- Verifying existing software set Processing candidate provisioning file Constructing working set for candidate package set Constructing working set for running package set Checking command output Constructing merge of running and candidate packages Finished candidate package set construction --- Starting compatibility testing --- Determining whether candidate package set is compatible WARNING: WARNING: Candidate software combination not found in compatibility database WARNING: Determining whether installation is valid Determining whether installation is valid ... skipped Checking IPC compatibility with running software Checking IPC compatibility with running software ... skipped Checking candidate package set infrastructure compatibility Checking infrastructure compatibility with running software Checking infrastructure compatibility with running software ... skipped Finished compatibility testing --- Starting commit of software changes --- Updating provisioning rollback files Creating pending provisioning file Committing provisioning file request platform software package install file CF-475 Cisco IOS Configuration Fundamentals Command Reference April 2010 Finished commit of software changes SUCCESS: Software provisioned. New software will load on reboot. Router# Note that the new RPIOS sub-package will become active only after a reboot. Reboot the router to finish this procedure. Upgrading SPA Sub-package In the following example, the request platform software package install command is use to upgrade a SIPSPA sub-package for the SPA in bay 0 of router slot 1. In this example, the force option, which forces the upgrade past any prompt (such as already having the same module installed), is used. Router# request platform software package install rp 0 file bootflash:asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg slot 1 bay 0 force --- Starting installation state synchronization --- Finished installation state synchronization --- Starting file path checking --- Finished file path checking --- Starting image file verification --- Checking image file names Verifying image file locations Locating image files and validating name syntax Inspecting image file types Processing image file constraints Creating candidate provisioning file Finished image file verification --- Starting candidate package set construction --- Verifying existing software set Processing candidate provisioning file Constructing working set for candidate package set Constructing working set for running package set Checking command output Constructing merge of running and candidate packages Finished candidate package set construction --- Starting compatibility testing --- Determining whether candidate package set is compatible WARNING: WARNING: Candidate software combination not found in compatibility database WARNING: Determining whether installation is valid Software sets are identified as compatible Checking IPC compatibility with running software Checking candidate package set infrastructure compatibility Checking infrastructure compatibility with running software Finished compatibility testing --- Starting impact testing --- Checking operational impact of change Finished impact testing request platform software package install file CF-476 Cisco IOS Configuration Fundamentals Command Reference April 2010 --- Starting commit of software changes --- Updating provisioning rollback files Creating pending provisioning file Committing provisioning file Finished commit of software changes --- Starting analysis of software changes --- Finished analysis of software changes --- Starting update running software --- Blocking peer synchronization of operating information Creating the command set placeholder directory Finding latest command set Assembling CLI output libraries Assembling CLI input libraries Applying interim IPC and database definitions interim IPC and database definitions applied Replacing running software Replacing CLI software Restarting software Restarting SPA CC1/0 Applying interim IPC and database definitions Notifying running software of updates Unblocking peer synchronization of operating information Unmounting old packages Cleaning temporary installation files Finished update running software SUCCESS: Finished installing software. Router# Related Commands Command Description request platform software package install commit Cancel the rollback timer and commits a software upgrade. request platform software package install rollback Rolls back a previous software upgrade. request platform software package install snapshot Creates a snapshot directory that will contain all the files extracted from a consolidated package. request platform software package install rollback CF-477 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package install rollback To roll back a previous software upgrade, use the request platform software package install rollback command in privileged EXEC or diagnostic mode. request platform software package install rp rp-slot-number rollback [as-booted | provisioning-file provisioning-file-URL] [force] [on-reboot] [verbose] Syntax Description Command Default No default behavior or values Command Modes Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command rolls back a configuration that has an active rollback timer. Active rollback timers are used when the auto-rollback option is entered when software is being upgraded using the request platform software package install file command. Examples In the following example, an upgrade that was using a rollback timer is rolled back to the previous configuration instead of upgraded: request platform software package install rp 0 rollback rp rp-slot-number Specifies the slot number of the RP doing the request. as-booted Specifies that the software update will not occur, and that the router will instead boot using the same procedure that it used during the last bootup. provisioning-file provisioning-file-URL Specifies that the software update will not occur, and that the router will instead boot using the specified provisioning file. force Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages. on-reboot Specifies that the installation will not be completed until the next RP reboot. verbose Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed. Release Modification Cisco IOS XE Release 2.1 This command was introduced. request platform software package install rollback CF-478 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description request platform software package install commit Cancel the rollback timer and commits a software upgrade. request platform software package install file Upgrades a consolidated package or an individual sub-package. request platform software package install snapshot CF-479 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software package install snapshot To create a snapshot directory that contains all the files extracted from a consolidated package, use the request platform software package install snapshot command in privileged EXEC or diagnostic mode. request platform software package install rp rp-slot-number snapshot to URL [as snapshot-provisioning-filename] [force] [verbose] [wipe] Syntax Description Command Default No default behavior or values Command Modes Privileged EXEC (#) Diagnostic (diag) Command History Usage Guidelines This command is used to create a directory at the destination device and extract the individual sub-packages in a consolidated package to that directory. The request platform software package expand command is the only other command that can be used to extract individual sub-packages from a consolidated package. rp rp-slot-number Specifies the slot number. snapshot to URL Creates a directory and extracts all files from the consolidated package into that directory. The directory is named in the command-line as part of the URL_FS. If the URL_FS is specified as a file system, the files in the consolidated package will be extracted onto the file system and not a directory on the file system. as snapshot-provisionin g-filename (Optional) Renames the provisioning file in the snapshot directory. If this option is not used, the existing provisioning filename of the provisioning file in the consolidated package is used as the provisioning filename. wipe (Optional) Erases all content on the destination snapshot directory before extracting the files and placing them on the snapshot directory. force (Optional) Specifies that the operation will be forced, meaning that the upgrade will proceed despite any warning messages. verbose (Optional) Displays verbose information, meaning all output that can be displayed on the console during the process will be displayed. Release Modification Cisco IOS XE Release 2.1 This command was introduced. request platform software package install snapshot CF-480 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, a snapshot directory named snapdir1_snap is created in the bootflash: file system, and the individual sub-package files from the consolidated package are extracted into the snapshot directory. The second portion of the example first sets up the router to reboot using the files in the snapshot directory (deletes all previous boot system commands, configures the configuration register, then enters a boot system command to boot using the extracted provisioning file), saves the new configuration, then reboots so the router will boot using the extracted provisioning file, which allows the router to run using the extracted individual sub-package files. Router(diag)# request platform software package install rp 0 snapshot to bootflash:snapdir1_snap --- Starting active image file snapshot --- Validating snapshot parameters Creating destination directory Copying files to destination media Copied provisioning file as packages.conf Copying package file asr1000rp1-rpbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-rpcontrol.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-rpios-advipservicesk9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-rpaccess-k9.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-sipbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-sipspa.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Copying package file asr1000rp1-espbase.v122_33_xn_asr_rls0_throttle_20071204_051318.pkg Moving files into final location Finished active image file snapshot Router(config)# no boot system Router(config)# config-register 0x1 Router(config)# boot system harddisk:snapdir1_snap/packages.conf Router(config)# exit May 11 01:31:04.815: %SYS-5-CONFIG_I: Configured from console by con Router# write mem Building configuration... [OK] Router# reload Related Commands Command Description request platform software package install file Upgrades a consolidated package or an indivual sub-package. request platform software process release CF-481 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software process release To restart processes that have been placed in the hold down state by the Process Manager on the Cisco ASR 1000 Series Routers, use the request platform software process release command in privileged EXEC or diagnostic mode. request platform software process release slot all Syntax Description Command Default No default behavior or values Command Modes Privileged EXEC (#) Diagnostic Mode (diag) Command History Usage Guidelines This command is used to restart processes in the holddown state. If a process is in the holddown state, a console message is generated to notify the user that the process is helddown. Before placing any process in the holddown state, the Process Manager makes up to 5 attempts over 120 seconds to enable the process. These attempts to enable the process also happen automatically at startup. If the Process Manager is unable to enable the process after these attempts, the process will then be placed in the holddown state. slot Specifies the hardware slot. Options include: • number—The number of the SIP slot of the hardware module where the trace level is being set. For instance, if you wanted to specify the SIP in SIP slot 2 of the router, enter 2 as the number. • f0—The ESP in ESP slot 0. • f1—The ESP in ESP slot 1 • fp active—The active ESP. • fp standby—The standby ESP. • r0—The RP in RP slot 0. • r1—The RP in RP slot 1. • rp active—The active RP. • rp standby—The standby RP. all Specifies that all processes currently in the holddown state within the selected slot will be restarted. Release Modification Cisco IOS XE Release 2.1 This command was introduced. request platform software process release CF-482 Cisco IOS Configuration Fundamentals Command Reference April 2010 When this command is entered, it only attempts to restart processes currently in the holddown state. Active processes will not be affected by entering this command. Examples In the following example, this command is entered to restart any process currently on RP 0 in the holddown state: request platform software process release r0 all request platform software system shell CF-483 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software system shell To request platform shell access, use the request platform software system shell command in privileged EXEC mode. request platform software system shell [rp | esp | sip] Syntax Description Command Modes Privileged EXEC (#) Command History Usage Guidelines The platform shell command needs to be entered before before using the request platform software system shell command. Providing shell access would not be necessary. However, there might be some cases where the command may not be available, or the IOS process hangs, or IOS console may not be available. In such cases, you can login to the shell and see the status of the system. The shell should be accessed under Cisco supervision, and no support is provided if accessed without supervision. The following message is displayed , before the shell access is granted: "Activity within this shell can jeopardize the functioning of the system. Use this functionality only under supervision of Cisco Support." Examples In the following example, a request to theplatform shell is made Router(config)# platform shell Router(config)# exit Router# request platform software shell system Activity within this shell can jeopardize the functioning of the system. Are you sure you want to continue? [y/n] y ********************************************************************** Activity within this shell can jeopardize the functioning of the system. Use this functionality only under supervision of Cisco Support. Related Commands rp Specifies the Route Processor (RP); it can be either active or standby. esp Specifies the Embedded Services Processor (ESP) control processor; it can be either active or standby. sip Specifies the SPA Interface Processor (SIP). Release Modification 12.2(33)XNC This command was introduced. Command Description platform shell Grants shell and enters shell access grant configuration mode. request platform software shell session output format CF-484 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software shell session output format To modify the format of the output of some show commands on the Cisco ASR1000 Series Routers, use the request platform software shell session output format command in privileged EXEC and diagnostic mode. request platform software shell session output format format Syntax Description Command Default All show command output is seen in plaintext (the text format) by default. Command Modes Privileged EXEC (#) Diagnostic Mode (diag) Command History Usage Guidelines Entering this command can only change the output of some show commands that are available in both privileged EXEC and diagnostic mode. At the current time, most of these commands are show platform software and show platform hardware commands. Only a small subset of commands currently produce output using the html option. Examples In the following example, the request platform software shell session output format command is used to change the show output format from text to raw. The output of the show platform hardware slot r0 alarms visual command is shown both before and after the request platform software shell session output format command was entered to illustrate the change in output format. Router# show platform hardware slot r0 alarms visual Current Visual Alarm States Critical: On Major : On Minor : Off Router# request platform software shell session output format raw Router# show platform hardware slot r0 alarms visual message@alarms_msg: { format Specifies the output format for show command output. Options include: • html—Specifies Hypertext Markup Language (HTML) output. • raw—Specifies the raw message output. • text—Specifies plaintext output, which is the default. • xml—Specifies Extensible Markup Language (XML) output Release Modification IOS XE Release 2.1 This command was introduced request platform software shell session output format CF-485 Cisco IOS Configuration Fundamentals Command Reference April 2010 tdl_cman_alarms_data@tdl_cman_alarms_data: { critical@tdl_boolean:TDL_TRUE major@tdl_boolean:TDL_TRUE minor@tdl_boolean:TDL_FALSE } } message@ui_req_msg: { ui_req@ui_req: { request_id@U64:2 client@ui_client: { location@svc_loc: { fru@b_fru:BINOS_FRU_RP slotnum@I16:0 baynum@I16:0 } client_type@ui_client_type:UICLIENT_INVALID term_type@ui_terminal_type:UITT_INVALID ttynum@U32:0 tty_name@NS: user_name@NS: } command@NS: request_name@NS: flags@ui_req_flag: } } In the following example, the request platform software shell session output format command is used to change the show output format from text to xml. The output of the show platform hardware slot r0 alarms visual command is shown both before and after the request platform software shell session output format command was entered to illustrate the change in output format. Router# show platform hardware slot r0 alarms visual Current Visual Alarm States Critical: On Major : On Minor : Off Router# request platform software shell session output format xml Router# show platform hardware slot r0 alarms visual 4 0 0 0 request platform software shell session output format CF-486 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software vty attach CF-487 Cisco IOS Configuration Fundamentals Command Reference April 2010 request platform software vty attach To enter EXEC mode on a router after persistent SSH or persistent Telnet is configured to connect to the router in diagnostic mode, use the request platform software vty attach command in diagnostic mode. request platform software vty attach [permanent] Syntax Description Command Default No default behavior or values Command Modes Diagnostic (diag) Command History Usage Guidelines If persistent Telnet or persistent SSH is configured to make users wait for an IOS vty line before allowing them to access the IOS CLI, this command can be used to attach to an IOS vty line and place the user in EXEC mode. Exiting EXEC mode returns the user to diagnostic mode unless the permanent keyword is entered. When the permanent keyword is entered, exiting EXEC mode exits the router. The vty lines must be configured to allow local login for this command to work. The vty lines must also be configured to accept the type of transport traffic (SSH or Telnet) being used to connect to the router for the session in which the request platform software vty attach command is entered. Examples In the following example, this command is used to leave diagnostic mode and enter privileged EXEC mode: Router(diag)# request platform software vty attach Router# In the following example, this command is used to leave diagnostic mode and enter privileged EXEC mode. The user then re-enters diagnostic mode by exiting privileged EXEC mode: Router(diag)# request platform software vty attach Router# exit Router(diag)# In the following example, this command is used with the permanent option to leave diagnostic mode and enter privileged EXEC mode. The user then exits the router by exiting privileged EXEC mode: Router(diag)# request platform software vty attach permanent Router# exit Connection to Router closed. permanent (Optional) Specifies that the router should not return to diagnostic mode if EXEC mode is exited. Release Modification Cisco IOS XE Release 2.1 This command was introduced. revision CF-488 Cisco IOS Configuration Fundamentals Command Reference April 2010 revision To set the revision number for the Multiple Spanning Tree (802.1s) (MST) configuration, use the revision command in MST configuration submode. To return to the default settings, use the no form of this command. revision version no revision Syntax Description Defaults version is 0. Command Modes MST configuration submode Command History Usage Guidelines Two Cisco 7600 series routers that have the same configuration but different revision numbers are considered to be part of two different regions. Caution Be careful when using the revision command to set the revision number of the MST configuration because a mistake can put the switch in a different region. Examples This example shows how to set the revision number of the MST configuration: Router(config-mst)# revision 5 Router(config-mst)# Related Commands version Revision number for the configuration; valid values are from 0 to 65535. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. revision CF-489 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Description instance Maps a VLAN or a set of VLANs to an MST instance. name (MST configuration submode) Sets the name of an MST region. show Verifies the MST configuration. show spanning-tree Displays information about the spanning-tree state. spanning-tree mst configuration Enters MST-configuration submode. rmdir CF-490 Cisco IOS Configuration Fundamentals Command Reference April 2010 rmdir To remove an existing directory in a Class C Flash file system, use the rmdir command in EXEC, privileged EXEC, or diagnostic mode. rmdir directory Syntax Description Command Modes User EXEC Privileged EXEC Diagnostic Command History Usage Guidelines This command is valid only on Class C Flash file systems. Caution You can use the rmdir command to remove a directory that another user is currently accessing in read-only mode, for example if it is that user’s default working directory. If you use the rmdir command to remove such a directory and a user whose current directory is set to the deleted directory then uses the pwd command to display the current working directory, the following error message is displayed: Cannot determine current directory. Examples The following example deletes the directory named newdir: Router# dir Directory of flash: 2 drwx 0 Mar 13 1993 13:16:21 newdir 8128000 bytes total (8126976 bytes free) Router# rmdir newdir Rmdir file name [newdir]? Delete flash:newdir? [confirm] Removed dir flash:newdir Router# dir Directory of flash: No files in directory 8128000 bytes total (8126976 bytes free) directory Directory to delete. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR1000 Series Router and was made available in diagnostic mode. rmdir CF-491 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description dir Displays a list of files on a file system. mkdir Creates a new directory in a Class C Flash file system. rommon-pref CF-492 Cisco IOS Configuration Fundamentals Command Reference April 2010 rommon-pref To select a ReadOnly or Upgrade ROMmon image to be booted on the next reload of a Cisco 7200 VXR router or Cisco 7301 router when you are in ROMmon, use the rommon-pref command in ROM monitor mode. rommon-pref [readonly | upgrade] Syntax Description Defaults No default behavior or values Command Modes ROM monitor mode Command History Usage Guidelines You might select the ReadOnly ROMmon image to be booted on the next reload because the Upgrade image has features or side effects you do not like. When you are in ROMmon, there is no descriptive output to inform you whether the ReadOnly ROMmon image was reloaded. To confirm the reload, use the showmon command after entering the rommon-pref readonly command. Use this command when you are in ROMmon mode. Use the upgrade rom-monitor preference command when you are in Cisco IOS. Examples The following example, applicable to both the Cisco 7200 VXR and Cisco 7301 routers, shows how to select the ReadOnly ROMmon image to be booted on the next reload of the router when you are already in ROMmon mode: rommon 2 > rommon-pref readonly readonly Selects the ReadOnly ROMmon image to be booted on the next reload. upgrade Selects the Upgrade, second ROMmon image to be booted on the next reload. Release Modification 12.0(28)S This command was introduced on the Cisco 7200 VXR router. It was introduced in ROMmon version 12.3(4r)T1 for the Cisco 7200 VXR router. 12.3(8)T This command was integrated into Cisco IOS Release 12.3(8)T and supported on the Cisco 7200 VXR router and Cisco 7301 router. It was introduced in ROMmon version 12.3(4r)T2 for the Cisco 7301 router. 12.3(9) This command was integrated into Cisco IOS Release 12.3(9) and supported on the Cisco 7200 VXR router and Cisco 7301 router. rommon-pref CF-493 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description showmon Shows both the ReadOnly and the Upgrade ROMmon image versions when you are in ROMmon mode, as well as which ROMmon image is running. route-converge-interval CF-494 Cisco IOS Configuration Fundamentals Command Reference April 2010 route-converge-interval To configure the time interval after which the old FIB entries are purged, use the route-converge-interval command in main CPU submode. To return to the default settings, use the no form of this command. route-converge-interval seconds no route-converge-interval Syntax Description Defaults seconds is 120 seconds (2 minutes). Command Modes Main CPU submode Command History Usage Guidelines SRM/SSO is supported in the following releases only. • Release 12.2(17b)SXA and later rebuilds of Release 12.2(17b)SXA • Release 12.2(17d)SXB and later rebuilds of Release 12.2(17d)SXB This command is not supported in Cisco 7600 series routers that are configured with a Supervisor Engine 2. The time interval for route-converge delay is needed to simulate the route-converge time when routing protocols restart on switchover. Examples This example shows how to set the time interval for the route-converge delay: Router(config)# redundancy Router(config-red)# main-cpu Router(config-red-main)# route-converge-interval 90 Router(config-red-main)# This example shows how to return to the default time interval for the route-converge delay: Router(config)# redundancy Router(config-red)# main-cpu Router(config-red-main)# no route-converge-interval Router(config-red-main)# seconds Time interval, in seconds, after which the old FIB entries are purged; valid values are from 60 to 3600 seconds. Release Modification 12.2(17b)SXA Support for this command was introduced on the Supervisor Engine 720. 12.2(18)SXD This command is supported on releases prior to Release 12.2(18)SXD. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. route-converge-interval CF-495 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description redundancy Enters redundancy configuration mode. rsh CF-496 Cisco IOS Configuration Fundamentals Command Reference April 2010 rsh To execute a command remotely on a remote shell protocol (rsh) host, use the rsh command in privileged EXEC mode. rsh {ip-address | host} [/user username] remote-command Syntax Description Defaults If you do not specify the /user username keyword and argument, the Cisco IOS software sends a default remote username. As the default value of the remote username, the software sends the username associated with the current tty process, if that name is valid. For example, if the user is connected to the router through Telnet and the user was authenticated through the username command, then the software sends that username as the remote username. If the tty username is invalid, the software uses the host name as the both the remote and local usernames. Note For Cisco, tty lines are commonly used for access services. The concept of tty originated with UNIX. For UNIX systems, each physical device is represented in the file system. Terminals are sometimes called tty devices (tty stands for teletype, the original UNIX terminal). Command Modes Privileged EXEC Command History Usage Guidelines Use the rsh command to execute commands remotely. The host on which you remotely execute the command must support the rsh protocol, and the .rhosts files on the rsh host must include an entry that permits you to remotely execute commands on that host. For security reasons, the software does not default to a remote login if no command is specified, as does UNIX. Instead, the router provides Telnet and connect services that you can use rather than rsh. ip-address IP address of the remote host on which to execute the rsh command. Either the IP address or the host name is required. host Name of the remote host on which to execute the command. Either the host name or the IP address is required. /user username (Optional) Remote username. remote-command Command to be executed remotely. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. rsh CF-497 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following command specifies that the user named sharon attempts to remotely execute the UNIX ls command with the -a argument on the remote host named mysys.cisco.com. The command output resulting from the remote execution follows the command example: Router1# rsh mysys.cisco.com /user sharon ls -a . . . .alias .cshrc .emacs .exrc .history .login .mailrc .newsrc .oldnewsrc .rhosts .twmrc .xsession jazz scheduler allocate CF-498 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler allocate To guarantee CPU time for processes, use the scheduler allocate command in global configuration mode. To restore the default, use the no form of this command. scheduler allocate interrupt-time process-time no scheduler allocate Syntax Description Defaults Approximately 5 percent of the CPU is available for process tasks. Command Modes Global configuration Command History Usage Guidelines This command applies to the Catalyst 6500 series switches, Cisco 7200 series, Cisco 7500 series, and Cisco 7600 series routers. Caution We recommend that you do not change the default settings. Changing settings associated with CPU processes can negatively impact system performance. Entering the scheduler allocate command without arguments is the same as entering the no scheduler allocate or the default scheduler allocate command. interrupt-time Integer (in microseconds) that limits the maximum number of microseconds to spend on fast switching within any one network interrupt context. The range is from 400 to 60000 microseconds. The default is 4000 microseconds. process-time Integer (in microseconds) that guarantees the minimum number of microseconds to spend at the process level when network interrupts are disabled. The range is from 100 to 4000 microseconds.The default is 200 microseconds. The default for Catalyst 6500 series switches and Cisco 7600 series routers is 800 microseconds. Release Modification 11.2 This command was introduced. 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17a)SX This command was changed as follows: • The process-time default setting was changed from 200 microseconds to 800 microseconds. • The no scheduler allocate action was changed to return to the default settings. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to the 12.2(17d)SXB release. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. scheduler allocate CF-499 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example makes 20 percent of the CPU available for process tasks: Router(config)# scheduler allocate 2000 500 Related Commands Command Description scheduler interval Controls the maximum amount of time that can elapse without running system processes. scheduler heapcheck process CF-500 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler heapcheck process To perform a “sanity check” for corruption in memory blocks when a process switch occurs, use the scheduler heapcheck process command in global configuration mode. To disable this feature, use the no form of this command. scheduler heapcheck process [memory [fast] [io] [multibus] [pci] [processor] [checktype {all | magic | pointer | refcount | lite-chunks}]] no scheduler heapcheck process Syntax Description Defaults This command is disabled by default. If no keywords are specified, a sanity check will be performed on all the memory blocks and memory pools. Command Modes Global configuration Command History Usage Guidelines When configuring this command, you can choose none or all memory block keywords (fast, io, multibus, pci, processor, and checktype). Enabling this command has a significant impact on router performance. memory (Optional) Specifies checking all memory blocks and memory pools. fast (Optional) Specifies checking the fast memory block. io (Optional) Specifies checking the I/O memory block. multibus (Optional) Specifies checking the multibus memory block. pci (Optional) Specifies checking the process control information (PCI) memory block. processor (Optional) Specifies checking the processor memory block. checktype (Optional) Specifies checking specific memory pools. all (Optional) Specifies checking the value of the block magic, red zone, size, refcount, and pointers (next and previous). magic (Optional) Specifies checking the value of the block magic, red zone, and size. pointer (Optional) Specifies checking the value of the next and previous pointers. refcount (Optional) Specifies checking the value of the block magic and refcount. lite-chunks (Optional) Specifies checking the memory blocks allocated by the memory allocation lite (malloc_lite) feature. Release Modification 12.2(15)T This command was introduced. 12.3(11)T The lite-chunks keyword was added. scheduler heapcheck process CF-501 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example shows how to sanity check for corruption in the I/O memory block when a process switch occurs. In this example, the values of only the block magic, red zone, and size will be checked. scheduler heapcheck process memory io checktype magic The following example shows how to sanity check for corruption in the processor memory block when a process switch occurs. In this example, the values of only the next and previous pointers will be checked. scheduler heapcheck process memory processor checktype pointer Related Commands Command Description memory lite Enables the malloc_lite feature. memory sanity Performs a “sanity check” for corruption in buffers and queues. scheduler interrupt mask profile CF-502 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler interrupt mask profile To start interrupt mask profiling for all processes running on the system, use the scheduler interrupt mask profile command in global configuration mode. To stop interrupt mask profiling, use the no form of this command. scheduler interrupt mask profile no scheduler interrupt mask profile Syntax Description This command has no arguments or keywords. Defaults Interrupt mask profiling is disabled by default. Command Modes Global configuration Command History Usage Guidelines This command enables the collection of details regarding the total amount of time a process has masked interrupts since the interrupt mask profiler was enabled. Examples The following example shows how to enable interrupt mask profiling: Router(config)# scheduler interrupt mask profile Related Commands Release Modification 12.4(2)T This command was introduced. Command Description clear processes interrupt mask detail Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer. scheduler interrupt mask size Configures the maximum number of entries that can exist in the interrupt mask buffer. scheduler interrupt mask time Configures the maximum allowed time that a process can run with interrupts masked. show process interrupt mask buffer Displays the information stored in the interrupt mask buffer. show processes interrupt mask detail Displays interrupt masked details for the specified process or all processes in the system. scheduler interrupt mask size CF-503 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler interrupt mask size To configure the maximum number of entries that can exist in the interrupt mask buffer, use the scheduler interrupt mask size command in global configuration mode. To reset the maximum number of entries that can exist in the interrupt mask buffer to the default, use the no form of this command. scheduler interrupt mask size buffersize no scheduler interrupt mask size Syntax Description Defaults The default buffer size is 50 entries. Command Modes Global configuration Command History Examples The following example shows how to configure 100 entries the maximum number of entries that can exist in the interrupt mask buffer: Router(config)# scheduler interrupt mask size 100 Related Commands buffersize Specifies the number of entries that can exist in the interrupt mask buffer. Release Modification 12.4(2)T This command was introduced. Command Description clear processes interrupt mask detail Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer. scheduler interrupt mask profile Enables or disables interrupt mask profiling for all processes running on the system. scheduler interrupt mask time Configures the maximum amount of time a process can run with interrupts masked. show processes interrupt mask buffer Displays interrupt masked details for the specified process or all processes in the system and displays information stored in the interrupt mask buffer. show processes interrupt mask detail Displays interrupt masked details for the specified or all processes in the system. scheduler interrupt mask time CF-504 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler interrupt mask time To configure the maximum time that a process can run with interrupts masked before another entry is created in the interrupt mask buffer, use the scheduler interrupt mask time command in global configuration mode. To reset the threshold time to the default, use the no form of this command. scheduler interrupt mask time threshold-time no scheduler interrupt mask time Syntax Description Defaults The default threshold time value is 50 microseconds. Command Modes Global configuration Command History Examples The following shows how to configure 100 microseconds as the maximum time a process can run with interrupts masked before another entry is created in the interrupt mask buffer: Router(config)# scheduler interrupt mask time 100 Related Commands threshold-time Specifies the maximum amount of timein microseconds a process can be in interrupt masked state without creating an entry in the interrupt mask buffer. Release Modification 12.4(2)T This command was introduced. Command Description clear processes interrupt mask detail Clears the interrupt masked details for all processes and stack traces that have been dumped into the interrupt mask buffer. scheduler interrupt mask profile Enables or disables interrupt mask profiling for all processes running on the system. scheduler interrupt mask size Configures the maximum number of entries that can exist in the interrupt mask buffer. show processes interrupt mask buffer Displays the information stored in the interrupt mask buffer. show processes interrupt mask detail Displays interrupt masked details for the specified process or all processes in the system. scheduler interval CF-505 Cisco IOS Configuration Fundamentals Command Reference April 2010 scheduler interval To control the maximum amount of time that can elapse without running system processes, use the scheduler interval command in global configuration mode. To restore the default, use the no form of this command. scheduler interval milliseconds no scheduler interval Syntax Description Defaults High-priority operations are allowed to use as much of the CPU as needed. Command Modes Global configuration Command History Usage Guidelines The normal operation of the network server allows the switching operations to use as much of the central processor as is required. If the network is running unusually heavy loads that do not allow the processor the time to handle the routing protocols, give priority to the system process scheduler. High-priority operations are allowed to use as much of the CPU as needed. Note Changing settings associated with CPU processes can negatively impact system performance. On the Cisco 7200 series and Cisco 7500 series, use the scheduler allocate global configuration command instead of the scheduler interval command. Examples The following example changes the low-priority process schedule to an interval of 750 milliseconds: Router(config)# scheduler interval 750 Related Commands milliseconds Integer that specifies the interval (in milliseconds). The minimum interval that you can specify is 500 milliseconds; there is no maximum value. Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description scheduler allocate Guarantees CPU time for processes. send CF-506 Cisco IOS Configuration Fundamentals Command Reference April 2010 send To send messages to one or all terminal lines, use the send command in EXEC mode. send {line-number | * | aux number | console number | tty number | vty number} Syntax Description Defaults No messages are sent. Command Modes User EXEC Priviledged EXEC Command History Usage Guidelines After entering this command, the system prompts for the message to be sent, which can be up to 500 characters long. Enter Ctrl-Z to end the message. Enter Ctrl-C to abort this command. Caution Be aware that in some circumstances text sent using the send command may be interpreted as an executable command by the receiving device. For example, if the receiving device is Unix workstation, and the receiving device is in a state (shell) where commands can be executed, the incoming text, if a properly formated Unix command, will be accepted by the workstation as a command. For this reason, you should limit your exposure to potential messages from terminal servers or other Cisco IOS-based devices when running an interactive shell. Examples The following example sends a message to all lines: 2509# send * Enter message, end with CTRL/Z; abort with CTRL/C: The system 2509 will be shut down in 10 minutes for repairs.^Z Send message? [confirm] 2509# line-number Line number to which the message will be sent. * Sends a message to all lines. aux number Sends a message to the specified AUX port. console number Sends a message to the specified console port. tty number Sends a message to the specified asynchronous line. vty number Sends a message to the specified virtual asynchronous line. Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. send CF-507 Cisco IOS Configuration Fundamentals Command Reference April 2010 * * * Message from tty0 to all terminals: * The system 2509 will be shut down in 10 minutes for repairs. service compress-config CF-508 Cisco IOS Configuration Fundamentals Command Reference April 2010 service compress-config To compress startup configuration files, use the service compress-config command in global configuration mode. To disable compression, use the no form of this command. service compress-config no service compress-config Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines After you configure the service compress-config command, the router will compress configuration files every time you save a configuration to the startup configuration. For example, when you enter the copy system:running-config nvram:startup-config command, the running configuration will be compressed before storage in NVRAM. If the file compression succeeds, the following message is displayed: Compressing configuration from configuration-size to compressed-size [OK] If the boot ROMs do not recognize a compressed configuration, the following message is displayed: Boot ROMs do not support NVRAM compression Config NOT written to NVRAM If the file compression fails, the following message is displayed: Error trying to compress nvram One way to determine whether a configuration file will be compressed enough to fit into NVRAM is to use a text editor to enter the configuration, then use the UNIX compress command to check the compressed size. To get a closer approximation of the compression ratio, use the UNIX compress -b12 command. Once the configuration file has been compressed, the router functions normally. At boot time, the system recognizes that the configuration file is compressed, uncompresses it, and proceeds normally. A partition nvram:startup-config command uncompresses the configuration before displaying it. To disable compression of the configuration file, enter configuration mode and specify the no service compress-config command. Then, exit global configuration mode and enter the copy system:running-config nvram:startup-config command. The router displays an OK message if it is Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service compress-config CF-509 Cisco IOS Configuration Fundamentals Command Reference April 2010 able to write the uncompressed configuration to NVRAM. Otherwise, the router displays an error message indicating that the configuration is too large to store. If the configuration file is larger than the physical NVRAM, the following message is displayed: ##Configuration too large to fit uncompressed in NVRAM Truncate configuration? [confirm] When the file is truncated, commands at the end of the file are erased. Therefore, you will lose part of your configuration. To truncate and save the configuration, type Y. To not truncate and not save the configuration, type N. Examples In the following example, the configuration file is compressed: Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# service compress-config Router(config)# end Router# %SYS-5-CONFIG_I: Configured from console by console Router# copy system:running-config nvram:startup-config Building configuration... Compressing configuration from 1179 bytes to 674 bytes [OK] Related Commands Command Description partition nvram:startup-config Separates Flash memory into partitions on Class B file system platforms. service config CF-510 Cisco IOS Configuration Fundamentals Command Reference April 2010 service config To enable autoloading of configuration files from a network server, use the service config command in global configuration mode. To restore the default, use the no form of this command. service config no service config Syntax Description This command has no arguments or keywords. Defaults Disabled, except on systems without NVRAM or with invalid or incomplete information in NVRAM. In these cases, autoloading of configuration files from a network server is enabled automatically. Command Modes Global configuration Command History Usage Guidelines Usually, the service config command is used in conjunction with the boot host or boot network command. You must enter the service config command to enable the router to automatically configure the system from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T , 12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot network command to be active. If you specify both the no service config command and the boot host command, the router attempts to find the specified host configuration file. The service config command can also be used without the boot host or boot network command. If you do not specify host or network configuration filenames, the router uses the default configuration files. The default network configuration file is network-confg. The default host configuration file is host-confg, where host is the hostname of the router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-confg. Examples In the following example, a router is configured to autoload the default network and host configuration files. Because no boot host or boot network commands are specified, the router uses the broadcast address to request the files from a TFTP server. Router(config)# service config Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service config CF-511 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the network configuration file resides: Router(config)# service config Router(config)# boot network rcp://172.16.1.111/bridge_9.1 Related Commands Command Description boot host Changes the default name of the host configuration filename from which to load configuration commands. boot network Changes the default name of the network configuration file from which to load configuration commands. service counters max age CF-512 Cisco IOS Configuration Fundamentals Command Reference April 2010 service counters max age To set the time interval for retrieving statistics, use the service counters max age command in global configuration mode. To return to the default settings, use the no form of this command. service counters max age seconds no service counters max age Syntax Description Defaults seconds is 5 seconds. Command Modes Global configuration Command History Usage Guidelines A fully loaded Catalyst 6500 series switch chassis running Cisco IOS software version 12.2(18)SXF or its minor variants (SXF through SXF5) takes 1-2 minutes to update the SNMP counters maintained under ifTable and ifXTable. Polling the ifTable/ifXTable is done with the need to understand how much traffic is being handled by a specific port/interface. The typical polling interval to meet this need is 3-5 minutes. No gain is achived by reducing the polling interval to intervals lesser than 3 minutes. Note If you decrease the time interval for retrieving statistics from the default setting (5 seconds), traffic congestion may result in situations where frequent SNMP (SMNP bulk) retrievals occur. Examples This example shows how to set the time interval for retrieving statistics: Router(config)# service counters max age 10 Router(config)# seconds Maximum age, in seconds, of the statistics retrieved from the CLI or SNMP; valid values are from 0 to 60 seconds. Release Modification 12.2(18)SXD Support for this command was introduced on the Supervisor Engine 720 and the Supervisor Engine 2. 12.2(18)SXF This command was changed as follows: • The default was changed from 10 seconds to 5 seconds. • The valid values for seconds was changed from 1 to 60 seconds to 0 to 60 seconds. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service counters max age CF-513 Cisco IOS Configuration Fundamentals Command Reference April 2010 This example shows how to return to the default setting: Router(config)# no service counters max age Router(config)# service decimal-tty CF-514 Cisco IOS Configuration Fundamentals Command Reference April 2010 service decimal-tty To specify that line numbers be displayed and interpreted as octal numbers rather than decimal numbers, use the no service decimal-tty command in global configuration mode. To restore the default, use the service decimal-tty command. service decimal-tty no service decimal-tty Syntax Description This command has no arguments or keywords. Defaults Enabled (line numbers displayed as decimal numbers) Command Modes Global configuration Command History Examples In the following example, the router is configured to display decimal rather than octal line numbers: Router(config)# service decimal-tty Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service exec-wait CF-515 Cisco IOS Configuration Fundamentals Command Reference April 2010 service exec-wait To delay the startup of the EXEC on noisy lines, use the service exec-wait command in global configuration mode. To disable the delay function, use the no form of this command. service exec-wait no service exec-wait Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines This command delays startup of the EXEC until the line has been idle (no traffic seen) for 3 seconds. The default is to enable the line immediately on modem activation. This command is useful on noisy modem lines or when a modem attached to the line is configured to ignore MNP/V.42 negotiations, and MNP/V.42 modems may be dialing in. In these cases, noise or MNP/V.42 packets may be interpreted as usernames and passwords, causing authentication failure before the user has a chance to type a username or password. The command is not useful on nonmodem lines or lines without some kind of login configured. Examples The following example delays the startup of the EXEC: Router(config)# service exec-wait Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service finger CF-516 Cisco IOS Configuration Fundamentals Command Reference April 2010 service finger The service finger command has been replaced by the ip finger command. However, the service finger and no service finger commands continue to function to maintain backward compatibility with older versions of Cisco IOS software. Support for this command may be removed in a future release. See the description of the ip finger command for more information. service hide-telnet-address CF-517 Cisco IOS Configuration Fundamentals Command Reference April 2010 service hide-telnet-address To hide addresses while trying to establish a Telnet session, use the service hide-telnet-address command in global configuration mode. To disable this service, use the no form of this command. service hide-telnet-address no service hide-telnet-address Syntax Description This command has no arguments or keywords. Defaults Addresses are displayed. Command Modes Global configuration Command History Usage Guidelines When you attempt to connect to a device, the router displays addresses and other messages (for example, “Trying router1 (171.69.1.154, 2008)...).” With the hide feature, the router suppresses the display of the address (for example, “Trying router1 address #1...”). The router continues to display all other messages that would normally be displayed during a connection attempt, such as detailed error messages if the connection was not successful. The hide feature improves the functionality of the busy-message feature. When you configure only the busy-message command, the normal messages generated during a connection attempt are not displayed; only the busy-message is displayed. When you use the hide and busy features together you can customize the information displayed during Telnet connection attempts. When you configure the service hide-telnet-address command and the busy-message command, the router suppresses the address and displays the message specified with the busy-message command if the connection attempt is not successful. Examples The following example hides Telnet addresses: Router(config)# service hide-telnet-address Related Commands Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description busy-message Creates a “host failed” message that is displayed when a connection fails. service linenumber CF-518 Cisco IOS Configuration Fundamentals Command Reference April 2010 service linenumber To configure the Cisco IOS software to display line number information after the EXEC or incoming banner, use the service linenumber command in global configuration mode. To disable this function, use the no form of this command. service linenumber no service linenumber Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines With the service linenumber command, you can have the Cisco IOS software display the host name, line number, and location each time an EXEC process is started, or an incoming connection is made. The line number banner appears immediately after the EXEC banner or incoming banner. This feature is useful for tracking problems with modems, because the host and line for the modem connection are listed. Modem type information can also be included. Examples In the following example, a user Telnets to Router2 before and after the service linenumber command is enabled. The second time, information about the line is displayed after the banner. Router1> telnet Router2 Trying Router2 (172.30.162.131)... Open Welcome to Router2. User Access Verification Password: Router2> enable Password: Router2# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router2(config)# service linenumber Router2(config)# end Router2# logout [Connection to Router2 closed by foreign host] Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service linenumber CF-519 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router1> telnet Router2 Trying Router2 (172.30.162.131)... Open Welcome to Router2. Router2 line 10 User Access Verification Password: Router2> Related Commands Command Description show users Displays information about the active lines on the router. service nagle CF-520 Cisco IOS Configuration Fundamentals Command Reference April 2010 service nagle To enable the Nagle congestion control algorithm, use the service nagle command in global configuration mode. To disable the algorithm, use the no form of this command. service nagle no service nagle Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines When using a standard TCP implementation to send keystrokes between machines, TCP tends to send one packet for each keystroke typed. On larger networks, many small packets use up bandwidth and contribute to congestion. The algorithm developed by John Nagle (RFC 896) helps alleviate the small-packet problem in TCP. In general, it works this way: The first character typed after connection establishment is sent in a single packet, but TCP holds any additional characters typed until the receiver acknowledges the previous packet. Then the second, larger packet is sent, and additional typed characters are saved until the acknowledgment comes back. The effect is to accumulate characters into larger chunks, and pace them out to the network at a rate matching the round-trip time of the given connection. This method is usually effective for all TCP-based traffic. However, do not use the service nagle command if you have XRemote users on X Window system sessions. Examples The following example enables the Nagle algorithm: Router(config)# service nagle Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service prompt config CF-521 Cisco IOS Configuration Fundamentals Command Reference April 2010 service prompt config To display the configuration prompt (config), use the service prompt config command in global configuration mode. To remove the configuration prompt, use the no form of this command. service prompt config no service prompt config Syntax Description This command has no arguments or keywords. Defaults The configuration prompts appear in all configuration modes. Command Modes Global configuration Command History Examples In the following example, the no service prompt config command prevents the configuration prompt from being displayed. The prompt is still displayed in EXEC mode. When the service prompt config command is entered, the configuration mode prompt reappears. Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# no service prompt config hostname newname end newname# configure terminal Enter configuration commands, one per line. End with CNTL/Z. service prompt config newname(config)# hostname Router Router(config)# end Router# Related Commands Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description hostname Specifies or modifies the host name for the network server. prompt Customizes the prompt. service sequence-numbers CF-522 Cisco IOS Configuration Fundamentals Command Reference April 2010 service sequence-numbers To enable visible sequence numbering of system logging messages, use the service sequence-numbers command in global configuration mode. To disable visible sequence numbering of logging messages, use the no form of this command. service sequence-numbers no service sequence-numbers Syntax Description This command has no arguments or keywords. Defaults Disabled. Command Modes Global configuration Command History Usage Guidelines Each system status messages logged in the system logging process have a sequence reference number applied. This command makes that number visible by displaying it with the message. The sequence number is displayed as the first part of the system status message. See the description of the logging commands for information on displaying logging messages. Examples In the following example logging message sequence numbers are enabled: .Mar 22 15:28:02 PST: %SYS-5-CONFIG_I: Configured from console by console Router# config terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# service sequence-numbers Router(config)# end Router# 000066: .Mar 22 15:35:57 PST: %SYS-5-CONFIG_I: Configured from console by console Related Commands Release Modification 12.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description logging on Enables system logging globally. service timestamps Enables time-stamping of system logging messages or debugging messages. service slave-log CF-523 Cisco IOS Configuration Fundamentals Command Reference April 2010 service slave-log To allow slave Versatile Interface Processor (VIP) cards to log important error messages to the console, use the service slave-log command in global configuration mode. To disable slave logging, use the no form of this command. service slave-log no service slave-log Syntax Description This command has no arguments or keywords. Defaults This command is enabled by default. Command Modes Global configuration Command History Usage Guidelines This command allows slave slots to log error messages of level 2 or higher (critical, alerts, and emergencies). Examples In the following example, the router is configured to log important messages from the slave cards to the console: Router(config)# service slave-log The following is sample output generated when this command is enabled: %IPC-5-SLAVELOG: VIP-SLOT2: IPC-2-NOMEM: No memory available for IPC system initialization The first line indicates which slot sent the message. The second line contains the error message. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service tcp-keepalives-in CF-524 Cisco IOS Configuration Fundamentals Command Reference April 2010 service tcp-keepalives-in To generate keepalive packets on idle incoming network connections (initiated by the remote host), use the service tcp-keepalives-in command in global configuration mode. To disable the keepalives, use the no form of this command. service tcp-keepalives-in no service tcp-keepalives-in Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Examples In the following example, keepalives on incoming TCP connections are generated: Router(config)# service tcp-keepalives-in Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description service tcp-keepalives-out Generates keepalive packets on idle outgoing network connections (initiated by a user). service tcp-keepalives-out CF-525 Cisco IOS Configuration Fundamentals Command Reference April 2010 service tcp-keepalives-out To generate keepalive packets on idle outgoing network connections (initiated by a user), use the service tcp-keepalives-out command in global configuration mode. To disable the keepalives, use the no form of this command. service tcp-keepalives-out no service tcp-keepalives-out Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Examples In the following example, keepalives on outgoing TCP connections are generated: Router(config)# service tcp-keepalives-out Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description service tcp-keepalives-in Generates keepalive packets on idle incoming network connections (initiated by the remote host). service tcp-small-servers CF-526 Cisco IOS Configuration Fundamentals Command Reference April 2010 service tcp-small-servers To access minor TCP/IP services available from hosts on the network, use the service tcp-small-servers command in global configuration mode. To disable these services, use the no form of the command. service tcp-small-servers no service tcp-small-servers Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines By default, the TCP servers for Echo, Discard, Chargen, and Daytime services are disabled. When the minor TCP/IP servers are disabled, access to the Echo, Discard, Chargen, and Daytime ports cause the Cisco IOS software to send a TCP RESET packet to the sender and discard the original incoming packet. Examples The following example enables minor TCP/ IP services available from the network: Router(config)# service tcp-small-servers Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service telnet-zero-idle CF-527 Cisco IOS Configuration Fundamentals Command Reference April 2010 service telnet-zero-idle To set the TCP window to zero (0) when the Telnet connection is idle, use the service telnet-zero-idle command in global configuration mode. To disable this service, use the no form of this command. service telnet-zero-idle no service telnet-zero-idle Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines Normally, data sent to noncurrent Telnet connections is accepted and discarded. When the service telnet-zero-idle command is enabled, if a session is suspended (that is, some other connection is made active or the EXEC is sitting in command mode), the TCP window is set to zero. This action prevents the remote host from sending any more data until the connection is resumed. Use this command when it is important that all messages sent by the host be seen by the users and the users are likely to use multiple sessions. Do not use this command if your host will eventually time out and log out a TCP user whose window is zero. Examples The following example sets the TCP window to zero when the Telnet connection is idle: Router(config)# service telnet-zero-idle Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description resume Switches to another open Telnet, rlogin, LAT, or PAD session. service timestamps CF-528 Cisco IOS Configuration Fundamentals Command Reference April 2010 service timestamps To configure the system to apply a time stamp to debugging messages or system logging messages, use the service timestamps command in global configuration mode. To disable this service, use the no form of this command. service timestamps [debug | log] [uptime | datetime [msec]] [localtime] [show-timezone] [year] no service timestamps [debug | log] Syntax Description debug (Optional) Indicates time-stamping for debugging messages. log (Optional) Indicates time-stamping for system logging messages. uptime (Optional) Specifies that the time stamp should consist of the time since the system was last rebooted. For example “4w6d” (time since last reboot is 4 weeks and 6 days). • This is the default time-stamp format for both debugging messages and logging messages. • The format for uptime varies depending on how much time has elapsed: – HHHH:MM:SS (HHHH hours: MM minutes: SS seconds) for the first 24 hours – DdHHh (D days HH hours) after the first day – WwDd (W weeks D days) after the first week datetime (Optional) Specifies that the time stamp should consist of the date and time. • The time-stamp format for datetime is MMM DD HH:MM:SS, where MMM is the month, DD is the date, HH is the hour (in 24-hour notation), MM is the minute, and SS is the second. • If the datetime keyword is specified, you can optionally add the msec localtime, show-timezone, or year keywords. • If the service timestamps datetime command is used without addtional keywords, time stamps will be shown using UTC, without the year, without milliseconds, and without a time zone name. msec (Optional) Includes milliseconds in the time stamp, in the format HH:DD:MM:SS.mmm, where .mmm is milliseconds localtime (Optional) Time stamp relative to the local time zone. year (Optional) Include the year in the date-time format. show-timezone (Optional) Include the time zone name in the time stamp. Note If the localtime keyword option is not used (or if the local time zone has not been configured using the clock timezone command), time will be displayed in Coordinated Universal Time (UTC). service timestamps CF-529 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Default Time stamps are applied to debug and logging messages. Command Modes Global configuration (config) Command History Usage Guidelines Time stamps can be added to either debugging messages (service timestamp debug) or logging messages (service timestamp log) independently. If the service timestamps command is specified with no arguments or keywords, the default is service timestamps debug uptime. The no service timestamps command by itself disables time stamps for both debug and log messages. The uptime form of the command adds time stamps (such as “2w3d”) that indicating the time since the system was rebooted. The datetime form of the command adds time stamps (such as “Sep 5 2002 07:28:20”) that indicate the date and time according to the system clock. Entering the service timestamps {debug | log} command a second time will overwrite any previously configured service timestamp {debug | log} commands and associated options. To set the local time zone, use the clock timezone zone hours-offset command in global configuration mode. The time stamp will be preceeded by an asterisk or period if the time is potentially inaccurate. Table 48 describes the symbols that proceed the time stamp. Release Modification 10.0 This command was introduced. 11.3(5) Service time stamps are enabled by default. 12.3(1) The year keyword was added. 12.3(2)T This command was integrated into Cisco IOS Release 12.3(2)T. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB. Table 48 Time-Stamping Symbols for syslog Messages Symbol Description Example (blank) Time is authoritative: the software clock is in sync or has just been set manually 15:29:03.158 UTC Tue Feb 25 2003: * Time is not authoritative: the software clock has not been set, or is not in sync with configured Network Time Protocol (NTP) servers. 15:29:03.158 UTC Tue Feb 25 2003: . Time is authoritative, but the NTP is not synchronized: the software clock was in sync, but has since lost contact with all configured NTP servers. .15:29:03.158 UTC Tue Feb 25 2003: service timestamps CF-530 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples In the following example, the router begins with time-stamping disabled. Then, the default time-stamping is enabled (uptime time stamps applied to debug output). Then, the default time-stamping for logging is enabled (uptime time stamps applied to logging output). Router# show running-config | include time no service timestamps debug uptime no service timestamps log uptime Router# config terminal Router(config)# service timestamps ! issue the show running-config command in config mode using do Router(config)# do show running-config | inc time ! shows that debug timestamping is enabled, log timestamping is disabled service timestamps debug uptime no service timestamps log uptime ! enable timestamps for logging messages Router(config)# service timestamps log Router(config)# do show run | inc time service timestamps debug uptime service timestamps log uptime Router(config)# service sequence-numbers Router(config)# end 000075: 5w0d: %SYS-5-CONFIG_I: Configured from console by console ! The following is a level 5 system logging message ! The leading number comes from the service sequence-numbers command. ! 4w6d indicates the timestamp of 4 weeks, 6 days 000075: 4w6d: %SYS-5-CONFIG_I: Configured from console by console In the following example, the user enables time-stamping on logging messages using the current time and date in Coordinated Universal Time/Greenwich Mean Time (UTC/GMT), and enables the year to be shown. Router(config)# ! The following line shows the timestamp with uptime (1 week 0 days) 1w0d: %SYS-5-CONFIG_I: Configured from console by console Router(config)# service timestamps log datetime show-timezone year Router(config)# end ! The following line shows the timestamp with datetime (11:13 PM March 22nd) .Mar 22 2004 23:13:25 UTC: %SYS-5-CONFIG_I: Configured from console by console The following example shows the change from UTC to local time: Router# configure terminal ! Logging output can be quite long; first changing line width to show full ! logging message Router(config)# line 0 Router(config-line)# width 180 Router(config-line)# logging synchronous Router(config-line)# end service timestamps CF-531 Cisco IOS Configuration Fundamentals Command Reference April 2010 ! Timestamping already enabled for logging messages; time shown in UTC. Oct 13 23:20:05 UTC: %SYS-5-CONFIG_I: Configured from console by console Router# show clock 23:20:53.919 UTC Wed Oct 13 2004 Router# configure terminal Enter configuration commands, one per line. End with the end command. ! Timezone set as Pacific Standard Time, with an 8 hour offset from UTC Router(config)# clock timezone PST -8 Router(config)# Oct 13 23:21:27 UTC: %SYS-6-CLOCKUPDATE: System clock has been updated from 23:21:27 UTC Wed Oct 13 2004 to 15:21:27 PST Wed Oct 13 2004, configured from console by console. Router(config)# ! Pacific Daylight Time (PDT) configured to start in April and end in October. ! Default offset is +1 hour. Router(config)# clock summer-time PDT recurring first Sunday April 2:00 last Sunday October 2:00 Router(config)# ! Time changed from 3:22 P.M. Pacific Standard Time (15:22 PST) ! to 4:22 P.M. Pacific Daylight (16:22 PDT) Oct 13 23:22:09 UTC: %SYS-6-CLOCKUPDATE: System clock has been updated from 15:22:09 PST Wed Oct 13 2004 to 16:22:09 PDT Wed Oct 13 2004, configured from console by console. ! Change the timestamp to show the local time and timezone. Router(config)# service timestamps log datetime localtime show-timezone Router(config)# end Oct 13 16:23:19 PDT: %SYS-5-CONFIG_I: Configured from console by console Router# show clock 16:23:58.747 PDT Wed Oct 13 2004 Router# config t Enter configuration commands, one per line. End with the end command. Router(config)# service sequence-numbers Router(config)# end Router# In the following example, the service timestamps log datetime command is used to change previously configured options for the date-time time stamp. Router(config)# service timestamps log datetime localtime show-timezone Router(config)# end ! The year is not displayed. Oct 13 15:44:46 PDT: %SYS-5-CONFIG_I: Configured from console by console Router# config t service timestamps CF-532 Cisco IOS Configuration Fundamentals Command Reference April 2010 Enter configuration commands, one per line. End with the end command. Router(config)# service timestamps log datetime show-timezone year Router(config)# end ! note: because the localtime option was not specified again, that option is ! removed from the output, and time is displayed in UTC (the default) Oct 13 2004 22:45:31 UTC: %SYS-5-CONFIG_I: Configured from console by console Related Commands Command Description clock set Manually sets the system clock. ntp Controls access to the system’s NTP services. service sequence-numbers Stamps system logging messages with a sequence number. service udp-small-servers CF-533 Cisco IOS Configuration Fundamentals Command Reference April 2010 service udp-small-servers To access minor User Datagram Protocol (UDP) services available from hosts on the network, use the service udp-small-servers command in global configuration mode. To disable these services, use the no form of this command. service udp-small-servers no service udp-small-servers Syntax Description This command has no arguments or keywords. Defaults Disabled Command Modes Global configuration Command History Usage Guidelines By default the UPD servers for Echo, Discard, and Chargen services are disabled. When the servers are disabled, access to Echo, Discard, and Chargen ports causes the Cisco IOS software to send an “ICMP port unreachable” message to the sender and discard the original incoming packet. Examples In the following example, the UDP server (UDP services) is enabled: Router(config)# service udp-small-servers Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. service-module apa traffic-management CF-534 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module apa traffic-management To configure traffic management on the router, use the service-module apa traffic-management command in interface configuration mode. service-module apa traffic-management [ monitor | inline ] Syntax Description Command Default None Command Modes Interface configuration mode Command History Usage Guidelines To perform traffic management, you enable or disable the flow of packets by configuring the service module interface and the router interface. • Configure the router interface with the service-module apa traffic-management [monitor | inline] command. Two traffic management options are available: – Monitor—will copy the packet and designate the copy as the one forwarded to the Application Performance Assurance module (NME-APA). – Inline—will send the packet to the NME-APA, rather than sending a copy of the packet. After the NME-APA has processes the packet, it sends it back to the router. Note Enable only one traffic management option on the router, but not both concurrently. • Configure the service module interface with the Application Performance Assurance (APA) graphical user interface (GUI). See the Cisco Application Performance Assurance User Guide on Cisco.com for details. monitor Enables promiscuous monitoring. inline Enables inline monitoring. Release Modification 12.4(20)YA This command was introduced for the NME-APA on Cisco 2811, 2821, 2851, and Cisco 3800 Series Integrated Services Routers. service-module apa traffic-management CF-535 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example configures an interface on a Cisco 2851 Integrated Services Router for inline traffic management. Router> enable Router# configure terminal Router(config)# interface gigabitethernet 0/1 Router(config-if)# ip address 10.10.10.43 255.255.255.0 Router(config-if)# service-module apa traffic-management inline Router(config-if)# exit end Related Commands Command Description interface gigabitethernet Defines the interface on the router ip address Defines the IP address and subnet mask on the interface service-module wlan-ap bootimage CF-536 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap bootimage To configure the boot image on the service module, use the service-module wlan-ap bootimage command in privileged EXEC mode. service-module wlan-ap interface number bootimage [autonomous|unified] Syntax Description Command Default Autonomous software image Command Modes Privileged EXEC Command History Usage Guidelines When running the advanced IP services feature set on either Cisco 880 Series routers or Cisco 890 Series routers, use the service-module wlan-ap 0 bootimage unified command to enable the Cisco unified software upgrade image on the embedded wireless access point. After enabling the unified image, use the service-module wlan-ap 0 reload command to perform a graceful shutdown and reboot of the access point. Note The service-module wlan-ap 0 bootimage command does not support recovery images on the embedded access point. Use the service-module wlan-ap 0 reload command to shutdown and reboot the access point. Cisco 880 Series and Cisco 890 Series routers with embedded access point running the unified software image require DHCP to obtain an IP address for the access point. An IP address is needed to communicate with the Wireless LAN Controller (WLC) and to download its image upon boot up. The host router can provide DHCP server functionality through the DHCP pool to reach the WLC, and setup option 43 for the controller IP address in the DHCP pool configuration. Use the following guideline to setup a DHCP pool on the host router. ip dhcp pool embedded-ap-pool network 60.0.0.0 255.255.255.0 default router 60.0.0.1 option 43 hex f104.0a0a.0a0f / Single WLC IP address (10.10.10.15) in HEX format / int vlan 1 / Default Vlan / ip address 60.0.0.1 255.255.255.0 int Wlan-GigabitEthernet0 / internal switch-port to AP / switchport access vlan 1 interface number The interface number for the wireless device. Always use 0. autonomous Autonomous software image. unified Upgrade image with Lightweight Access Point Protocol (LWAPP). Release Modification 12.4(20) T This command was introduced for wireless-enabled Cisco 880 Series and Cisco 890 Series Integrated Services Routers. service-module wlan-ap bootimage CF-537 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following example upgrades the embedded access point image from autonomous to unified. Router#configure terminal Router(config)#service-module wlan-ap 0 bootimage unified Jan 18 05:31:58.172: %WLAN_AP_SM-6-UNIFIED_IMAGE: Embedded AP will change boot image to mini-IOS also called LWAPP recovery Please check router config to ensure connectivity between WLC and AP. Use service-module wlan-ap 0 reload to bootup mini-IOS image on AP Router(config)#end Router# Jan 18 05:32:04.136: %SYS-5-CONFIG_I: Configured from console by console Router#service-module wlan-ap 0 reload Reload will save AP config.... Do you want to proceed with reload?[confirm] Trying to reload Service Module wlan-ap0. Router# Service Module saved config, start reset. Received reload request from router Saving configuration... Building configuration... Related Commands Command Description interface wlan-ap Enters wireless interface configuration mode to configure an interface. service-module wlan-ap reload Performs a graceful shutdown and reboot of the service module. service-module wlan-ap reset Resets the service module hardware. service-module wlan-ap reload CF-538 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap reload To perform a graceful shutdown and reboot of the service module use the service-module wlan-ap reload command in privileged EXEC mode. service-module wlan-ap interface number reload Syntax Description Command Default None Command Modes Privileged EXEC Command History Usage Guidelines Autonomous Mode At the confirmation prompt, press Enter to confirm the action, or press n to cancel. Note When running in autonomous mode, the reload command saves the configuration before rebooting. If the attempt is unsuccessful, the following message displays: Failed to save service module configuration. Unified Mode The service module reload command is usually handled by the Wireless LAN Controller (WLC). Note When running in Unified mode, the reload command will produce the following message: The embedded wireless device is in Unified mode. Reload/reset is normally handled by WLC controller. Still want to proceed? [yes] interface number The interface number for the wireless device. Always use 0. Release Modification 12.4(20)T This command was introduced for wireless-enabled Cisco 860, 880, and 890 Integrated Services Routers. service-module wlan-ap reload CF-539 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples The following examples show a graceful shut down and reboot of the service module: Autonomous Mode Router# service-module wlan-ap0 reload Do you want to proceed with reload?[confirm] Router# reload Do you want to reload the internal AP ? [yes/no]: Do you want to save the configuration of the AP ? [yes/no]: System configuration has been modified. Save [yes/no]: Proceed with reload? [confirm] Unified Mode Router# service-module wlan-ap0 reload The embedded AP is in Unified mode. Reload/reset is normally handled by WLC controller. Still want to proceed? [yes] Router# reload The embedded AP is in Unified mode. Reload/reset is normally handled by WLC controller. Do you want to reload the internal AP [yes/no]: System configuration has been modified. Save [yes/no]: Proceed with reload [Confirm] Related Commands Command Description interface wlan-ap Enters wireless interface configuration mode to configure an interface. service-module wlan-ap reset Resets the service module hardware. service-module wlan-ap reset CF-540 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap reset To reset the service module hardware, software, and configuration, use the service-module wlan-ap reset command in privileged EXEC mode. service-module wlan-ap interface number reset [bootloader | default-config] Syntax Description Command Default None Command Modes Privileged EXEC Command History Usage Guidelines At the confirmation prompt, press Enter to confirm the action, or press n to cancel. Caution Because you may lose data, use the service-module wlan-ap reset command only to recover from a shutdown or failed state. Examples The following example resets a wireless device on a router that is operating in either autonomous mode or LWAPP mode: Autonomous Mode Router# service-module wlan-ap0 reset Use reset only to recover from shutdown or failed state. LWAPP Mode Router# service-module wlan-ap0 reset The embedded device is in LWAPP mode. Reload/reset is normally handled by WLC controller. Still want to proceed? [yes] interface number The interface number for the wireless device. Always use 0. bootloader Resets the wireless device to the bootloader for manual image recovery. default-config Resets the wireless device to the factory default configuration. Release Modification 12.4(20)T This command was introduced for wireless-enabled Cisco 860, 880, and 890 Integrated Services Routers. service-module wlan-ap reset CF-541 Cisco IOS Configuration Fundamentals Command Reference April 2010 Resetting the Factory Default Configuration on the Wireless Device The following example resets the wireless device to the default configuration. Router#service-module wlan-ap 0 reset default-config Router# Recovering the Image on the Wireless Device The following example resets the wireless device down to the bootloader level for manual image recovery. Router#service-module wlan-ap0 reset bootloader Router# Related Commands Command Description interface wlan-ap Enters wireless interface configuration mode to configure an interface. service-module wlan-ap reload Performs a graceful shutdown and reboot of the service module. service-module wlan-ap session CF-542 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap session To begin a configuration session with a service module through a console connection use the service-module wlan-ap session command in privileged EXEC mode. service-module wlan-ap interface number session [clear | disconnect] Syntax Description Command Default None Command Modes Privileged EXEC Command History Usage Guidelines Only one session is allowed at a time into the wireless device from a router console-port connection. After starting a session, perform configuration tasks on the wireless device. You first access the router in a user-level shell. To access the privileged EXEC command shell, where most commands are available, use the enable command. When you finish configuring the device, and would like to exit the console session, type Ctrl-Shift 6x to return to the router’s console. Type service-module wlan-ap session clear or disconnect to close the session with the device. At the confirmation prompt, press Enter twice to confirm the action or n to cancel. Note If you do not clear or disconnect the session on the service module, it will remain open in the background after you return to the router’s console prompt. When the session is open in the background, pressing Enter will toggle you back to the wireless device prompt. Examples The following example shows a session being opened on a service-module in an ISR: Router# service-module wlan-ap 0 session Trying 1.2.3.4, 2002 ... Open AP# The following example clears the session on the service-module in the ISR: Router#service-module wlan-ap 0 session clear [confirm] [OK] interface number The interface number for the wireless device. Always use 0. clear (Optional) Clears the wireless device configuration session. Release Modification 12.4(20)T This command was introduced for wireless-enabled Cisco 860, 880, and 890 Integrated Services Routers. service-module wlan-ap session CF-543 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description enable Enters privileged EXEC mode. interface wlan-ap Enters wireless interface configuration mode to configure an interface. service-module wlan-ap statistics CF-544 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap statistics To display reset and reload information for a service module and its operating system software, use the service-module wlan-ap statistics command in privileged EXEC mode. service-module wlan-ap interface number statistics Syntax Description Command Default none Command Modes Privileged EXEC Command History Examples The following example displays information for wireless-enabled Cisco ISRs: Router#service-module wlan-ap 0 statistics Module Reset Statistics: CLI reset count = 0 CLI reload count = 1 Registration request timeout reset count = 0 Error recovery timeout reset count = 0 Module registration count = 10 The last IOS initiated event was a cli reload at 04:27:32.041 UTC Fri Mar 8 2007 Related Commands interface number The interface number for the wireless device. Always use 0. Release Modification 12.4(20)T This command was introduced for wireless-enabled Cisco 860, 880, and 890 Integrated Services Routers. Command Description interface wlan-ap Enters wireless interface configuration mode and configures a wireless device. service-module wlan-ap reset Resets the wireless device. service-module wlan-ap reload Performs a graceful shutdown and reboot on the wireless device. service-module wlan-ap status CF-545 Cisco IOS Configuration Fundamentals Command Reference April 2010 service-module wlan-ap status To display configuration information related to hardware and software on the service module, use the service-module wlan-ap status command in privileged EXEC mode. service-module wlan-ap interface number status Syntax Description Command Default None Command Modes Privileged EXEC Command History Usage Guidelines Use the service-module wlan-ap status command to • Display the wireless device’s software release version • Check the wireless device’s status (steady or down) • Display hardware information for the wireless device, including image, memory, interface, and system uptime Examples The following example displays information for the wireless device on a Cisco Integrated Services Router: Router#service-module wlan-ap 0 status Service Module is Cisco wlan-ap0 Service Module supports session via TTY line 2 Service Module is in Steady state Service Module reset on error is disabled Getting status from the Service Module, please wait.. Image path = flash:c8xx_19xx_ap-k9w7-mx.acregr/c8xx_19xx_ap-k9w7-mx.acre gr System uptime = 0 days, 4 hours, 28 minutes, 5 seconds Router#d was introduced for embedded wireless LAN access points on Cisco 860 and 880 Series Integrated Services Routers. interface number The interface number for the wireless device. Aways use 0. Release Modification 12.4(20)T This command was introduced for wireless-enabled Cisco 860, 880, and 890 Integrated Services Routers. session slot CF-546 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands session slot To open a session with a module (for example, the Multilayer Switch Module (MSM), Network Analysis Module (NAM), or Asynchronous Transfer Mode (ATM)), use the session slot command in EXEC mode. session slot mod processor processor-id Syntax Description Defaults This command has no default settings. Command Modes EXEC Command History Usage Guidelines To end the session, enter the quit command. This command allows you to use the module-specific CLI. Examples This example shows how to open a session with an MSM (module 4): Router# session slot 4 processor 2 Router# Command Description interface wlan-ap Enters wireless service module's console interface. mod Slot number. processor processor-id Specifies the processor ID. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. set memory debug incremental starting-time CF-547 Cisco IOS Configuration Fundamentals Command Reference April 2010 set memory debug incremental starting-time To set the current time as the starting time for incremental analysis, use the set memory debug incremental starting-time command in privileged EXEC mode. set memory debug incremental starting-time [none] Syntax Description Defaults No default behavior or values. Command Modes Privileged EXEC Command History Usage Guidelines For incremental analysis, a starting point can be defined by using the set memory debug incremental starting-time command. When a starting time is set, only memory allocated after that starting time will be considered for reporting as leaks. Examples The following example shows the command used to set the starting time for incremental analysis to the time when the command was issued: Router# set memory debug incremental starting-time Related Commands none (Optional) Resets the defined start time for incremental analysis. Release Modification 12.3(8)T1 This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show memory debug incremental allocation Displays all memory blocks that were allocated after the issue of the set memory debug incremental starting-time command. show memory debug incremental leaks Displays only memory that was leaked after the issue of the set memory debug incremental starting-time command. show memory debug incremental leaks lowmem Forces incremental memory leak detection to work in low memory mode. Displays only memory that was leaked after the issue of the set memory debug incremental starting-time command. show memory debug incremental status Displays if the starting point of incremental analysis has been defined and the time elapsed since then. show memory debug leaks Displays detected memory leaks. setup CF-548 Cisco IOS Configuration Fundamentals Command Reference April 2010 setup To enter Setup mode, use the setup command in privileged EXEC mode. setup Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines Setup mode gives you the option of configuring your system without using the Cisco IOS Command Line Interface (CLI). For some tasks, you may find it easier to use Setup than to enter Cisco IOS commands individually. For example, you might want to use Setup to add a protocol suite, to make major addressing scheme changes, or to configure a newly installed interface. Although you can use the CLI to make these changes, Setup provides you with a high-level view of the configuration and guides you through the configuration process. If you are not familiar with Cisco products and the CLI, Setup is a particularly valuable tool because it prompts you for the specific information required to configure your system. Note If you use the Setup mode to modify a configuration because you have added or modified the hardware, be sure to verify the physical connections using the show version EXEC command. Also, verify the logical port assignments using the show running-config EXEC command to ensure that you configure the correct port. Refer to the hardware documentation for your platform for more information on physical and logical port assignments. Before using the Setup mode, you should have the following information so that you can configure the system properly: • Which interfaces you want to configure • Which routing protocols you wish to enable • Whether the router is to perform bridging • Network addresses for the protocols being configured • Password strategy for your environment When you enter the setup EXEC command after first-time startup, an interactive dialog called the System Configuration Dialog appears on the system console screen. The System Configuration Dialog guides you through the configuration process. It prompts you first for global parameters and then for interface parameters. The values shown in brackets next to each prompt reflect either the default settings or the last configured setting. Release Modification 11.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. setup CF-549 Cisco IOS Configuration Fundamentals Command Reference April 2010 The prompts and the order in which they appear on the screen vary depending on the platform and the interfaces installed in the device. You must progress through the System Configuration Dialog until you come to the item that you intend to change. To accept default settings for items that you do not want to change, press the Return or Enter key. The default choice is indicated by square brackets (for example, [yes]) before the prompt colon (:). To exit Setup mode and return to privileged EXEC mode without making changes and without progressing through the entire System Configuration Dialog, press Ctrl-C. The facility also provides help text for each prompt. To access help text, press the question mark (?) key at a prompt. When you complete your changes, the system will automatically display the configuration file that was created during the Setup session. It also asks you if you want to use this configuration. If you answer Yes, the configuration is saved to NVRAM as the startup configuration file. If you answer No, the configuration is not saved and the process begins again. There is no default for this prompt; you must answer either Yes or No. Examples The following example displays the setup command facility to configure serial interface 0 and to add ARAP and IP/IPX PPP support on the asynchronous interfaces: Router# setup --- System Configuration Dialog --- At any point you may enter a question mark '?' for help. Use ctrl-c to abort configuration dialog at any prompt. Default settings are in square brackets '[]'. Continue with configuration dialog? [yes]: First, would you like to see the current interface summary? [yes]: Interface IP-Address OK? Method Status Protocol Ethernet0 172.16.72.2 YES manual up up Serial0 unassigned YES not set administratively down down Serial1 172.16.72.2 YES not set up up Configuring global parameters: Enter host name [Router]: The enable secret is a one-way cryptographic secret used instead of the enable password when it exists. Enter enable secret []: The enable password is used when there is no enable secret and when using older software and some boot images. Enter enable password [ww]: Enter virtual terminal password [ww]: Configure SNMP Network Management? [yes]: Community string [public]: Configure DECnet? [no]: Configure AppleTalk? [yes]: Multizone networks? [no]: yes Configure IPX? [yes]: Configure IP? [yes]: setup CF-550 Cisco IOS Configuration Fundamentals Command Reference April 2010 Configure IGRP routing? [yes]: Your IGRP autonomous system number [15]: Configure Async lines? [yes]: Async line speed [9600]: 57600 Configure for HW flow control? [yes]: Configure for modems? [yes/no]: yes Configure for default chat script? [yes]: no Configure for Dial-in IP SLIP/PPP access? [no]: yes Configure for Dynamic IP addresses? [yes]: no Configure Default IP addresses? [no]: yes Configure for TCP Header Compression? [yes]: no Configure for routing updates on async links? [no]: Configure for Async IPX? [yes]: Configure for Appletalk Remote Access? [yes]: AppleTalk Network for ARAP clients [1]: 20 Zone name for ARAP clients [ARA Dialins]: Configuring interface parameters: Configuring interface Ethernet0: Is this interface in use? [yes]: Configure IP on this interface? [yes]: IP address for this interface [172.16.72.2]: Number of bits in subnet field [8]: Class B network is 172.16.0.0, 8 subnet bits; mask is /24 Configure AppleTalk on this interface? [yes]: Extended AppleTalk network? [yes]: AppleTalk starting cable range [1]: AppleTalk ending cable range [1]: AppleTalk zone name [Sales]: AppleTalk additional zone name: Configure IPX on this interface? [yes]: IPX network number [1]: Configuring interface Serial0: Is this interface in use? [no]: yes Configure IP on this interface? [no]: yes Configure IP unnumbered on this interface? [no]: yes Assign to which interface [Ethernet0]: Configure AppleTalk on this interface? [no]: yes Extended AppleTalk network? [yes]: AppleTalk starting cable range [2]: 3 AppleTalk ending cable range [3]: 3 AppleTalk zone name [myzone]: ZZ Serial AppleTalk additional zone name: Configure IPX on this interface? [no]: yes IPX network number [2]: 3 Configuring interface Serial1: Is this interface in use? [yes]: Configure IP on this interface? [yes]: Configure IP unnumbered on this interface? [yes]: Assign to which interface [Ethernet0]: Configure AppleTalk on this interface? [yes]: Extended AppleTalk network? [yes]: AppleTalk starting cable range [2]: AppleTalk ending cable range [2]: AppleTalk zone name [ZZ Serial]: AppleTalk additional zone name: Configure IPX on this interface? [yes]: IPX network number [2]: Configuring interface Async1: IPX network number [4]: Default client IP address for this interface [none]: 172.16.72.4 setup CF-551 Cisco IOS Configuration Fundamentals Command Reference April 2010 Configuring interface Async2: IPX network number [5]: Default client IP address for this interface [172.16.72.5]: Configuring interface Async3: IPX network number [6]: Default client IP address for this interface [172.16.72.6]: Configuring interface Async4: IPX network number [7]: Default client IP address for this interface [172.16.72.7]: Configuring interface Async5: IPX network number [8]: Default client IP address for this interface [172.16.72.8]: Configuring interface Async6: IPX network number [9]: Default client IP address for this interface [172.16.72.9]: Configuring interface Async7: IPX network number [A]: Default client IP address for this interface [172.16.72.10]: Configuring interface Async8: IPX network number [B]: Default client IP address for this interface [172.16.72.11]: Configuring interface Async9: IPX network number [C]: Default client IP address for this interface [172.16.72.12]: Configuring interface Async10: IPX network number [D]: Default client IP address for this interface [172.16.72.13]: Configuring interface Async11: IPX network number [E]: Default client IP address for this interface [172.16.72.14]: Configuring interface Async12: IPX network number [F]: Default client IP address for this interface [172.16.72.15]: Configuring interface Async13: IPX network number [10]: Default client IP address for this interface [172.16.72.16]: Configuring interface Async14: IPX network number [11]: Default client IP address for this interface [172.16.72.17]: Configuring interface Async15: IPX network number [12]: Default client IP address for this interface [172.16.72.18]: Configuring interface Async16: IPX network number [13]: Default client IP address for this interface [172.16.72.19]: The following configuration command script was created: hostname Router enable secret 5 $1$krIg$emfYm/1OwHVspDuS8Gy0K1 enable password ww line vty 0 4 password ww snmp-server community public ! no decnet routing appletalk routing ipx routing ip routing ! line 1 16 speed 57600 flowcontrol hardware modem inout setup CF-552 Cisco IOS Configuration Fundamentals Command Reference April 2010 ! arap network 20 ARA Dialins line 1 16 arap enable autoselect ! ! Turn off IPX to prevent network conflicts. interface Ethernet0 no ipx network interface Serial0 no ipx network interface Serial1 no ipx network ! interface Ethernet0 ip address 172.16.72.2 255.255.255.0 appletalk cable-range 1-1 1.204 appletalk zone Sales ipx network 1 no mop enabled ! interface Serial0 no shutdown no ip address ip unnumbered Ethernet0 appletalk cable-range 3-3 appletalk zone ZZ Serial ipx network 3 no mop enabled ! interface Serial1 no ip address ip unnumbered Ethernet0 appletalk cable-range 2-2 2.2 appletalk zone ZZ Serial ipx network 2 no mop enabled ! Interface Async1 ipx network 4 ip unnumbered Ethernet0 peer default ip address 172.16.72.4 async mode interactive ! Interface Async2 ipx network 5 ip unnumbered Ethernet0 peer default ip address 172.16.72.5 async mode interactive ! Interface Async3 ipx network 6 ip unnumbered Ethernet0 peer default ip address 172.16.72.6 async mode interactive ! Interface Async4 ipx network 7 ip unnumbered Ethernet0 peer default ip address 172.16.72.7 async mode interactive async dynamic address ! Interface Async5 setup CF-553 Cisco IOS Configuration Fundamentals Command Reference April 2010 ipx network 8 ip unnumbered Ethernet0 peer default ip address 172.16.72.8 async mode interactive ! Interface Async6 ipx network 9 ip unnumbered Ethernet0 peer default ip address 172.16.72.9 async mode interactive ! Interface Async7 ipx network A ip unnumbered Ethernet0 peer default ip address 172.16.72.10 async mode interactive ! Interface Async8 ipx network B ip unnumbered Ethernet0 peer default ip address 172.16.72.11 async mode interactive ! Interface Async9 ipx network C ip unnumbered Ethernet0 peer default ip address 172.16.72.12 async mode interactive ! Interface Async10 ipx network D ip unnumbered Ethernet0 peer default ip address 172.16.72.13 async mode interactive ! Interface Async11 ipx network E ip unnumbered Ethernet0 peer default ip address 172.16.72.14 async mode interactive ! Interface Async12 ipx network F ip unnumbered Ethernet0 peer default ip address 172.16.72.15 async mode interactive ! Interface Async13 ipx network 10 ip unnumbered Ethernet0 peer default ip address 172.16.72.16 async mode interactive ! Interface Async14 ipx network 11 ip unnumbered Ethernet0 peer default ip address 172.16.72.17 async mode interactive ! Interface Async15 ipx network 12 ip unnumbered Ethernet0 peer default ip address 172.16.72.18 async mode interactive setup CF-554 Cisco IOS Configuration Fundamentals Command Reference April 2010 ! Interface Async16 ipx network 13 ip unnumbered Ethernet0 peer default ip address 172.16.72.19 async mode interactive ! router igrp 15 network 172.16.0.0 ! end Use this configuration? [yes/no]: yes Building configuration... Use the enabled mode 'configure' command to modify this configuration. Router# Related Commands Command Description erase nvram: Erases a file system. show running-config Displays the running configuration file. Command alias for the more system:running-config command. show startup-config Displays the startup configuration file. Command alias for the more system:startup-config command. show version Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images. show CF-555 Cisco IOS Configuration Fundamentals Command Reference April 2010 show To verify the Multiple Spanning Tree (MST) configuration, use the show command. in MST configuration submode. show [current | pending] Syntax Description Defaults This command has no default settings. Command Modes MST configuration submode Command History Usage Guidelines The display output from the show pending command is the edited configuration that will replace the current configuration if you enter the exit command to exit MST configuration mode. Entering the show command with no arguments displays the pending configurations. Examples This example shows how to display the edited configuration: Router(config-mst)# show pending Pending MST configuration Name [zorglub] Version 31415 Instance Vlans Mapped -------- --------------------------------------------------------------------- 0 4001-4096 2 1010, 1020, 1030, 1040, 1050, 1060, 1070, 1080, 1090, 1100, 1110 1120 3 1-1009, 1011-1019, 1021-1029, 1031-1039, 1041-1049, 1051-1059 1061-1069, 1071-1079, 1081-1089, 1091-1099, 1101-1109, 1111-1119 1121-4000 ------------------------------------------------------------------------------ Router(config-mst)# This example shows how to display the current configuration: Router(config-mst)# show current current (Optional) Displays the current configuration that is used to run MST. pending (Optional) Displays the edited configuration that will replace the current configuration. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show CF-556 Cisco IOS Configuration Fundamentals Command Reference April 2010 Current MST configuration Name [] Revision 0 Instance Vlans mapped -------- --------------------------------------------------------------------- 0 1-4094 ------------------------------------------------------------------------------- Related Commands Command Description instance Maps a VLAN or a set of VLANs to an MST instance. name (MST configuration submode) Sets the name of an MST region. revision Sets the revision number for the MST configuration. show spanning-tree mst Displays the information about the MST protocol. spanning-tree mst configuration Enters MST-configuration submode. show append CF-557 Cisco IOS Configuration Fundamentals Command Reference April 2010 show append To redirect and add the output of any show command to an existing file, use the show command | append command in privileged EXEC mode. show command | append url Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines To display all URL prefixes that are supported for this command, use the show command | append ? command. This command adds the show command output to the end of the specified file. Examples In the following example, output from the show tech-support command is redirected to an existing file on Disk 1 with the file-name of “showoutput.txt.” This output is added at the end of any existing data in the file. Router# show tech-support | append disk1:showoutput.txt Related Commands command Any Cisco IOS show command. | append url The addition of this syntax redirects the command output to the file location specified in the Universal Resource Locator (URL). The pipe (|) is required. The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename Prefixes can be local file locations, such as flash: or disk0:. Alternatively, you can specify network locations using the following syntax: ftp:[[//[username[:password]@]location]/directory]/filename tftp:[[//location]/directory]/filename The rcp: prefix is not supported. Release Modification 12.0(21)S This command was introduced. 12.2(13)T This command was integrated into Cisco IOS Release 12.2(13)T. Command Description show redirect Redirects the output of any show command to a specified file. show tee Copies the show command output to a file while displaying it on the terminal. show begin CF-558 Cisco IOS Configuration Fundamentals Command Reference April 2010 show begin To begin the output of any show command from a specified string, use the show command | begin command in EXEC mode. show command | begin regular-expression Syntax Description Command Modes EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. Use parenthesis to indicate a literal use of spaces. For example, | begin u indicates that the show output should begin with any line that contains a u; | begin ( u) indicates that the show output should begin with any line that contains a space and a u together (line has a word that begins with a lowercase u). To search the remaining output of the show command, use the following command at the --More-- prompt: /regular-expression You can specify a filtered search at any --More-- prompt. To filter the remaining output of the show command, use one of the following commands at the --More-- prompt: -regular-expression +regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-z. command Any supported show command. | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in show command output. The show output will begin from the first instance of this string (output prior to this string will not be printed to the screen). The string is case-sensitive. Use parenthesis to indicate a literal use of spaces. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. - Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression. + Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression. Release Modification 8.3 The show command was introduced. 12.0(1)T This extension of the show command was introduced.. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show begin CF-559 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note Once you specify a filter for a show command, you cannot specify another filter at the next --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter. Because prior output is not saved, you cannot search or filter backward through prior output. Note A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output. Examples The following is partial sample output of the show interface | begin command that begins unfiltered output with the first line that contains the regular expression “Ethernet.” At the --More-- prompt, the user specifies a filter to show only the lines in the remaining output that contain the regular expression “Serial.” Router# show interface | begin Ethernet Ethernet0 is up, line protocol is up Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399) Description: ip address is 172.1.2.14 255.255.255.0 Internet address is 172.1.2.14/24 . . . 0 lost carrier, 0 no carrier 0 output buffer failures, 0 output buffers swapped out --More-- +Serial filtering... Serial1 is up, line protocol is up Serial2 is up, line protocol is up Serial3 is up, line protocol is down Serial4 is down, line protocol is down Serial5 is up, line protocol is up Serial6 is up, line protocol is up Serial7 is up, line protocol is up Related Commands Command Description more begin Begins unfiltered output of the more command with the first line that contains the regular expression you specify. more exclude Filters more command output so that it excludes lines that contain a particular regular expression. more include Filters more command output so that it displays only lines that contain a particular regular expression. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show include Filters show command output so that it displays only lines that contain a particular regular expression. show exclude CF-560 Cisco IOS Configuration Fundamentals Command Reference April 2010 show exclude To filter show command output so that it excludes lines that contain a particular regular expression, use the show command | exclude command in EXEC mode. show command | exclude regular-expression Syntax Description Command Modes EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt: /regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z. Because prior output is not saved, you cannot search or filter backward through prior output. Note A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output. Examples The following is partial sample output of the show | exclude command used with the show buffers command. It excludes lines that contain the regular expression “0 misses.” At the --More-- prompt, the user searches for the regular expression “Serial0,” which continues the filtered output with the first line that contains “Serial0.” Router# show buffers | exclude 0 misses Buffer elements: 398 in free list (500 max allowed) Public buffer pools: command Any supported show command. | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in show command output. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. Release Modification 12.0(1)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show exclude CF-561 Cisco IOS Configuration Fundamentals Command Reference April 2010 Small buffers, 104 bytes (total 50, permanent 50): 50 in free list (20 min, 150 max allowed) 551 hits, 3 misses, 0 trims, 0 created Big buffers, 1524 bytes (total 50, permanent 50): 49 in free list (5 min, 150 max allowed) Very Big buffers, 4520 bytes (total 10, permanent 10): . . . Huge buffers, 18024 bytes (total 0 permanent 0): 0 in free list (0 min, 4 max allowed) --More-- /Serial0 filtering... Serial0 buffers, 1543 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks Related Commands Command Description more begin Begins unfiltered output of the more command with the first line that contains the regular expression you specify. more exclude Filters more command output so that it excludes lines that contain a particular regular expression. more include Filters more command output so that it displays only lines that contain a particular regular expression. show begin Searches the output of any show command and displays the output from the first instance of a specified string. show include Filters show command output so that it displays only lines that contain a particular regular expression. show include CF-562 Cisco IOS Configuration Fundamentals Command Reference April 2010 show include To filter show command output so that it only displays lines that contain a particular regular expression, use the show command | include command in EXEC mode. show command | include regular-expression Syntax Description Command Modes EXEC Command History Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements. You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt: /regular-expression When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z. Because prior output is not saved, you cannot search or filter backward through prior output. Note A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output. Examples The following is partial sample output of the show interface | include command. It displays only lines that contain the regular expression “( is ).” The parentheses force the inclusion of the spaces before and after “is.” Use of the parenthesis ensures that only lines containing “is” with a space both before and after it will be included in the output. Lines with words like “disconnect” will be excluded because there are not spaces around the instance of the string “is”. Router# show interface | include ( is ) command Any supported show command. | A vertical bar (the “pipe” symbol) indicates that an output processing specification follows. regular-expression Any regular expression found in show command output. Use parenthesis to include spaces in the expression. / Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression. Release Modification 12.0(1)T This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show include CF-563 Cisco IOS Configuration Fundamentals Command Reference April 2010 ATM0 is administratively down, line protocol is down Hardware is ATMizer BX-50 Dialer1 is up (spoofing), line protocol is up (spoofing) Hardware is Unknown DTR is pulsed for 1 seconds on reset Ethernet0 is up, line protocol is up Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399) Internet address is 172.21.53.199/24 Ethernet1 is up, line protocol is up Hardware is Lance, address is 0060.837c.639c (bia 0060.837c.639c) Internet address is 5.5.5.99/24 Serial0:0 is down, line protocol is down Hardware is DSX1 . . . --More-- At the --More-- prompt, the user searches for the regular expression “Serial0:13”, which continues filtered output with the first line that contains “Serial0:13.” /Serial0:13 filtering... Serial0:13 is down, line protocol is down Hardware is DSX1 Internet address is 11.0.0.2/8 0 output errors, 0 collisions, 2 interface resets Timeslot(s) Used:14, Transmitter delay is 0 flags Related Commands Command Description more begin Begins unfiltered output of the more command with the first line that contains the regular expression you specify. more exclude Filters more command output so that it excludes lines that contain a particular regular expression. more include Filters more command output so that it displays only lines that contain a particular regular expression. show begin Searches the output of any show command and displays the output from the first instance of a specified string. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show redirect CF-564 Cisco IOS Configuration Fundamentals Command Reference April 2010 show redirect To redirect the output of any show command to a file, use the show command | redirect command in privileged EXEC mode. show command | redirect url Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines To display all URL prefixes that are supported for this command, use the show command | redirect ? command. This command creates a new file at the specified location, or overwrites an existing file. Examples In the following example, output from the show tech-support command is write to the file “showtech.txt” on the host at 172.16.101.101 in the directory “//tftpboot/docs/” using FTP: Router# show tech | redirect ftp://USER:MYPASSWORD@172.16.101.101//tftpboot/docs/showtech.txt Related Commands command Any Cisco IOS show command. | redirect url The addition of this syntax redirects the command output to the file location specified in the Universal Resource Locator (URL). The pipe (|) is required. The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename Prefixes can be local file locations, such as flash: or disk0:. Alternatively, you can specify network locations using the following syntax: ftp:[[//[username[:password]@]location]/directory]/filename tftp:[[//location]/directory]/filename The rcp: prefix is not supported. Release Modification 12.0(21)S This command was introduced. 12.2(13)T This command was integrated into Cisco IOS Release 12.2(13)T. Command Description show append Redirects and appends show command output to the end of an existing file. show tee Copies the show command output to a file while displaying it on the terminal. show section CF-565 Cisco IOS Configuration Fundamentals Command Reference April 2010 show section To filter the output of a show command to match a given expression as well as any lines associated with that expression, use the show command section command in privileged EXEC mode. show command | section [include | exclude] regular-expression Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines In many cases, it is useful to filter the output of a show command to match a specific expression. Filtering provides some control over the type and amount of information displayed by the system. The show section command provides enhanced filtering capabilities by matching lines in the show command output containing specific expressions as well as matching any entries associated with those expressions. Filtering is especially useful, for example, when displaying large configuration files using the show running-configuration command or the show interfaces command. If the include or exclude keyword is not specified, include is the default. If there are no associated entries for an expression, then only the line matching the expression is displayed. Examples The following examples compare the filtering characteristics of the show running-config | include command with the show running-config | section command. The first example gathers just the lines from the configuration file with “interface” in them. Router# show running-config | include interface interface Ethernet0/0 interface Ethernet1/0 interface Serial2/0 interface Serial3/0 The next example uses the show command section command to gather the lines in the configuration file with “interface” in them as well as any lines associated with those entries. In this example, interface configuration information is captured. command Any Cisco IOS show command. include (Optional) Includes only the lines that contain a particular regular expression. This is the default keyword when none is specified. exclude (Optional) Excludes any lines that contain a particular regular expression. regular-expression Any regular expression or plain text string found in show command output. The syntax of the regular expression conforms to that of Bell V8 regexp(3). Release Modification 12.3(2)T This command was introduced. 12.2(33)SRE This command was integrated into Cisco IOS release 12.(33)SRE. show section CF-566 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router# show running-config | section include interface interface Ethernet0/0 shutdown no cdp enable interface Ethernet1/0 shutdown no cdp enable interface Serial2/0 shutdown no cdp enable interface Serial3/0 shutdown no cdp enable Related Commands Command Description show append Redirects the output of any show command and adds it to the end of an existing file. show exclude Filters show command output so that it excludes lines that contain a particular regular expression. show include Filters show command output so that it displays only lines that contain a particular regular expression. show redirect Redirects the output of any show command to a specified file. show tee CF-567 Cisco IOS Configuration Fundamentals Command Reference April 2010 show tee To copy the output of any show command to a file while displaying it on the terminal, use the show command | tee command in privileged EXEC mode. show command | tee [/append] url Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines To display all URL prefixes that are supported for this command, use the show command | tee ? command. The tee keyword was chosen to reflect that output is redirected to two locations; the terminal and a file (as a tee plumbing junction redirects water to two different pipes). Examples In the following example, output from the show tech-support command is displayed on-screen while it is written to the file “showoutput.txt” at the host 172.16.101.101 using TFTP: Router# show tech-support | tee tftp://172.16.101.101/docs/showoutput.txt The following example performs the same function as above, but in this case the output is added at the end of any existing data in the file “showoutput.txt”: Router# show tech-support | tee /append tftp://172.16.101.101/docs/showoutput.txt command Any Cisco IOS show command. | tee url The addition of this syntax copies the command output to the file location specified in the Universal Resource Locator (URL). The pipe (|) is required. The Cisco IOS File System (IFS) uses URLs to specify the location of a file system, directory, and file. Typical URL elements include: prefix:[directory/]filename Prefixes can be local file locations, such as flash: or disk0:. Alternatively, you can specify network locations using the following syntax: ftp:[[//[username[:password]@]location]/directory]/filename tftp:[[//location]/directory]/filename The rcp: prefix is not supported. /append (Optional) Adds the show command output to the end of an existing file. Release Modification 12.0(21)S This command was introduced. 12.2(13)T This command was integrated into Cisco IOS Release 12.2(13)T. show tee CF-568 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description show append Redirects the output of any show command and adds it to the end of existing file. show redirect Redirects the output of any show command to a specified file. show (Flash file system) CF-569 Cisco IOS Configuration Fundamentals Command Reference April 2010 show (Flash file system) To display the layout and contents of a Flash memory file system, use the show flash-filesystem command in EXEC mode. Class A Flash File Systems show flash-filesystem: [all | chips | filesys] Class B Flash File Systems show flash-filesystem:[partition-number:] [all | chips | detailed | err | summary] Class C Flash File Systems show flash-filesystem: Syntax Description flash-filesystem: Flash memory file system, followed by a colon. The availablity of Flash file system keywords will vary by platform. Valid flash file system keywords inlude: • bootflash • flash • slot0 • slot1 • slavebootflash • slaveslot0 • slaveslot1 all (Optional) On Class B Flash file systems, all keyword displays complete information about Flash memory, including information about the individual ROM devices in Flash memory and the names and sizes of all system image files stored in Flash memory, including those that are invalid. On Class A Flash file systems, the all keyword displays the following information: • The information displayed when no keywords are used. • The information displayed by the filesys keyword. • The information displayed by the chips keyword. chips (Optional) Displays information per partition and per chip, including which bank the chip is in, plus its code, size, and name. filesys (Optional) Displays the Device Info Block, the Status Info, and the Usage Info. partition-number (Optional) Displays output for the specified partition number. If you do not specify a partition in the command, the router displays output for all partitions. You can use this keyword only when Flash memory has multiple partitions. show (Flash file system) CF-570 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes EXEC Command History Usage Guidelines If Flash memory is partitioned, the command displays the requested output for each partition, unless you use the partition keyword. The command also specifies the location of the current image. To display the contents of boot Flash memory on Class A or B file systems, use the show bootflash: command as follows: Class A Flash file systems show bootflash: [all | chips | filesys] Class B Flash file systems show bootflash:[partition-number] [all | chips | detailed | err] To display the contents of internal Flash memory on Class A or B file systems, use the show flash: command as follows: Class A Flash file systems show flash: [all | chips | filesys] Class B Flash file systems show flash:[partition-number][all | chips | detailed | err | summary] The show (Flash file system) command replaces the show flash devices command. Examples The output of the show command depends on the type of Flash file system you select. Types include flash:, bootflash:, slot0:, slot1:, slavebootflash:, slaveslot0:, and slaveslot1:. detailed (Optional) Displays detailed file directory information per partition, including file length, address, name, Flash memory checksum, computer checksum, bytes used, bytes available, total bytes, and bytes of system Flash memory. err (Optional) Displays write or erase failures in the form of number of retries. summary (Optional) Displays summary information per partition, including the partition size, bank size, state, and method by which files can be copied into a particular partition. You can use this keyword only when Flash memory has multiple partitions. Release Modification 11.3 AA This command was introduced. 12.3 A timestamp that shows the offset from Coordinated Universal Time (UTC) was added to the show command display. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show (Flash file system) CF-571 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples of output from the show flash command are provided in the following sections: • Class A Flash File System • Class B Flash File Systems Although the examples use flash: as the Flash file system, you may also use the other Flash file systems listed. Class A Flash File System The following three examples show sample output for Class A Flash file systems. Table 49 describes the significant fields shown in the display. The following is sample output from the show flash: command. Router# show flash: -#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name 1 .. unknown 317FBA1B 4A0694 24 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz 2 .. unknown 9237F3FF 92C574 11 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz 3 .D unknown 71AB01F1 10C94E0 10 7982828 Jan 02 2004 18:48:14 -08:00 rsp-jsv-mz 4 .D unknown 96DACD45 10C97E0 8 639 Jan 03 2004 12:09:17 -08:00 the_time 5 .. unknown 96DACD45 10C9AE0 3 639 Jan 03 2004 12:09:32 -08:00 the_time 6 .D unknown 96DACD45 10C9DE0 8 639 Jan 03 2004 12:37:01 -08:00 the_time 7 .. unknown 96DACD45 10CA0E0 8 639 Jan 03 2004 12:37:13 -08:00 the_time 3104544 bytes available (17473760 bytes used) The following is sample output from the show flash: chips command: RouterA# show flash: chips Intel Series 2+ Status/Register Dump ATTRIBUTE MEMORY REGISTERS: Config Option Reg (4000): 2 Table 49 show (Class A Flash File System) Field Descriptions Field Description # Index number for the file. ED Whether the file contains an error (E) or is deleted (D). type File type (1 = configuration file, 2 = image file). The software displays these values only when the file type is certain. When the file type is unknown, the system displays “unknown” in this field. crc Cyclic redundant check for the file. seek Offset into the file system of the next file. nlen Name length—Length of the filename. length Length of the file itself. date/time Date and time the file was created. In the example, -08:00 indicates that the given date and time is 8 hours behind Coordinated Universal Time (UTC). name Name of the file. show (Flash file system) CF-572 Cisco IOS Configuration Fundamentals Command Reference April 2010 Config Status Reg (4002): 0 Card Status Reg (4100): 1 Write Protect Reg (4104): 4 Voltage Cntrl Reg (410C): 0 Rdy/Busy Mode Reg (4140): 2 COMMON MEMORY REGISTERS: Bank 0 Intelligent ID Code : 8989A0A0 Compatible Status Reg: 8080 Global Status Reg: B0B0 Block Status Regs: 0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 COMMON MEMORY REGISTERS: Bank 1 Intelligent ID Code : 8989A0A0 Compatible Status Reg: 8080 Global Status Reg: B0B0 Block Status Regs: 0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 COMMON MEMORY REGISTERS: Bank 2 Intelligent ID Code : 8989A0A0 Compatible Status Reg: 8080 Global Status Reg: B0B0 Block Status Regs: 0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 COMMON MEMORY REGISTERS: Bank 3 Intelligent ID Code : 8989A0A0 Compatible Status Reg: 8080 Global Status Reg: B0B0 Block Status Regs: 0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 COMMON MEMORY REGISTERS: Bank 4 Intelligent ID Code : 8989A0A0 Compatible Status Reg: 8080 Global Status Reg: B0B0 Block Status Regs: 0 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 8 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 16 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 24 : B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 B0B0 The following is sample output from the show flash: filesys command: RouterA# show flash: filesys -------- F I L E S Y S T E M S T A T U S -------- Device Number = 0 DEVICE INFO BLOCK: Magic Number = 6887635 File System Vers = 10000 (1.0) show (Flash file system) CF-573 Cisco IOS Configuration Fundamentals Command Reference April 2010 Length = 1400000 Sector Size = 20000 Programming Algorithm = 4 Erased State = FFFFFFFF File System Offset = 20000 Length = 13A0000 MONLIB Offset = 100 Length = C730 Bad Sector Map Offset = 1FFEC Length = 14 Squeeze Log Offset = 13C0000 Length = 20000 Squeeze Buffer Offset = 13E0000 Length = 20000 Num Spare Sectors = 0 Spares: STATUS INFO: Writable NO File Open for Write Complete Stats No Unrecovered Errors No Squeeze in progress USAGE INFO: Bytes Used = 10AA0E0 Bytes Available = 2F5F20 Bad Sectors = 0 Spared Sectors = 0 OK Files = 4 Bytes = 90C974 Deleted Files = 3 Bytes = 79D3EC Files w/Errors = 0 Bytes = 0 The following is sample output from the show flash: command: RouterB> show flash: System flash directory: File Length Name/status 1 4137888 c3640-c2is-mz.Feb24 [4137952 bytes used, 12639264 available, 16777216 total] 16384K bytes of processor board System flash (Read/Write)\ The following example shows detailed information about the second partition in internal Flash memory: RouterB# show flash:2 System flash directory, partition 2: File Length Name/status 1 1711088 dirt/images/c3600-i-mz [1711152 bytes used, 15066064 available, 16777216 total] 16384K bytes of processor board System flash (Read/Write) Class B Flash File Systems Table 50 describes the significant fields shown in the displays. Table 50 show (Class B Flash File System) all Fields Field Description addr Address of the file in Flash memory. available Total number of bytes available in Flash memory. Bank Bank number. Bank-Size Size of bank in bytes. bytes used Total number of bytes used in Flash memory. ccksum Computed checksum. Chip Chip number. Code Code number. show (Flash file system) CF-574 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following is sample output from the show flash: all command: RouterB> show flash: all Partition Size Used Free Bank-Size State Copy Mode 1 16384K 4040K 12343K 4096K Read/Write Direct System flash directory: File Length Name/status addr fcksum ccksum 1 4137888 c3640-c2is-mz.Feb24 0x40 0xED65 0xED65 Copy-Mode Method by which the partition can be copied to: • RXBOOT-MANUAL indicates a user can copy manually by reloading to the boot ROM image. • RXBOOT-FLH indicates user can copy via Flash load helper. • Direct indicates user can copy directly into Flash memory. • None indicates that it is not possible to copy into that partition. fcksum Checksum recorded in Flash memory. File Number of the system image file. If no filename is specified in the boot system flash command, the router boots the system image file with the lowest file number. Free Number of bytes free in partition. Length Size of the system image file (in bytes). Name Name of chip manufacturer and chip type. Name/status Filename and status of a system image file. The status [invalidated] appears when a file has been rewritten (recopied) into Flash memory. The first (now invalidated) copy of the file is still present within Flash memory, but it is rendered unusable in favor of the newest version. The [invalidated] status can also indicate an incomplete file that results from the user abnormally terminating the copy process, a network timeout, or a Flash memory overflow. Partition Partition number in Flash memory. Size Size of partition (in bytes) or size of chip. State State of the partition. It can be one of the following values: • Read-Only indicates the partition that is being executed from. • Read/Write is a partition that can be copied to. System flash directory Flash directory and its contents. total Total size of Flash memory (in bytes). Used Number of bytes used in partition. Table 50 show (Class B Flash File System) all Fields (continued) Field Description show (Flash file system) CF-575 Cisco IOS Configuration Fundamentals Command Reference April 2010 [4137952 bytes used, 12639264 available, 16777216 total] 16384K bytes of processor board System flash (Read/Write) Chip Bank Code Size Name 1 1 01D5 1024KB AMD 29F080 2 1 01D5 1024KB AMD 29F080 3 1 01D5 1024KB AMD 29F080 4 1 01D5 1024KB AMD 29F080 1 2 01D5 1024KB AMD 29F080 2 2 01D5 1024KB AMD 29F080 3 2 01D5 1024KB AMD 29F080 4 2 01D5 1024KB AMD 29F080 1 3 01D5 1024KB AMD 29F080 2 3 01D5 1024KB AMD 29F080 3 3 01D5 1024KB AMD 29F080 4 3 01D5 1024KB AMD 29F080 1 4 01D5 1024KB AMD 29F080 2 4 01D5 1024KB AMD 29F080 3 4 01D5 1024KB AMD 29F080 4 4 01D5 1024KB AMD 29F080 The following is sample output from the show flash: all command on a router with Flash memory partitioned: Router# show flash: all System flash partition information: Partition Size Used Free Bank-Size State Copy-Mode 1 4096K 3459K 637K 4096K Read Only RXBOOT-FLH 2 4096K 3224K 872K 4096K Read/Write Direct System flash directory, partition 1: File Length Name/status addr fcksum ccksum 1 3459720 master/igs-bfpx.100-4.3 0x40 0x3DE1 0x3DE1 [3459784 bytes used, 734520 available, 4194304 total] 4096K bytes of processor board System flash (Read ONLY) Chip Bank Code Size Name 1 1 89A2 1024KB INTEL 28F008SA 2 1 89A2 1024KB INTEL 28F008SA 3 1 89A2 1024KB INTEL 28F008SA 4 1 89A2 1024KB INTEL 28F008SA Executing current image from System flash [partition 1] System flash directory, partition2: File Length Name/status addr fcksum ccksum 1 3224008 igs-kf.100 0x40 0xEE91 0xEE91 [3224072 bytes used, 970232 available, 4194304 total] 4096K bytes of processor board System flash (Read/Write) Chip Bank Code Size Name 1 2 89A2 1024KB INTEL 28F008SA 2 2 89A2 1024KB INTEL 28F008SA 3 2 89A2 1024KB INTEL 28F008SA 4 2 89A2 1024KB INTEL 28F008SA The following is sample output from the show flash: chips command: show (Flash file system) CF-576 Cisco IOS Configuration Fundamentals Command Reference April 2010 RouterB> show flash: chips 16384K bytes of processor board System flash (Read/Write) Chip Bank Code Size Name 1 1 01D5 1024KB AMD 29F080 2 1 01D5 1024KB AMD 29F080 3 1 01D5 1024KB AMD 29F080 4 1 01D5 1024KB AMD 29F080 1 2 01D5 1024KB AMD 29F080 2 2 01D5 1024KB AMD 29F080 3 2 01D5 1024KB AMD 29F080 4 2 01D5 1024KB AMD 29F080 1 3 01D5 1024KB AMD 29F080 2 3 01D5 1024KB AMD 29F080 3 3 01D5 1024KB AMD 29F080 4 3 01D5 1024KB AMD 29F080 1 4 01D5 1024KB AMD 29F080 2 4 01D5 1024KB AMD 29F080 3 4 01D5 1024KB AMD 29F080 4 4 01D5 1024KB AMD 29F080 The following is sample output from the show flash: detailed command: RouterB> show flash: detailed System flash directory: File Length Name/status addr fcksum ccksum 1 4137888 c3640-c2is-mz.Feb24 0x40 0xED65 0xED65 [4137952 bytes used, 12639264 available, 16777216 total] 16384K bytes of processor board System flash (Read/Write) The following is sample output from the show flash: err command: RouterB> show flash: err System flash directory: File Length Name/status 1 4137888 c3640-c2is-mz.Feb24 [4137952 bytes used, 12639264 available, 16777216 total] 16384K bytes of processor board System flash (Read/Write) Chip Bank Code Size Name erase write 1 1 01D5 1024KB AMD 29F080 0 0 2 1 01D5 1024KB AMD 29F080 0 0 3 1 01D5 1024KB AMD 29F080 0 0 4 1 01D5 1024KB AMD 29F080 0 0 1 2 01D5 1024KB AMD 29F080 0 0 2 2 01D5 1024KB AMD 29F080 0 0 3 2 01D5 1024KB AMD 29F080 0 0 4 2 01D5 1024KB AMD 29F080 0 0 1 3 01D5 1024KB AMD 29F080 0 0 2 3 01D5 1024KB AMD 29F080 0 0 3 3 01D5 1024KB AMD 29F080 0 0 4 3 01D5 1024KB AMD 29F080 0 0 1 4 01D5 1024KB AMD 29F080 0 0 2 4 01D5 1024KB AMD 29F080 0 0 3 4 01D5 1024KB AMD 29F080 0 0 4 4 01D5 1024KB AMD 29F080 0 0 show (Flash file system) CF-577 Cisco IOS Configuration Fundamentals Command Reference April 2010 See Table 50 for a description of the fields. The show flash: err command also displays two extra fields: erase and write. The erase field indications the number of erase errors. The write field indicates the number of write errors. The following is sample output from the show flash summary command on a router with Flash memory partitioned. The partition in the Read Only state is the partition from which the Cisco IOS image is being executed. Router# show flash summary System flash partition information: Partition Size Used Free Bank-Size State Copy-Mode 1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH 2 4096K 2048K 2048K 2048K Read/Write Direct Related Commands Command Description more Displays the contents of any file in the Cisco IOS File System. show aliases CF-578 Cisco IOS Configuration Fundamentals Command Reference April 2010 show aliases To display all alias commands, or the alias commands in a specified mode, use the show aliases command in EXEC mode. show aliases [mode] Syntax Description Command Modes EXEC Command History Usage Guidelines When used without the mode argument, this command will display all aliases currently configured on the system. Use the mode argument to display only the aliases configured for the specified command mode. To display a list of the command mode keywords available for your system, use the show aliases ? command. The following is sample output from the show aliases exec commands. The aliases configured for commands in EXEC mode are displayed. Router> show aliases exec Exec mode aliases: h help lo logout p ping r resume s show w where Related Commands mode (Optional) Name of a specific command or configuration mode. Specifies that only aliases configured for this mode should be displayed. Release Modification 10.3 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description alias Creates a command alias. show alignment CF-579 Cisco IOS Configuration Fundamentals Command Reference April 2010 show alignment To display alignment errors and spurious memory access errors, use the show alignment command in privileged EXEC mode. show alignment Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines Alignment Errors Alignment errors are caused by misaligned reads and writes. For example, a two-byte read where the memory address is not an even multiple of two bytes is an alignment error. Alignment errors are caused by a software defect. Alignment errors are reported in the system log and recorded by the router. Output from the show alignment command provides a record of these errors along with potentially useful traceback information. The traceback information for alignment errors can generally be decoded to reveal the function causing the alignment problems. Spurious Memory Access Errors Spurious memory access errors occur when a software process attempts to access memory in a restricted location. A read operation to this region of memory is usually caused when a nonexisting value is returned to a function in the software, or in other words, when a null pointer is passed to a function. Spurious memory access errors are counted and recorded, if possible, by the software. This information is displayed with the show alignment command. Examples The following is sample output from the show alignment command when alignment detection is disabled. To enable alignment detection, use the enable command to enter privileged EXEC mode Router# show alignment Unaligned handler is disabled Router# The following is sample output from the show alignment command when there are no alignment or spurious memory errors: Router# show alignment Release Modification 12.3(7)T This command was introduced. 12.2(22)S This command was integrated into Cisco IOS Release 12.2(22)S. 12.2(18)SXE This command was integrated into Cisco IOS Release 12.2(18)SXE. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show alignment CF-580 Cisco IOS Configuration Fundamentals Command Reference April 2010 No alignment data has been recorded. No spurious memory references have been recorded. Router# The following is sample output from the show alignment command when there are only alignment errors. The traceback information is necessary to determine the cause and the fix of the alignment errors. Router# show alignment Total Corrections 134, Recorded 1, Reads 134, Writes 0 Initial Initial Address Count Access Type Traceback 1A014C5 134 32bit read 0x6012F538 0x601338F8 0x601344D8 0x6022D528 No spurious memory references have been recorded. Router# Table 51 describes the significant fields shown in the display. The following is sample output from the show alignment command when there are only spurious memory access errors: Router# show alignment No alignment data has been recorded. Total Spurious Accesses 50, Recorded 3 Address Count Traceback E 10 0x605351A0 0x603CA084 0x606C4060 0x606D6368 0x60743284 0x60743270 E 20 0x605351A0 0x6036EE7C 0x606C4060 0x606D6368 0x60743284 0x60743270 E 20 0x605351A0 0x603C998C 0x606D53EC 0x606C4060 0x606D6368 0x60743284 Router# Table 52 describes the significant fields shown in the display. Table 51 show alignment Field Descriptions Field Description Total Corrections Total number of alignment corrections made. Recorded Number of alignment entries. Reads Number of misaligned reads. Writes Number of misaligned writes. Initial Address Address of where the alignment error occurred. Count Number of times the alignment occurred at this address. Initial Access Address of where the alignment error occurred. Type Type of alignment error: read or write. Traceback The traceback address information necessary to determine the cause of the misalignment. show alignment CF-581 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following is sample output from the show alignment command when there are alignment errors and spurious memory access errors: Router# show alignment Total Corrections 134, Recorded 1, Reads 134, Writes 0 Initial Initial Address Count Access Type Traceback 1A014C5 134 32bit read 0x6012F538 0x601338F8 0x601344D8 0x6022D528 Total Spurious Accesses 50, Recorded 3 Address Count Traceback E 10 0x605351A0 0x603CA084 0x606C4060 0x606D6368 0x60743284 0x60743270 E 20 0x605351A0 0x6036EE7C 0x606C4060 0x606D6368 0x60743284 0x60743270 E 20 0x605351A0 0x603C998C 0x606D53EC 0x606C4060 0x606D6368 0x60743284 x60743270 Related Commands Table 52 show alignment Field Descriptions for Spurious Memory Access Errors Field Description Total Spurious Accesses Total number of spurious memory accesses made. Recorded Number of recorded spurious memory access entries. Address Address at which the spurious memory access error occurred. Count Number of times the spurious memory access occurred at each address. The sum equals the Total Spurious Accesses. Traceback The traceback address information necessary to determine the cause of the misalignment. Command Description enable To enter privileged EXEC mode, or any other security level set by a system administrator, use the enable command in user EXEC or privileged EXEC mode. show archive CF-582 Cisco IOS Configuration Fundamentals Command Reference April 2010 show archive To display information about the files saved in the Cisco IOS configuration archive, use the show archive command in privileged EXEC mode. show archive Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Examples The following is sample output from the show archive command: Router# show archive There are currently 1 archive configurations saved. The next archive file will be named disk0:myconfig-2 Archive # Name 0 1 disk0:myconfig-1 <- Most Recent 2 3 4 5 6 7 8 9 10 11 12 13 14 The following is sample output from the show archive command after several archive files of the running configuration have been saved. In this example, the maximum number of archive files to be saved is set to three. Router# show archive There are currently 3 archive configurations saved. Release Modification 12.3(7)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. show archive CF-583 Cisco IOS Configuration Fundamentals Command Reference April 2010 The next archive file will be named disk0:myconfig-8 Archive # Name 0 1 :Deleted 2 :Deleted 3 :Deleted 4 :Deleted 5 disk0:myconfig-5 6 disk0:myconfig-6 7 disk0:myconfig-7 <- Most Recent 8 9 10 11 12 13 14 Table 53 describes the significant fields shown in the displays. Related Commands Table 53 show archive Field Descriptions Field Description Archive # Indicates the number of the running configuration file saved to the Cisco IOS configuration archive. You can set the maximum number of archive files of the running configuration to be saved in the configuration archive. The most recent archive file is the last one shown in the display. Name Indicates the name of the running configuration file saved to the Cisco IOS configuration archive. Command Description archive config Saves a copy of the current running configuration to the Cisco IOS configuration archive. configure confirm Confirms replacement of the current running configuration with a saved Cisco IOS configuration file. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. maximum Sets the maximum number of archive files of the running configuration to be saved in the Cisco IOS configuration archive. path Specifies the location and filename prefix for the files in the Cisco IOS configuration archive. time-period Sets the time increment for automatically saving an archive file of the current running configuration in the Cisco IOS configuration archive. show archive config differences CF-584 Cisco IOS Configuration Fundamentals Command Reference April 2010 show archive config differences To perform a line-by-line comparison of any two configuration files (accessible through the Cisco IOS File System [IFS]) and generate a list of the differences between them, use the show archive config differences command in user EXEC or privileged EXEC mode. show archive config differences [filename1(path)[filename2(path)][ignorecase]] Syntax Description Command Default If the filename1(path) and filename2(path) arguments are not specified, the first configuration file is assumed to be the running configuration file and the second to be the startup configuration file. If only the filename1(path) argument is specified, the second configuration file is assumed to be the running configuration file. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines Interpreting the output of the show archive config differences command is dependent on the order in which the two files are configured. Each entry in the generated output list is prefixed with a unique text symbol to indicate the type of difference found. The text symbols and their meanings are as follows: • A minus symbol (-) indicates that the configuration line exists in filename1(path) but not in filename2(path). filename1(path) (Optional) The filename (path) of the first configuration file. Can be files in the following locations: bootflash:, cns:, fpd:, ftp:, harddisk:, http:, https:, null:, nvram:, obfl:, pram:, rcp:, revrcsf:, scp:, stby-bootflash:, stby-harddisk:, stby-nvram:, stby-obfl:, stby-rcsf:, stby-usb0:, stby-usb1:, system:, tar:, tftp:, tmpsys:, usb0: filename2(path) (Optional) The filename of the second configuration file. Can be files in the following locations: bootflash:, cns:, fpd:, ftp:, harddisk:, http:, https:, null:, nvram:, obfl:, pram:, rcp:, revrcsf:, scp:, stby-bootflash:, stby-harddisk:, stby-nvram:, stby-obfl:, stby-rcsf:, stby-usb0:, stby-usb1:, system:, tar:, tftp:, tmpsys:, usb0: ignorecase (Optional) Indicates that the case of the filenames should be ignored. Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. show archive config differences CF-585 Cisco IOS Configuration Fundamentals Command Reference April 2010 • A plus symbol (+) indicates that the configuration line exists in filename2(path) but not in filename1(path). • An exclamation point (!) with descriptive comments is used to identify order-sensitive configuration lines whose location is different in filename1(path) than in filename2(path). Examples In this example, a diff operation is performed on the running and startup configuration files. Table 54 shows the configuration files used for this example. The following is sample output from the show archive config differences command. This sample output displays the results of the diff operation performed on the configuration files in Table 54. Router# show archive config differences running-config startup-config +ip subnet-zero +ip name-server 10.4.4.4 +voice dnis-map 1 +dnis 111 interface Ethernet1/0 +no ip address +shutdown +ip default-gateway 10.5.5.5 +ip classless +access-list 110 deny ip any host 10.1.1.1 +access-list 110 deny ip any host 10.1.1.2 +access-list 110 deny ip any host 10.1.1.3 +snmp-server community private RW -no ip subnet-zero interface Ethernet1/0 -ip address 10.7.7.7 255.0.0.0 -no ip classless -snmp-server community public RO Related Commands Table 54 Configuration Files Used for the Diff Operation Example Running Configuration File Startup Configuration File no ip subnet-zero ip cef interface Ethernet1/0 ip address 10.7.7.7 255.0.0.0 no ip route-cache no ip mroute-cache duplex half no ip classless snmp-server community public RO ip subnet-zero ip cef ip name-server 10.4.4.4 voice dnis-map 1 dnis 111 interface Ethernet1/0 no ip address no ip route-cache no ip mroute-cache shutdown duplex half ip default-gateway 10.5.5.5 ip classless access-list 110 deny ip any host 10.1.1.1 access-list 110 deny ip any host 10.1.1.2 access-list 110 deny ip any host 10.1.1.3 snmp-server community private RW show archive config differences CF-586 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Description more nvram:startup-config Displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. more system:running-config Displays the contents of the currently running configuration file. show archive config incremental-diffs Performs a line-by-line comparison of a specified configuration file to the running configuration file and generates a list of the configuration lines that do not appear in the running configuration file. show archive config incremental-diffs CF-587 Cisco IOS Configuration Fundamentals Command Reference April 2010 show archive config incremental-diffs To perform a line-by-line comparison of a specified configuration file to the running configuration file and generate a list of the configuration lines that do not appear in the running configuration file, use the show archive config incremental-diffs command in user EXEC or privileged EXEC mode. show archive config incremental-diffs file Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines When an incremental diff operation is performed, a list of the configuration lines that do not appear in the running configuration file (in other words, configuration lines that only appear in the specified file that is being compared to the running configuration file) is generated as output. An exclamation point (!) with descriptive comments is used to identify order-sensitive configuration lines whose location is different in the specified configuration file than in the running configuration file. Examples In this example, an incremental diff operation is performed on the startup and running configuration files. Table 55 shows the configuration files used for this example. file The filename of the configuration file to be compared to the running configuration file. Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. show archive config incremental-diffs CF-588 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following is sample output from the show archive config incremental-diffs command. This sample output displays the results of the incremental diff operation performed on the configuration files in Table 55. Router# show archive config incremental-diffs nvram:startup-config ip subnet-zero ip name-server 10.4.4.4 voice dnis-map 1 dnis 111 interface Ethernet1/0 no ip address shutdown ip default-gateway 10.5.5.5 ip classless access-list 110 deny ip any host 10.1.1.1 access-list 110 deny ip any host 10.1.1.2 access-list 110 deny ip any host 10.1.1.3 snmp-server community private RW Related Commands Table 55 Configuration Files Used for the Incremental Diff Operation Example Startup Configuration File Running Configuration File ip subnet-zero ip cef ip name-server 10.4.4.4 voice dnis-map 1 dnis 111 interface Ethernet1/0 no ip address no ip route-cache no ip mroute-cache shutdown duplex half ip default-gateway 10.5.5.5 ip classless access-list 110 deny ip any host 10.1.1.1 access-list 110 deny ip any host 10.1.1.2 access-list 110 deny ip any host 10.1.1.3 snmp-server community private RW no ip subnet-zero ip cef interface Ethernet1/0 ip address 10.7.7.7 255.0.0.0 no ip route-cache no ip mroute-cache duplex half no ip classless snmp-server community public RO Command Description more nvram:startup-config Displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. more system:running-config Displays the contents of the currently running configuration file. show archive config differences Performs a line-by-line comparison of any two configuration files (accessible through the IFS) and generates a list of the differences between them. show archive config rollback timer CF-589 Cisco IOS Configuration Fundamentals Command Reference April 2010 show archive config rollback timer To display settings of the timed rollback, use the show archive config rollback timer command in privileged EXEC mode. show archive config rollback timer Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC (#) Command History Usage Guidelines Use the show archive config rollback timer command to display the timed rollback settings, such as the timer type (idle timer or absolute timer) and timer value, after a timed rollback is configured on a router. Examples The following is sample output from the show archive config rollback timer command: Router# show archive config rollback timer Time configured(or reconfigured): 22:50:48 UTC Sat Feb 21 2009 Timer type: absolute timer Timer value: 2 min User: console Table 56 describes the significant fields shown in the display. Release Modification 12.4(15)T This command was introduced in Cisco IOS Release12.4(15)T. 12.2(33)SRC This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC. 12.2(33)SXI This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI. Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE Release 2.1. Table 56 show archive config rollback timer Field Descriptions Field Description Time configured (or reconfigured) The time at which the timer refreshes every time the Enter key is pressed. Timer type The type of the timer: Idle or absolute. Timer value Displays the time, in minutes, for which to wait for confirmation. User Displays the username. show archive config rollback timer CF-590 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description configure revert Cancels the timed rollback and trigger the rollback immediately or resets parameters for the timed rollback. configure terminal revert timer Enter global configuration mode and sets the parameters for reverting the configuration if confirmation of the new configuration is not received. show archive log config CF-591 Cisco IOS Configuration Fundamentals Command Reference April 2010 show archive log config To display entries from the configuration log, use the show archive log config command in privileged EXEC mode. show archive log config {all | record-number [end-number] | user username [session session-number] record-number [end-number] | statistics} [provisioning] [contenttype {plaintext | xml}] [persistent] Syntax Description Command Modes Privileged EXEC Command History all Displays all configuration log entries. record-number [end-number] Displays the log entry by record number. If you specify a record number for the optional end-number argument, all log entries with record numbers between the values entered for the record-number and end-number arguments are displayed. Valid values for the record-number and end-number arguments range from 1 to 2147483647. user username Displays log entries attributed to a particular user. session session-number (Optional) Displays log entries attributed to a particular session. Valid values for the session-number argument range from 1 to 1000. statistics Displays memory usage information for the configuration log. provisioning (Optional) Displays configuration log file information as it would appear in a configuration file, rather than in tabular format. contenttype (Optional) Specifies the format for the display of configuration change results. plaintext Specifies that the configuration change results will be formatted as plain text. This keyword appears only if the contenttype keyword has been entered. xml Specifies that the configuration change results will be in eXtensible Markup Language (XML) format. This keyword appears only if the contenttype keyword has been entered. persistent (Optional) Displays the persistent configuration changes in a configlet format. Release Modification 12.3(4)T This command was introduced. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(27)SBC This command was integrated into Cisco IOS Release 12.2(27)SBC. 12.2(33)SRA The contenttype, plaintext, xml, and persistent keywords were added. 12.4(11)T This command was integrated into Cisco IOS Release 12.4(11)T. show archive log config CF-592 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines If you do not specify the all keyword, you must specify a record number with the record-number argument. You can optionally specify an end record number with the end-number argument to display a range of records. If you use the end-number argument to specify a record number that does not exist, all records after the starting record number with a record number lower than that specified with the end-number argument are displayed. Specifying the provisioning keyword results in the display appearing as it would in a configuration file, rather than in tabular format. This output includes commands used to change configuration modes and logged configuration commands. This output can be used to set up another router if desired. Examples The following is sample output from the show archive log config command, which displays configuration log entry numbers 1 and 2: Router# show archive log config 1 2 idx sess user@line Logged command 1 1 user1@console logging enable 2 1 user1@console logging size 200 Table 57 describes the significant fields shown in the display. The following example results in the display of all configuration log files as they would appear in a configuration file rather than in tabular format. In addition to displaying logged commands, the example shows the commands used to change configuration modes that are required to correctly apply the logged commands. Router# show archive log config all provisioning archive log config logging enable logging size 200 The following example results in the display of memory usage statistics for the configuration log: Router# show archive log config statistics 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command with syntax updated in 12.2(33)SRA was integrated into Cisco IOS Release 12.2(33)SB. This command was implemented on the Cisco 10000 series. Release Modification Table 57 show archive log config Field Descriptions Field Description idx The record number of the configuration log entry. sess The session number associated with the configuration log entry. user@line The username of the user who executed the command that generated the configuration log entry. Logged command The command that was executed. show archive log config CF-593 Cisco IOS Configuration Fundamentals Command Reference April 2010 Config Log Session Info: Number of sessions being tracked: 1 Memory being held: 3910 bytes Total memory allocated for session tracking: 3910 bytes Total memory freed from session tracking: 0 bytes Config Log log-queue Info: Number of entries in the log-queue: 3 Memory being held in the log-queue: 671 bytes Total memory allocated for log entries: 671 bytes Total memory freed from log entries:: 0 bytes The output is self-explanatory. The following example shows the contents of the archive log in XML format: Router# show archive log config all contenttype xml jdoe con_0 2003-04-23T20:25:19.847Z begin test test1 jdoe con_0 2003-04-23T20:27:19.847Z interface e0 PRC_CHANGE interface e0 jdoe show archive log config CF-594 Cisco IOS Configuration Fundamentals Command Reference April 2010 con_0 2003-04-23T20:28:19.847Z interface e0 ip address 10.1.1.1 255.255.255.0 PRC_CHANGE ip address 10.1.1.1 255.255.255.0 jdoe con_0 2003-04-23T20:29:19.847Z end test test1 show async bootp CF-595 Cisco IOS Configuration Fundamentals Command Reference April 2010 show async bootp To display the extended BOOTP request parameters that have been configured for asynchronous interfaces, use the show async bootp command in privileged EXEC mode. show async bootp Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Examples The following is sample output from the show async bootp command: Router# show async bootp The following extended data will be sent in BOOTP responses: bootfile (for address 192.168.1.1) “pcboot” bootfile (for address 172.16.1.111) “dirtboot” subnet-mask 255.255.0.0 time-offset -3600 time-server 192.168.1.1 Table 58 describes the significant fields shown in the display. Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 58 show async bootp Field Descriptions Field Description bootfile... “pcboot” Boot file for address 192.168.1.1 is named pcboot. subnet-mask 255.255.0.0 Subnet mask. time-offset -3600 Local time is one hour (3600 seconds) earlier than UTC time. time-server 192.168.1.1 Address of the time server for the network. Command Description async-bootp Configures extended BOOTP requests for asynchronous interfaces as defined in RFC 1084. show autoupgrade configuration unknown CF-596 Cisco IOS Configuration Fundamentals Command Reference April 2010 show autoupgrade configuration unknown To display all of the unknown start-up configuration lines that the auto-upgraded Cisco IOS software image does not understand, use the show autoupgrade configuration unknown command in privileged EXEC mode. show autoupgrade configuration unknown Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC (#) Command History Usage Guidelines Use the show autoupgrade configuration unknown command to view any invalid start-up configuration. This command prints invalid start-up configuration data only when run from an an image which was upgraded using the Auto-Upgrade Manager. This command output is useful when you are upgrading to an image with a different feature set. Examples The following example shows how to view the invalid start-up configuration lines that the Cisco IOS software image, upgraded on the router using AUM, does not understand: Router# show autoupgrade configuration unknown ! Config Lines not understood by the current image: voice-card 0 no dspfarm crypto pki trustpoint aum_cisco_ca enrollment terminal revocation-check none crypto pki certificate chain aum_cisco_ca certificate ca 40DCB71E54EE24CBE5326F8006BBA4F6 nvram:SecureServer#A4F6CA.cer no ip http secure-server transport output lat pad telnet rlogin lapb-ta mop udptn v120 ssh Total 9 Invalid Config Lines Router# Related Commands Release Modification 12.4(15)T This command was introduced. Command Description upgrade automatic abortversion Cancels a scheduled reloading of the device with a new Cisco IOS software image. show autoupgrade configuration unknown CF-597 Cisco IOS Configuration Fundamentals Command Reference April 2010 upgrade automatic getversion Downloads a Cisco IOS software image directly from www.cisco.com or from a non-Cisco server. upgrade automatic runversion Reloads the device with a new Cisco IOS software image. Command Description show bootflash: CF-598 Cisco IOS Configuration Fundamentals Command Reference April 2010 show bootflash: To display information about the bootflash: file system, use the show bootflash: command in user EXEC or privileged EXEC mode. show bootflash: [all | chips | filesys] Syntax Description Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Examples This example shows how to display information about the file system status: Router> show bootflash: filesys -------- F I L E S Y S T E M S T A T U S -------- Device Number = 0 DEVICE INFO BLOCK: bootflash Magic Number = 6887635 File System Vers = 10000 (1.0) Length = 1000000 Sector Size = 40000 Programming Algorithm = 39 Erased State = FFFFFFFF File System Offset = 40000 Length = F40000 MONLIB Offset = 100 Length = C628 Bad Sector Map Offset = 3FFF8 Length = 8 Squeeze Log Offset = F80000 Length = 40000 Squeeze Buffer Offset = FC0000 Length = 40000 Num Spare Sectors = 0 Spares: STATUS INFO: Writable NO File Open for Write Complete Stats No Unrecovered Errors No Squeeze in progress USAGE INFO: Bytes Used = 917CE8 Bytes Available = 628318 Bad Sectors = 0 Spared Sectors = 0 all (Optional) Displays all possible Flash information. chips (Optional) Displays information about the Flash chip. filesys (Optional) Displays information about the file system. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show bootflash: CF-599 Cisco IOS Configuration Fundamentals Command Reference April 2010 OK Files = 2 Bytes = 917BE8 Deleted Files = 0 Bytes = 0 Files w/Errors = 0 Bytes = 0 Router> This example shows how to display image information: Router> show bootflash: -#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name 1 .. image 8C5A393A 237E3C 14 2063804 Aug 23 1999 16:18:45 c6msfc-boot-mz 2 .. image D86EE0AD 957CE8 9 7470636 Sep 20 1999 13:48:49 rp.halley Router> This example shows how to display all bootflash information: Router> show bootflash: all -#- ED --type-- --crc--- -seek-- nlen -length- -----date/time------ name 1 .. image 8C5A393A 237E3C 14 2063804 Aug 23 1999 16:18:45 c6msfc-bootmz 2 .. image D86EE0AD 957CE8 9 7470636 Sep 20 1999 13:48:49 rp.halley 6456088 bytes available (9534696 bytes used) -------- F I L E S Y S T E M S T A T U S -------- Device Number = 0 DEVICE INFO BLOCK: bootflash Magic Number = 6887635 File System Vers = 10000 (1.0) Length = 1000000 Sector Size = 40000 Programming Algorithm = 39 Erased State = FFFFFFFF File System Offset = 40000 Length = F40000 MONLIB Offset = 100 Length = C628 Bad Sector Map Offset = 3FFF8 Length = 8 Squeeze Log Offset = F80000 Length = 40000 Squeeze Buffer Offset = FC0000 Length = 40000 Num Spare Sectors = 0 Spares: STATUS INFO: Writable NO File Open for Write Complete Stats No Unrecovered Errors No Squeeze in progress USAGE INFO: Bytes Used = 917CE8 Bytes Available = 628318 Bad Sectors = 0 Spared Sectors = 0 OK Files = 2 Bytes = 917BE8 Deleted Files = 0 Bytes = 0 Files w/Errors = 0 Bytes = 0 Router> Related Commands Command Description delete Marks files on bootflash for deletion. squeeze Removes files from bootflash that have been marked for deletion. show bootvar CF-600 Cisco IOS Configuration Fundamentals Command Reference April 2010 show bootvar To display the contents of the BOOT variable, the name of the configuration file pointed to by the CONFIG_FILE variable, the contents of the BOOTLDR variable, and the configuration register setting, use the show bootvar command in user EXEC or privileged EXEC mode. show bootvar Syntax Description This command has no arguments or keywords. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines Supported Platforms Other than the Cisco 7600 Series Router The show bootvar command replaces the show boot command. The show bootvar command allows you to view the current settings for the following variables: • BOOT • CONFIG_FILE • BOOTLDR The BOOT variable specifies a list of bootable images on various devices. The CONFIG_FILE variable specifies the configuration file used during system initialization. The BOOTLDR variable specifies the flash device and filename containing the rxboot image that ROM uses for booting. You set these variables with the boot system, boot config, and boot bootldr global configuration commands, respectively. When you use this command on a device with multiple Route Switch Processor (RSP) cards (Dual RSPs), this command also shows you the variable settings for both the master and slave RSP card. Cisco 7600 Series Router The show bootvar command displays information about the BOOT environmental variable. The command output depends on how you configure the boot statement as follows: • If you enter the boot system flash bootflash:sup720_image command in the boot configuration, then the show bootvar command output displays the bootflash information. Release Modification 11.3 AA This command was introduced. 12.2(14)SX Support for this command was implemented on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was integrated into Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show bootvar CF-601 Cisco IOS Configuration Fundamentals Command Reference April 2010 • If you enter the boot system flash sup-bootflash:sup720_image command in the boot configuration, then the show bootvar command output displays the sup-bootflash information. This action is the correct way of configuring the boot statement. The show bootvar command is available from the switch processor command-line interface (CLI) and the route processor CLI. From the switch processor CLI, the display is always bootflash. With either the bootflash or the sup-bootflash boot statement, the switch boots correctly. You should use sup-bootflash in the boot configuration statement because the image is stored in the switch processor bootflash; the route processor sees the image as sup-bootflash. The number displayed after the image name (for example, c6sup12-js-mz.121-13.E,12) indicates the number of times that the Cisco 7600 series router tries to reboot the file before giving up. Examples Supported Platforms Other than the Cisco 7600 Series Router The following is sample output from the show bootvar command: Router# show bootvar BOOT variable = CONFIG_FILE variable = nvram: Current CONFIG_FILE variable = slot0:router-config BOOTLDR variable not exist Configuration register is 0x0 In this example, the BOOT variable contains a null string; that is no bootable images are specified. The CONFIG_FILE variable points to the configuration file in NVRAM as the startup (initialization) configuration. The run-time value for the CONFIG_FILE variable points to the router-configuration file on the flash memory card inserted in the first slot of the RSP card. That is, during the run-time configuration, you have modified the CONFIG_FILE variable using the boot config command, but you have not saved the run-time configuration to the startup configuration. To save your run-time configuration to the startup configuration, use the copy system:running-config nvram:startup-config command. If you do not save the run-time configuration to the startup configuration, then the system reverts to the saved CONFIG_FILE variable setting for initialization information upon reload. In this sample, the system reverts to NVRAM for the startup configuration file. The BOOTLDR variable does not yet exist. That is, you have not created the BOOTLDR variable using the boot bootldr global configuration command. The following example is output from the show bootvar command for a Cisco 7513 router configured for high system availability (HSA): Router# show bootvar BOOT variable = CONFIG_FILE variable = Current CONFIG_FILE variable = BOOTLDR variable does not exist Configuration register is 0x0 current slave is in slot 7 BOOT variable = CONFIG_FILE variable = BOOTLDR variable does not exist Configuration register is 0x0 show bootvar CF-602 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 59 describes the significant fields shown in the displays. Cisco 7600 Series Router This example shows how to display information about the BOOT environment variable: Router# show bootvar BOOT variable = sup-bootflash:c6sup12-js-mz.121-13.E,12 CONFIG_FILE variable = BOOTLDR variable = bootflash:c6msfc2-boot-mz.121-13.E.bin Configuration register is 0x2102 Standby is up Standby has 112640K/18432K bytes of memory. Standby BOOT variable = bootflash:c6sup12-js-mz.121-13.E,12 Standby CONFIG_FILE variable = Standby BOOTLDR variable = bootflash:c6msfc2-boot-mz.121-13.E.bin Standby Configuration register is 0x2102 The number displayed after the image name (for example, c6sup12-js-mz.121-13.E,12) indicates the number of times that the Cisco 7600 series router tries to reboot the file before giving up. Related Commands Table 59 show bootvar Field Descriptions Field Description BOOT variable Displays a list of specified bootable images. CONFIG_FILE variable Indicates where to locate the startup (initialization) configuration file. Current CONFIG_FILE variable Identifies the run-time configuration file. BOOTLDR variable Identifies the location of the boot image that ROM uses for booting, if it is specified. Configuration register Specifies router behavior, such as how the router boots, options while booting, and console speed (baud rate for a terminal emulation session). current slave is in slot 7 Indicates the slot where the redundant system is located in HSA configurations. Command Description boot bootldr Specifies the location of the boot image that ROM uses for booting. boot bootstrap Configures the filename that is used to boot a secondary bootstrap image. boot config Specifies the device and filename of the configuration file from which the router configures itself during initialization (startup). boot system Specifies the system image that the router loads at startup. copy Copies a file from source to a destination. show version Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images. show buffers CF-603 Cisco IOS Configuration Fundamentals Command Reference April 2010 show buffers To display statistics for the buffer pools on the network server when Cisco IOS or Cisco IOS Software Modularity images are running, use the show buffers command in user EXEC or privileged EXEC mode. show buffers [{address hex-address | failures | pool pool-name | processes | {all | assigned [process-id] | free | old | input-interface interface-type interface-number} [pool pool-name]} [dump | header | packet]] Syntax Description Command Default If no options are specified, all buffer pool information is displayed. Command Modes User EXEC (>) Privileged EXEC (#) Command History address (Optional) Displays buffers at a specified address. hex-address (Optional) Address in hexadecimal notation. failures (Optional) Displays buffer allocation failures. pool (Optional) Displays buffers in a specified buffer pool. pool-name (Optional) Name of buffer pool. processes (Optional) For Cisco IOS Software Modularity images only. Displays buffers connected to Packet Manager. all (Optional) Displays all buffers. assigned (Optional) Displays the buffers in use. process-id (Optional) For Cisco IOS Software Modularity images only. POSIX process identifier. free (Optional) Displays the buffers available for use. old (Optional) Displays buffers older than one minute. input-interface (Optional) Displays interface pool information. If an interface type is specified and this interface has its own buffer pool, information for that pool is displayed. interface-type (Optional) Interface type. interface-number (Optional) Interface number. dump (Optional) Displays the buffer header and all data. header (Optional) Displays the buffer header only. packet (Optional) Displays the buffer header and packet data. Release Modification 10.0 This command was introduced. 12.3 The option to filter display output based on specific buffer pools was expanded. show buffers CF-604 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples Example output varies between Cisco IOS software images and Cisco IOS Software Modularity software images. To view the appropriate output, choose one of the following sections: • Cisco IOS Software • Cisco IOS Software Modularity Cisco IOS Software The following is sample output from the show buffers command with no arguments, showing all buffer pool information: Router# show buffers Buffer elements: 398 in free list (500 max allowed) 1266 hits, 0 misses, 0 created Public buffer pools: Small buffers, 104 bytes (total 50, permanent 50): 50 in free list (20 min, 150 max allowed) 551 hits, 0 misses, 0 trims, 0 created Middle buffers, 600 bytes (total 25, permanent 25): 25 in free list (10 min, 150 max allowed) 39 hits, 0 misses, 0 trims, 0 created Big buffers, 1524 bytes (total 50, permanent 50): 49 in free list (5 min, 150 max allowed) 27 hits, 0 misses, 0 trims, 0 created VeryBig buffers, 4520 bytes (total 10, permanent 10): 10 in free list (0 min, 100 max allowed) 0 hits, 0 misses, 0 trims, 0 created Large buffers, 5024 bytes (total 0, permanent 0): 0 in free list (0 min, 10 max allowed) 0 hits, 0 misses, 0 trims, 0 created Huge buffers, 18024 bytes (total 0, permanent 0): 0 in free list (0 min, 4 max allowed) 0 hits, 0 misses, 0 trims, 0 created Interface buffer pools: Ethernet0 buffers, 1524 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache Ethernet1 buffers, 1524 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache Serial0 buffers, 1524 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache Serial1 buffers, 1524 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache 12.2(18)SXF4 Two additional fields were added to the output to support Cisco IOS Software Modularity. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Release Modification show buffers CF-605 Cisco IOS Configuration Fundamentals Command Reference April 2010 TokenRing0 buffers, 4516 bytes (total 48, permanent 48): 0 in free list (0 min, 48 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache TokenRing1 buffers, 4516 bytes (total 32, permanent 32): 32 in free list (0 min, 48 max allowed) 16 hits, 0 fallbacks 0 failures (0 no memory) The following is sample output from the show buffers command with no arguments, showing onlybuffer pool information for Huge buffers. This output shows a highest total of five Huge buffers created five days and 18 hours before the command was issued. Router# show buffers Huge buffers, 18024 bytes (total 5, permanent 0, peak 5 @ 5d18h): 4 in free list (3 min, 104 max allowed) 0 hits, 1 misses, 101 trims, 106 created 0 failures (0 no memory) The following is sample output from the show buffers command with no arguments, showing only buffer pool information for Huge buffers. This output shows a highest total of 184 Huge buffers created one hour, one minute, and 15 seconds before the command was issued. Router# show buffers Huge buffers, 65280 bytes (total 4, permanent 2, peak 184 @ 01:01:15): 4 in free list (0 min, 4 max allowed) 32521 hits, 143636 misses, 14668 trims, 14670 created 143554 failures (0 no memory) The following is sample output from the show buffers command with an interface type and interface number: Router# show buffers Ethernet 0 Ethernet0 buffers, 1524 bytes (total 64, permanent 64): 16 in free list (0 min, 64 max allowed) 48 hits, 0 fallbacks 16 max cache size, 16 in cache Table 60 describes the significant fields shown in the display. Table 60 show buffers (Cisco IOS Software) Field Descriptions Field Description Buffer elements Small structures used as placeholders for buffers in internal operating system queues. Used when a buffer may need to be on more than one queue. free list Total number of the currently unallocated buffer elements. max allowed Maximum number of buffers that are available for allocation. hits Count of successful attempts to allocate a buffer when needed. misses Count of buffer allocation attempts that resulted in growing the buffer pool to allocate a buffer. created Count of new buffers created to satisfy buffer allocation attempts when the available buffers in the pool have already been allocated. show buffers CF-606 Cisco IOS Configuration Fundamentals Command Reference April 2010 Public Buffer Pools Small buffers Buffers that are 104 bytes long. Middle buffers Buffers that are 600 bytes long. Big buffers Buffers that are 1524 bytes long. VeryBig buffers Buffers that are 4520 bytes long. Large buffers Buffers that are 5024 bytes long. Huge buffers Buffers that are 18,024 bytes long. total Total number of this type of buffer. permanent Number of these buffers that are permanent. peak Maximum number of buffers created (highest total) and the time when that peak occurred. Formats include weeks, days, hours, minutes, and seconds. Not all systems report a peak value, which means this field may not display in output. free list Number of available or unallocated buffers in that pool. min Minimum number of free or unallocated buffers in the buffer pool. max allowed Maximum number of free or unallocated buffers in the buffer pool. hits Count of successful attempts to allocate a buffer when needed. misses Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer. trims Count of buffers released to the system because they were not being used. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static. created Count of new buffers created in response to misses. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static. Interface Buffer Pools total Total number of this type of buffer. permanent Number of these buffers that are permanent. free list Number of available or unallocated buffers in that pool. min Minimum number of free or unallocated buffers in the buffer pool. max allowed Maximum number of free or unallocated buffers in the buffer pool. hits Count of successful attempts to allocate a buffer when needed. fallbacks Count of buffer allocation attempts that resulted in falling back to the public buffer pool that is the smallest pool at least as big as the interface buffer pool. max cache size Maximum number of buffers from the pool of that interface that can be in the buffer pool cache of that interface. Each interface buffer pool has its own cache. These are not additional to the permanent buffers; they come from the buffer pools of the interface. Some interfaces place all of their buffers from the interface pool into the cache. In this case, it is normal for the free list to display 0. Table 60 show buffers (Cisco IOS Software) Field Descriptions (continued) Field Description show buffers CF-607 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco IOS Software Modularity The following is sample output from the show buffers command using a Cisco IOS Modularity image from Cisco IOS Release 12.2(18)SXF4 and later releases. Two new output fields were introduced—Public buffer heads and Temporary buffer heads—and are shown within comments in the following sample output. Router# show buffers Buffer elements: 500 in free list (500 max allowed) 106586 hits, 0 misses, 0 created Public buffer pools: Small buffers, 104 bytes (total 50, permanent 50, peak 54 @ 1d13h): 49 in free list (20 min, 150 max allowed) 54486 hits, 0 misses, 4 trims, 4 created 0 failures (0 no memory) Middle buffers, 600 bytes (total 25, permanent 25, peak 27 @ 1d13h): 25 in free list (10 min, 150 max allowed) 20 hits, 0 misses, 2 trims, 2 created 0 failures (0 no memory) Big buffers, 1536 bytes (total 50, permanent 50): 50 in free list (40 min, 150 max allowed) 6 hits, 0 misses, 0 trims, 0 created 0 failures (0 no memory) VeryBig buffers, 4520 bytes (total 10, permanent 10): 10 in free list (0 min, 100 max allowed) 0 hits, 0 misses, 0 trims, 0 created 0 failures (0 no memory) Large buffers, 5024 bytes (total 0, permanent 0): 0 in free list (0 min, 10 max allowed) 0 hits, 0 misses, 0 trims, 0 created 0 failures (0 no memory) Huge buffers, 18024 bytes (total 1, permanent 0, peak 1 @ 1d13h): 0 in free list (0 min, 4 max allowed) 1 hits, 0 misses, 0 trims, 0 created 0 failures (0 no memory) ! Start of Cisco IOS Software Modularity fields Public buffer headers: Header buffers, 880 bytes (total 1000, peak 142 @ 1d13h): 864 in permanent free list 142 hits, 0 misses Temporary buffer headers: Header buffers, 896 bytes (total 0): 0 in free list 0 hits, 0 misses, 0 trims, 0 created failures Total number of times a buffer creation failed. The failure may have occurred because of a number of different reasons, such as low processor memory, low IOMEM, or no buffers in the pool when called from interrupt context. no memory Number of times there has been low memory during buffer creation. Low or no memory during buffer creation may not necessarily mean that buffer creation failed; memory can be obtained from an alternate resource such as a fallback pool. Table 60 show buffers (Cisco IOS Software) Field Descriptions (continued) Field Description show buffers CF-608 Cisco IOS Configuration Fundamentals Command Reference April 2010 0 failures ! End of Cisco IOS Software Modularity fields Interface buffer pools: Logger Pool buffers, 600 bytes (total 150, permanent 150): 150 in free list (150 min, 150 max allowed) 22 hits, 0 misses Table 61 describes the significant fields shown in the display that are different from the fields in Table 60. Table 61 show buffers (Cisco IOS Software Modularity) Field Descriptions Field Description Public Buffer Headers Header buffers Buffers that are 880 bytes long. total Total number of this type of buffer. permanent free list Number of available or unallocated permanent header buffers. hits Count of successful attempts to allocate a header buffer when needed. misses Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer. Temporary Buffer Headers Header buffers Buffers that are 896 bytes long. total Total number of this type of buffer. free list Number of available or unallocated header buffers in that pool. hits Count of successful attempts to allocate a buffer when needed. misses Count of buffer allocation attempts that resulted in growing the buffer pool in order to allocate a buffer. trims Count of buffers released to the system because they were not being used. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static. created Count of new buffers created in response to misses. This field is displayed only for dynamic buffer pools, not interface buffer pools, which are static. failures Total number of allocation requests that have failed because no buffer was available for allocation; the datagram was lost. Such failures normally occur at interrupt level. show buffers summary CF-609 Cisco IOS Configuration Fundamentals Command Reference April 2010 show buffers summary To display the buffers usage summary for all caller and for all buffer pools, use the show buffers summary command in privileged EXEC mode. show buffers summary Syntax Description This command has no arguments or keywords. Command Default All buffer usage summary information is displayed. Command Modes Privileged EXEC (#) Command History Examples The following is sample output from the show buffers summary command: Router# show buffers summary Pool: Small Non-aligned packet(s): 25 Caller Summary pc = 0x40612F74 count = 37 pc = 0x418D77FC count = 24 pc = 0x418571E0 count = 1 pc = 0x41860488 count = 1 Pool: Medium Non-aligned packet(s): 39 Caller Summary pc = 0x418D77FC count = 38 pc = 0x41860488 count = 1 pc = 0x40612F74 count = 23 Pool: Middle Non-aligned packet(s): 333 Caller Summary pc = 0x418D77FC count = 333 pc = 0x40612F74 count = 2 pc = 0x4049FFD8 count = 3 Pool: Big Non-aligned packet(s): 32078 Caller Summary pc = 0x418D77FC count = 32006 pc = 0x4065FD40 count = 7 pc = 0x409E915C count = 1 pc = 0x40652A58 count = 65 Pool: VeryBig Release Modification 12.2(33)SXI This command was introduced. show buffers summary CF-610 Cisco IOS Configuration Fundamentals Command Reference April 2010 Non-aligned packet(s): 10 Caller Summary pc = 0x418D77FC count = 10 Pool: Large Non-aligned packet(s): 8 Caller Summary pc = 0x418D77FC count = 8 Pool: Huge Non-aligned packet(s): 2 Caller Summary pc = 0x418D77FC count = 2 Table 60 describes the significant fields shown in the display. Related Commands Table 62 show buffers summary Field Descriptions Field Description Non-alligned Indicates the number of packets not alligned to 32 bits PC Specifies who allocated buffer from this pool, for example, small buffer pool, middle buffer pool and so on. Public Buffer Pools Small buffers Buffers that are 104 bytes long. Middle buffers Buffers that are 600 bytes long. Big buffers Buffers that are 1524 bytes long. VeryBig buffers Buffers that are 4520 bytes long. Large buffers Buffers that are 5024 bytes long. Huge buffers Buffers that are 18,024 bytes long. Command Description show buffers Displays statistics for the buffer pools on the network server. show c2600 CF-611 Cisco IOS Configuration Fundamentals Command Reference April 2010 show c2600 To display information for troubleshooting the Cisco 2600 series router, use the show c2600 command in EXEC mode. show c2600 Syntax Description This command has no arguments or keywords. Command Modes EXEC Command History Usage Guidelines The show c2600 command provides complex troubleshooting information that pertains to the platform’s shared references rather than to a specific interface. Examples The following is sample output from the show c2600 command: Router# show c2600 C2600 Platform Information: Interrupts: Assigned Handlers... Vect Handler # of Ints Name 00 801F224C 00000000 Xilinx bridge error interrupt 01 801DE768 0D3EE155 MPC860 TIMER INTERRUPT 02 801E94E0 0000119E 16552 Con/Aux Interrupt 04 801F0D94 00000000 PA Network Management Int Handler 05 801E6C34 00000000 Timebase Reference Interrupt 06 801F0DE4 00002C1A PA Network IO Int Handler 07 801F0EA0 0000015D MPC860 CPM INTERRUPT 14 801F224C 00000000 Xilinx bridge error interrupt IOS Priority Masks... Level 00 = [ EF020000 ] Level 01 = [ EC020000 ] Level 02 = [ E8020000 ] Level 03 = [ E0020000 ] Level 04 = [ E0020000 ] Level 05 = [ E0020000 ] Level 06 = [ C0020000 ] Level 07 = [ 00000000 ] SIU_IRQ_MASK = FFFFFFFF SIEN = EF02xxxx Current Level = 00 Spurious IRQs = 00000000 SIPEND = 0000xxxx Interrupt Throttling: Throttle Count = 00000000 Timer Count = 00000000 Release Modification 11.3 XA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show c2600 CF-612 Cisco IOS Configuration Fundamentals Command Reference April 2010 Netint usec = 00000000 Netint Mask usec = 000003E8 Active = 0 Configured = 0 Longest IRQ = 00000000 IDMA Status: Requests = 00000349 Drops = 00000000 Complete = 00000349 Post Coalesce Frames = 00000349 Giant = 00000000 Available Blocks = 256/256 ISP Status: Version string burned in chip: "A986122997" New version after next program operation: "B018020998" ISP family type: "2096" ISP chip ID: 0x0013 Device is programmable Table 63 describes the significant fields shown in the display. Table 63 show c2600 Field Descriptions Field Description Interrupts Denotes that the next section describes the status of the interrupt services. Assigned Handlers Denotes a subsection of the Interrupt section that displays data about the interrupt handlers. Vect The processor vector number. Handler The execution address of the handler assigned to this vector. # of Ints The number of times this handler has been called. Name The name of the handler assigned to this vector. IOS Priority Masks Denotes the subsection of the Interrupt section that displays internal Cisco IOS priorities. Each item in this subsection indicates a Cisco IOS interrupt level and the bit mask used to mask out interrupt sources when that Cisco IOS level is being processed. Used exclusively for debugging. SIU_IRQ_MASK For engineering level debug only. Spurious IRQs For engineering level debug only. Interrupt Throttling: This subsection describes the behavior of the Interrupt Throttling mechanism on the platform. Throttle Count Number of times throttle has become active. Timer Count Number of times throttle has deactivated because the maximum masked out time for network interrupt level has been reached. Netint usec Maximum time network level is allowed to run (in microseconds). Netint Mask usec Maximum time network level interrupt is masked out to allow process level code to run (in microseconds). Active Indicates that the network level interrupt is masked or that the router is in interrupt throttle state. Configured Indicates that throttling is enabled or configured when set to 1. show c2600 CF-613 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Longest IRQ Duration of longest network level interrupt (in microseconds). IDMA Status Monitors the activity of the Internal Direct Memory Access (IDMA) hardware and software. Used to coalesce packets (turn particularized packets into non particularized packets) for transfer to the process level switching mechanism. Requests Number of times the IDMA engine is asked to coalesce a packet. Drops Number of times the coalescing operation was aborted. Complete Number of times the operation was successful. Post Coalesce Frames Number of Frames completed post coalesce processing. Giant Number of packets too large to coalesce. Available Blocks Indicates the status of the request queue, in the format N/M where N is the number of empty slots in queue and M is the total number of slots; for example, 2/256 indicates that the queue has 256 entries and can accept two more requests before it is full. ISP Status Provides status of In-System-Programmable (ISP) hardware. Version string burned in chip Current version of ISP hardware. New version after next program operation Version of ISP hardware after next ISP programming operation. ISP family type Device family number of ISP hardware. ISP chip ID Internal ID of ISP hardware as designated by the chip manufacturer. Device is programmable “Yes” or “No.” Indicates if an ISP operation is possible on this board. Table 63 show c2600 Field Descriptions (continued) Field Description Command Description show context Displays information stored in NVRAM when the router crashes. show c7200 CF-614 Cisco IOS Configuration Fundamentals Command Reference April 2010 show c7200 To display information about the CPU and midplane for Cisco 7200 series routers, use the show c7200 command in EXEC mode. show c7200 Syntax Description This command has no arguments or keywords. Command Modes EXEC Command History Usage Guidelines You can use the output of this command to determine whether the hardware version level and upgrade is current. The information is generally useful for diagnostic tasks performed by technical support only. Examples The following is sample output from the show c7200 command: Router# show c7200 C7200 Network IO Interrupt Throttling: throttle count=0, timer count=0 active=0, configured=0 netint usec=3999, netint mask usec=200 C7200 Midplane EEPROM: Hardware revision 1.2 Board revision A0 Serial number 2863311530 Part number 170-43690-170 Test history 0xAA RMA number 170-170-170 MAC=0060.3e28.ee00, MAC Size=1024 EEPROM format version 1, Model=0x6 EEPROM contents (hex): 0x20: 01 06 01 02 AA AA AA AA AA AA AA AA 00 60 3E 28 0x30: EE 00 04 00 AA AA AA AA AA AA AA 50 AA AA AA AA C7200 CPU EEPROM: Hardware revision 2.0 Board revision A0 Serial number 3509953 Part number 73-1536-02 Test history 0x0 RMA number 00-00-00 EEPROM format version 1 EEPROM contents (hex): 0x20: 01 15 02 00 00 35 8E C1 49 06 00 02 00 00 00 00 0x30: 50 00 00 00 FF FF FF FF FF FF FF FF FF FF FF FF Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show catalyst6000 CF-615 Cisco IOS Configuration Fundamentals Command Reference April 2010 show catalyst6000 To display the information about the Cisco 7600 series router, use the show catalyst6000 command in user EXEC or privileged EXEC mode. show catalyst6000 {all | chassis-mac-address | switching-clock | traffic-meter} Syntax Description Defaults all Command Modes User EXEC Privileged EXEC Command History Usage Guidelines If you enter the switching-clock keywords, the Cisco 7600 series router displays whether switching of the redundant clock sources on the backplane is allowed if the active clock source fails. The Cisco 7600 series router has either 64 or 1024 MAC addresses that are available to support the software features. You can enter the show catalyst6000 chassis-mac-address command to display the MAC-address range on your chassis. Examples This example shows how to display the MAC-address ranges and the current and peak traffic-meter readings: Router> show catalyst6000 all chassis MAC addresses: 64 addresses from 0001.6441.60c0 to 0001.6441.60ff traffic meter = 0% Never cleared peak = 0% reached at 08:14:38 UTC Wed Mar 19 2003 switching-clock: clock switchover and system reset is allowed Router> This example shows how to display the MAC-address ranges: Router# show catalyst6000 chassis-mac-address all Displays the MAC-address ranges and the current and peak traffic-meter reading. chassis-mac-address Displays the MAC-address range. switching-clock Displays the failure recovery mode of the switching clock. traffic-meter Displays the percentage of the backplane (shared bus) utilization. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show catalyst6000 CF-616 Cisco IOS Configuration Fundamentals Command Reference April 2010 chassis MAC addresses: 1024 addresses from 00d0.004c.1800 to 00d0.004c.1c00 Router# This example shows how to display the current and peak traffic-meter readings: Router> show catalyst6000 traffic-meter traffic meter = 0% peak = 0% at 09:57:58 UTC Mon Nov 6 2000 Router# This example shows how to display the failure recovery mode of the switching clock: Router> show catalyst6000 switching-clock switching-clock: clock switchover and system reset is allowed Router> Related Commands Command Description show environment alarm Displays the information about the environmental alarm. show fm summary Displays a summary of FM Information. show environment status Displays the information about the operational FRU status. show cls CF-617 Cisco IOS Configuration Fundamentals Command Reference April 2010 show cls To display the current status of all Cisco link services (CLS) sessions on the router, use the show cls command in EXEC mode. show cls [brief] Syntax Description Defaults Without the brief keyword, displays complete output. Command Modes EXEC Command History Usage Guidelines The Cisco link service (CLS) is used as the interface between data link users (DLUs), such as DLSw, LAN Network Manager (LNM), downstream physical unit (DSPU), and SNASw, and their corresponding data link circuits (DLCs) such as Logic Link Control (LLC), VDLC, and Qualified Logic Link Control (QLLC). Each DLU registers a particular service access point (SAP) with CLS, and establishes circuits through CLS over the DLC. The show cls command displays the SAP values associated with the DLU and the circuits established through CLS. For further information about CLS, use the Release 12.2 Cisco IOS Bridging and IBM Networking Configuration Guide. Examples The following is sample output from the show cls command: IBD-4500B# show cls DLU user:SNASW SSap:0x04 VDLC VDLC650 DTE:1234.4000.0001 1234.4000.0002 04 04 T1 timer:0 T2 timer:0 Inact timer:0 max out:0 max in:0 retry count:10 XID retry:10 XID timer:5000 I-Frame:0 flow:0 DataIndQ:0 DataReqQ:0 DLU user:DLSWDLUPEER DLU user:DLSWDLU Bridging VDLC VDLC1000 Bridging VDLC VDLC650 The following is sample output from the show cls brief command: brief (Optional) Displays a brief version of the output. Release Modification 11.0 This command was introduced in a release prior to Cisco IOS Release 11.0. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show cls CF-618 Cisco IOS Configuration Fundamentals Command Reference April 2010 IBD-4500B# show cls brief DLU user:SNASW SSap:0x04 VDLC VDLC650 DTE:1234.4000.0001 1234.4000.0002 04 04 DLU user:DLSWDLUPEER DLU user:DLSWDLU Bridging VDLC VDLC1000 Bridging VDLC VDLC650 The examples show two DLUs—SNASw and DLSw—active in the router. SNASw uses a SAP value of 0x04, and the associated DLC port is VDLC650. SNASw has a circuit established between MAC addresses 1234.4000.0001 and 1234.4000.0002 using source and destination SAPs 04 and 04. DLSw is a bridging protocol and uses VDLC1000 and VDLC650 ports. There are no circuits in place at this time. In the output from the show cls command (without the brief argument), the values of timers and counters applicable to this circuit are displayed. Related Commands Command Description stun peer-name Enables STUN for an IP address and uses Cisco Link Services (CLS) to access the Frame Relay network. show config id CF-619 Cisco IOS Configuration Fundamentals Command Reference April 2010 show config id The configuration change tracking identifier (CTID) assigns a version number to each saved version of the running-config file. To display output about the versions, use the show config id command in privileged EXEC mode. show config id [detail] Syntax Description Command Default This command is disabled by default. If this command is not entered, the management system has to query the device for the current running-config file and then compare the results to the last known configuration to determine if a change has been made. Command Modes Privileged EXEC (#) Command History Usage Guidelines This configuration infrastructure command assigns a version number that is updated every time the running-config file is changed. This version number is called the configuration change tracking identifier or CTID. The CTID can be used to compare configuration files to track configuration changes and take appropriate actions (for example, a configuration rollback). Config Logger can also use the CTID to determine if there have been any changes to the running-config file. CTID makes the management system more efficient by presenting information that indicates a change has been made to the running-config file. Without CTID, the management system has to query the device for the current running-config file and then compare the results to the last known configuration to determine if a change has been made. Examples The following example shows that the current running-config file is version 4 and that this file was saved on June 15, 2006 at 7.572 seconds after 3:02 p.m.: Router# show config id version:4 time:2006-06-15T15:02:07.572Z detail (Optional) Expands the output of the command to include the ID of the last user to make a configuration change and the process in which the changes were made. Release Modification 12.2(33)SRC This command was introduced. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. 12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T. show config id CF-620 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following example shows that the current running-config file is version 9 and that this file was last saved on June 18, 2006 at 34.431 seconds after 6:34 p.m. The file was saved by the system and changed from Init: Router# show config id detail Configuration version : 9 Last change time : 2006-06-18T18:34:34.431Z Changed by user : system Changed from process : Init Field descriptions are self-explanatory. Related Commands Command Description copy running-config startup-config Copies the current running-config file (source) to the startup-config file (destination). show running-config Displays the contents of the currently running configuration file or the configuration for a specific class map, interface, map class, policy map, or virtual-circuit class. show configuration lock CF-621 Cisco IOS Configuration Fundamentals Command Reference April 2010 show configuration lock To display information about the lock status of the running configuration file during a configuration replace operation, use the show configuration lock command in privileged EXEC mode. show configuration lock Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Examples The following is sample output from the show configuration lock command when the running configuration file is locked by another user. Cisco IOS Release 12.2(25)S, Release 12.2(28)SB, Release 12.3(14)T, and Later Releases Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# configuration mode exclusive ? auto Lock configuration mode automatically manual Lock configuration mode on-demand Router(config)# configuration mode exclusive auto Router(config)# end Router# show running-config | include configuration configuration mode exclusive auto Router# configure terminal !<----------- Acquires the lock Enter configuration commands, one per line. End with CNTL/Z. Release Modification 12.2(25)S This command was introduced. 12.3(14)T This command was integrated into Cisco IOS Release 12.3(14)T. The output of this command was updated to display the configuration locking class. 12.0(31)S The command output was enhanced. 12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was implemented on the Cisco 10000 series. 12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH. 12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB and implemented on the Cisco 10000 series. show configuration lock CF-622 Cisco IOS Configuration Fundamentals Command Reference April 2010 Router(config)# show configuration lock Parser Configure Lock --------------------- Owner PID : 3 User : unknown TTY : 0 Type : EXCLUSIVE State : LOCKED Class : EXPOSED Count : 1 Pending Requests : 0 User debug info : configure terminal Router(config)# Router(config)# end ! <------------ Releases the lock The following is sample output from the show configuration lock command when the running configuration file is not locked by another user. Router# show configuration lock Parser Configure Lock --------------------- Owner PID : -1 User : unknown TTY : -1 Type : NO LOCK State : FREE Class : unknown Count : 0 Pending Requests : 0 User debug info : Cisco IOS Release 12.0(31)S, 12.2(33)SRA, and Later Releases Router# show configuration lock Parser Configure Lock ------------------------------------------------------ Owner PID : 3 User : unknown TTY : 0 Type : EXCLUSIVE State : LOCKED Class : EXPOSED Count : 1 Pending Requests : 0 User debug info : configure terminal Session idle state : TRUE No of exec cmds getting executed : 0 No of exec cmds blocked : 0 Config wait for show completion : FALSE Remote ip address : Unknown Lock active time (in Sec) : 6 Lock Expiration timer (in Sec) : 593 show configuration lock CF-623 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 64 describes the significant fields shown in the displays. The following example shows how to configure the configuration file for single user auto configuration mode (using the configuration mode exclusive auto command). Use the configure terminal command to enter global configuration mode and lock the configuration mode exclusively. Once the Cisco IOS configuration mode is locked exclusively, you can verify the lock using the show configuration lock command. Router# configure terminal Router(config)# configuration mode exclusive auto Router(config)# end Router# configure terminal Router(config)# show configuration lock Parser Configure Lock Table 64 show configuration lock Field Descriptions Field Description Owner PID Process identifier (PID) of the process that owns the lock. User Owner’s username. TTY Owner’s terminal number. Type Lock type (EXCLUSIVE/COUNTER/NO LOCK). State State of the lock (FREE/LOCKED). Class Classification of users of the lock (EXPOSED/ROLLBACK). Processes other than ROLLBACK belong to the EXPOSED class. Count In the case of a counter lock, total number of processes holding the lock. Pending Requests Total number of processes blocked by the lock. User debug info Any string given by the process (used for debugging only). Session idle state Indicates whether the user in an access session locking session is idle. Displays TRUE or FALSE. No of exec cmds getting executed Total number of EXEC commands (show and clear) being executed simultaneously from different sessions. No of exec cmds blocked Total number of EXEC commands (show and clear) waiting for the configuration command (running from the access session locking session) to complete its execution. Config wait for show completion Indicates whether a configuration command executed in an access session locking session is waiting for the completion of the show command being executed simultaneously from a different session. Displays TRUE or FALSE. Remote ip address IP address of the terminal from which the user telneted to the router. Lock active time (in Sec) Amount of time, in seconds, that elapsed since the lock was acquired. Lock Expiration timer (in Sec) The amount of time, in seconds, that expires before the lock is automatically released. show configuration lock CF-624 Cisco IOS Configuration Fundamentals Command Reference April 2010 Owner PID : 10 User : User1 TTY : 3 Type : EXCLUSIVE State : LOCKED Class : Exposed Count : 0 Pending Requests : 0 User debug info : 0 Related Commands Command Description configuration mode exclusive Enables single-user (exclusive) access functionality for the Cisco IOS CLI. configure replace Replaces the current running configuration with a saved Cisco IOS configuration file. debug configuration lock Enables debugging of the Cisco IOS configuration lock. show context CF-625 Cisco IOS Configuration Fundamentals Command Reference April 2010 show context To display information stored in NVRAM when an unexpected system reload (system exception) occurs, use the show context command in user EXEC or priviledged EXEC mode. show context [summary | all | slot slot-number [crash-index] [all] [debug]] Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The display from the show context command includes the following information: • Reason for the system reboot • Stack trace • Software version • The signal number, code, and router uptime information • All the register contents at the time of the crash Note This command is primarily for use by Cisco technical support representatives for analyzing unexpected system reloads. summary Displays a summary of all the crashes recorded. all Displays all crashes for all the slots. When optionally used with the slot keyword, displays crash information for the specified slot. slot slot-number [crash-index] Displays information for a particular line card. Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008. The index number allows you to look at previous crash contexts. Contexts from the last 24 line card crashes are saved on the GRP card. If the GRP reloads, the last 24 line card crash contexts are lost. For example, show context slot 3 2 shows the second most recent crash for line card in slot 3. Index numbers are displayed by the show context summary command. debug (Optional) Displays crash information as a hex record dump in addition to one of the options listed. Release Modification 10.3 This command was introduced. 11.2 GS The slot slot-number [crash-index] [all] [debug] syntax was added for Cisco 12000 series routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show context CF-626 Cisco IOS Configuration Fundamentals Command Reference April 2010 Output for this command will vary by platform. Context information is specific to processors and architectures. For example, context information for the Cisco 2600 series router differs from that for other router types because the Cisco 2600 runs with an M860 processor. Examples The following is sample output from the show context command following a system failure: Router> show context System was restarted by error - a Software forced crash, PC 0x60189354 GS Software (RSP-PV-M), Experimental Version 11.1(2033) [ganesh 111] Compiled Mon 31-Mar-97 13:21 by ganesh Image text-base: 0x60010900, data-base: 0x6073E000 Stack trace from system failure: FP: 0x60AEA798, RA: 0x60189354 FP: 0x60AEA798, RA: 0x601853CC FP: 0x60AEA7C0, RA: 0x6015E98C FP: 0x60AEA7F8, RA: 0x6011AB3C FP: 0x60AEA828, RA: 0x601706CC FP: 0x60AEA878, RA: 0x60116340 FP: 0x60AEA890, RA: 0x6011632C Fault History Buffer: GS Software (RSP-PV-M), Experimental Version 11.1(2033) [ganesh 111] Compiled Mon 31-Mar-97 13:21 by ganesh Signal = 23, Code = 0x24, Uptime 00:04:19 $0 : 00000000, AT : 60930120, v0 : 00000032, v1 : 00000120 a0 : 60170110, a1 : 6097F22C, a2 : 00000000, a3 : 00000000 t0 : 60AE02A0, t1 : 8000FD80, t2 : 34008F00, t3 : FFFF00FF t4 : 00000083, t5 : 3E840024, t6 : 00000000, t7 : 11010132 s0 : 00000006, s1 : 607A25F8, s2 : 00000001, s3 : 00000000 s4 : 00000000, s5 : 00000000, s6 : 00000000, s7 : 6097F755 t8 : 600FABBC, t9 : 00000000, k0 : 30408401, k1 : 30410000 gp : 608B9860, sp : 60AEA798, s8 : 00000000, ra : 601853CC EPC : 60189354, SREG : 3400EF03, Cause : 00000024 Router> The following is sample output from the show context summary command on a Cisco 12012 router. The show context summary command displays a summary of all the crashes recorded for each slot (line card). Router# show context summary CRASH INFO SUMMARY Slot 0 : 0 crashes Slot 1 : 0 crashes Slot 2 : 0 crashes Slot 3 : 0 crashes Slot 4 : 0 crashes Slot 5 : 0 crashes Slot 6 : 0 crashes Slot 7 : 2 crashes 1 - crash at 18:06:41 UTC Tue Nov 5 1996 2 - crash at 12:14:55 UTC Mon Nov 4 1996 Slot 8 : 0 crashes Slot 9 : 0 crashes Slot 10: 0 crashes Slot 11: 0 crashes Router# The following is sample output from the show context command following an unexpected system reload on a Cisco 2600 series router. show context CF-627 Cisco IOS Configuration Fundamentals Command Reference April 2010 router# show context S/W Version: Cisco IOS Software Cisco IOS (tm) c2600 Software (c2600-JS-M), Released Version 11.3(19980115:184921] Copyright (c) 1986-2003 by Cisco Systems, Inc. Compiled Thu 15-Jan-98 13:49 by mmagno Exception occurred at: 00:02:26 UTC Mon Mar 1 1993 Exception type: Data TLB Miss (0x1200) CPU Register Context: PC = 0x80109964 MSR = 0x00009030 CR = 0x55FFFD35 LR = 0x80109958 CTR = 0x800154E4 XER = 0xC000BB6F DAR = 0x00000088 DSISR = 0x00000249 DEC = 0x7FFFDFCA TBU = 0x00000000 TBL = 0x15433FCF IMMR = 0x68010020 R0 = 0x80000000 R1 = 0x80E80BD0 R2 = 0x80000000 R3 = 0x00000000 R4 = 0x80E80BC0 R5 = 0x40800000 R6 = 0x00000001 R7 = 0x68010000 R8 = 0x00000000 R9 = 0x00000060 R10 = 0x00001030 R11 = 0xFFFFFFFF R12 = 0x00007CE6 R13 = 0xFFF379E8 R14 = 0x80D50000 R15 = 0x00000000 R16 = 0x00000000 R17 = 0x00000000 R18 = 0x00000000 R19 = 0x00000000 R20 = 0x00000000 R21 = 0x00000001 R22 = 0x00000010 R23 = 0x00000000 R24 = 0x00000000 R25 = 0x80E91348 R26 = 0x01936010 R27 = 0x80E92A80 R28 = 0x00000001 R29 = 0x019BA920 R30 = 0x00000000 R31 = 0x00000018 Stack trace: Frame 00: SP = 0x80E80BD0 PC = 0x80109958 Frame 01: SP = 0x80E80C28 PC = 0x8010A720 Frame 02: SP = 0x80E80C40 PC = 0x80271010 Frame 03: SP = 0x80E80C50 PC = 0x8025EE64 Frame 04: SP = 0x80DEE548 PC = 0x8026702C Frame 05: SP = 0x80DEE558 PC = 0x8026702C Table 65 describes the significant fields shown in the display. Related Commands Table 65 show context Field Descriptions Field Description S/W Version Standard Cisco IOS version string as displayed. Exception occurred at Router real time when exception occurred. The router must have the clock time properly configured for this to be accurate. Exception type Technical reason for exception. For engineering analysis. CPU Register Context Technical processor state information. For engineering analysis. Stack trace Technical processor state information. For engineering analysis. Command Description show processes Displays information about the active processes. show stacks Monitors the stack usage of processes and interrupt routines. show controllers (GRP image) CF-628 Cisco IOS Configuration Fundamentals Command Reference April 2010 show controllers (GRP image) To display information that is specific to the hardware, use the show controllers command in privileged EXEC mode. show controllers [atm slot-number | clock | csar [register] | csc-fpga | dp83800 | fab-clk | fia [register] | pos [slot-number] [details] | queues [slot-number] | sca | xbar] Syntax Description Command Modes Privileged EXEC atm slot-number (Optional) Displays the ATM controllers. Number is slot-number/ port-number (for example, 4/0). Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008 router. clock (Optional) Displays the clock card configuration. csar [register] (Optional) Displays the Cisco Cell Segmentation and Reassembly (CSAR) information. CSAR is the name of the chip on the card that handles traffic between the GRP and the switch fabric interface ASICs. csc-fpga (Optional) Displays the clock and scheduler card register information in the field programmable gate array (FPGA). dp83800 (Optional) Displays the Ethernet information on the GRP card. fab-clk (Optional) Display the switch fabric clock register information. The switch fabric clock FPGA is a chip that monitors the incoming fabric clock generated by the switch fabric. This clock is needed by each card connecting to the switch fabric to properly communicate with it. Two switch fabric clocks arrive at each card; only one can be used. The FPGA monitors both clocks and selects which one to use if only one of them is running. fia [register] (Optional) Displays the fabric interface ASIC information and optionally displays the register information. pos [slot-number] [details] (Optional) Displays the POS framer state and optionally displays all the details for the interface. Number is slot-number/port-number (for example, 4/0). Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008 router. queues [slot-number] (Optional) Displays the SDRAM buffer carve information and optionally displays the information for a specific line card. The SDRAM buffer carve information displayed is suggested carve information from the GRP card to the line card. Line cards might change the shown percentages based on SDRAM available. Slot numbers range from 0 to 11 for the Cisco 12012 router and from 0 to 7 for the Cisco 12008. sca (Optional) Displays the SCA register information. The SCA is an ASIC that arbitrates among the line cards requests to use the switch fabric. xbar (Optional) Displays the crossbar register information. The XBAR is an ASIC that switches the data as it passes through the switch fabric. show controllers (GRP image) CF-629 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command History Usage Guidelines This information provided by this command is intended for use only by technical support representatives in analyzing system failures in the field. Examples The following is sample output from the show controllers pos command for a Cisco 12012: Router# show controllers pos 7/0 POS7/0 SECTION LOF = 2 LOS = 0 BIP(B1) = 5889 Active Alarms: None LINE AIS = 2 RDI = 2 FEBE = 146 BIP(B2) = 2106453 Active Alarms: None PATH AIS = 2 RDI = 4 FEBE = 63 BIP(B3) = 3216 LOP = 0 PSE = 8 NSE = 3 NEWPTR = 2 Active Alarms: None APS COAPS = 3 PSBF = 2 State: PSBF_state = False Rx(K1/K2): F0/15 Tx(K1/K2): 00/00 S1S0 = 00, C2 = 64 PATH TRACE BUFFER : STABLE Remote hostname : GSR-C Remote interface: POS10/0 Remote IP addr : 10.201.101.2 Remote Rx(K1/K2): F0/15 Tx(K1/K2): 00/00 Router# Related Commands Release Modification 11.2 GS This command was introduced to support the Cisco 12000 series routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description clear controllers Resets the T1 or E1 controller. show controllers (line card image) Displays information that is specific to the hardware on a line card. show controllers (line card image) CF-630 Cisco IOS Configuration Fundamentals Command Reference April 2010 show controllers (line card image) To display information that is specific to the hardware on a line card, use the attach command in privileged EXEC mode to connect to the line card and then use the show controllers command in privileged EXEC mode or the execute-on command in privileged EXEC mode. show controllers atm [[port-number] [all | sar | summary]] show controllers fia [register] show controllers {frfab | tofab} {bma {microcode | ms-inst | register} | qelem start-queue-element [end-queue-element] | qnum start-queue-number [end-queue-number] | queues | statistics} show controllers io show controllers l3 show controllers pos {framers | queues | registers | rxsram port-number queue-start-address [queue-length] | txsram port-number queue-start-address [queue-length]} show controllers events [clear | punt-sniff [none | word1 | word2] | punt-verbose [all]] Syntax Description atm Displays the ATM controller information. port-number (Optional) Displays request for the physical interface on the ATM card. The range of choices is from 0 to 3. all (Optional) Lists all details. sar (Optional) Lists SAR interactive command. summary (Optional) Lists SAR status summary. fia Displays the fabric interface ASIC information. register (Optional) Displays the register information. frfab (Optional) Displays the "from" (transmit) fabric information. tofab (Optional) Displays the "to" (receive) fabric information. bma For the frfab or tofab keywords, displays microcode, micro sequencer, or register information for the silicon queuing engine (SQE), also known as the buffer management ASIC (BMA). microcode Displays SQE information for the microcode bundled in the line card and currently running version. mis-inst Displays SQE information for the micro sequencer instruction. register Displays silicon queuing engine (SQE) information for the register. qelem For the frfab or tofab keywords, displays the SDRAM buffer pool queue element summary information. start-queue-element Specifies the start queue element number from 0 to 65535. end-queue-element (Optional) Specifies the end queue element number from 0 to 65535). show controllers (line card image) CF-631 Cisco IOS Configuration Fundamentals Command Reference April 2010 qnum For the frfab or tofab keywords, displays the SDRAM buffer pool queue detail information. start-queue-number Specifies the start free queue number (from 0 to 127). end-queue-number (Optional) Specifies the end free queue number (from 0 to 127). queues For the frfab or tofab keywords, displays the SDRAM buffer pool information. statistics For the frfab or tofab keywords, displays the BMA counters. io Displays input/output registers. l3 Displays Layer 3 ASIC information. pos Displays packet-over-sonic (POS) information for framer registers, framer queues, and ASIC registers. framers Displays the POS framer registers. queues Displays the POS framer queue information. registers Displays the ASIC registers. rxsram Displays the receive queue SRAM. port-number Specifies a port number (valid range is from 0 to 3). queue-start-address Specifies the queue SRAM logical starting address. queue-length (Optional) Specifies the queue SRAM length. txsram Displays the transmit queue SRAM. events Displays the line card counter information of events generated from line card. clear (Optional) Clears all the line card event counter output details that are displayed using the commands: show controllers events, show controllers events punt-verbose, and show controllers events punt-sniff. punt-sniff (Optional) Sniffs the packets sent to route processor from line card by specifying the word and location. Note Punt sniff is enabled only if one of the word is configured. none (Optional) Clears the attributes and packets to be sniffed from route processor and resets the counters to zero. word1 (Optional) Sniffs packets sent to the route processor for the specified hexa decimal value of word1. Location of the word is optional. word2 (Optional) Sniffs packets sent to the route processor matching the specified hexa decimal value of word2. Location of the word is optional. punt-verbose (Optional) Displays application-wise packets punt to route processor (RP) from line card (LC). Displays non-zero punt counters if the command is executed without the all keyword. all (Optional) Displays zero and non-zero punt counters of packets punt to RP from LC. The all keyword is used along with the command show controllers events punt-verbose all. show controllers (line card image) CF-632 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes Privileged EXEC Command History Usage Guidelines This information displayed by this command is of use only to technical support representatives in analyzing unexpected system failures in the field. It is documented here in case you need to provide the displayed statistics to an technical support engineer. Cisco 10000 Series Router Usage Guidelines In releases prior to Cisco IOS Release 12.2(33)SB, when you configure the t1 loopback remote command on the local router, the command also displays in the running-config file of the far-end router. This is due to the route processor (RP) updating an incorrect parameter when it receives the loopback event message from the line card for loopback requests from the far end. In Cisco IOS Release 12.2(33)SB, the RP updates the correct parameter and the show controllers command correctly displays the loopback CLI commands applied on the local end and displays the loopback events and status received from the line card in response to loopback requests from the far end. This change in behavior affects the following line cards and is documented in the CSCsm84447 caveat: • 4-port channelized STM1 • 1-port channelized OC-12 • 6-port channelized T3 • 4-port half-height channelized T3 In Cisco IOS Release 12.2(33)SB, the output from the show controller command includes line code information for the 6-port channelized T3 line card and the 8-port E3/DS3 line card. However, because SONET line cards do not have a direct physical link at the T3 or E3 level, the output from the show controller t3 command does not include line code information. In Cisco IOS Release 12.2(31)SB, the output from the show controller command displays line code information. The output of the show controller t3 command for SONET-based T3 also includes line code information. Cisco 12000 Series Router Usage Guidelines The packets processed by a line card are either sent to a route processor or a line card in the form of Cisco cells. To track the packets sent to a route processor from a line card is essential for troubleshooting. The keywords punt-sniff and punt-verbose have been added for the command show controllers events to identify the packets sent to RP from LC. Release Modification 11.2 GS This command was added to support the Cisco 12000 series Gigabit Switch Routers. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB This command was integrated in Cisco IOS Release 12.2(31)SB. 12.2(33)SB This command’ behavior was modified on the Cisco 10000 series router for the PRE3 and PRE4. 12.0(33)S The keywords punt-sniff and punt-verbose were added in the command show controllers events for the Cisco 12000 Series Routers. show controllers (line card image) CF-633 Cisco IOS Configuration Fundamentals Command Reference April 2010 By default, the feature is enabled and packets punt to route processor are displayed using the command show controllers events punt-verbose. To view all the zero and non-zero punt counters use the command show controllers events punt-verbose all. To clear all the line card events and counters including resetting the packets to be sniffed to zero, executing the command show controllers events clear. Packets sent to route processor from line card can be sniffed by specifying the hexa-decimal value of the word. Packets can only be sniffed if the word along with the hexa-decimal value is specified. Specifying the location of the word, sniffs packets from the particular location. To reset the counters of packets to be sniffed to zero, execute the command show controllers events punt-sniff none. For example, use the command show controllers events punt-sniff word1 0x60000000 to sniff packets punt to RP with the hexa-decimal value 0x60000000. As the location is not specified, it searches the entire buffer for the value 0x60000000. Packets punt to RP can also be sniffed by specifying a particular location using the command show controllers events punt-sniff word1 0x60000000 34. Examples Because you are executing this command on the line card, you must use the execute-on command to use the show command, or you must connect to the card using the attach command. All examples in this section use the execute-on command The following is partial sample output from the show controllers atm command: Router# execute-on slot 4 show controllers atm 0 TX SAR (Beta 1.0.0) is Operational; RX SAR (Beta 1.0.0) is Operational; Interface Configuration Mode: STS-12c Active Maker Channels: total # 6 VCID ChnnlID Type OutputInfo InPkts InOAMs MacString 1 0888 UBR 0C010010 0 0 08882000AAAA030000000800 2 0988 VBR 04010020 0 0 09882000 3 8BC8 UBR 0C010030 0 0 8BC82000AAAA030000000800 4 0E08 UBR 0C010040 0 0 0E082000AAAA030000000800 10 1288 VBR 040100A0 0 0 12882000 11 8BE8 VBR 0C0100B0 0 0 8BE82000AAAA030000000800 SAR Total Counters: total_tx_idle_cells 215267 total_tx_paks 0 total_tx_abort_paks 0 total_rx_paks 0 total_rx_drop_paks 0 total_rx_discard_cells 15 Switching Code Counters: total_rx_crc_err_paks 0 total_rx_giant_paks 0 total_rx_abort_paks 0 total_rx_crc10_cells 0 total_rx_tmout_paks 0 total_rx_unknown_paks 0 total_rx_out_buf_paks 0 total_rx_unknown_vc_paks 0 BATMAN Asic Register Values: hi_addr_reg 0x8000, lo_addr_reg 0x000C, boot_msk_addr 0x0780, rmcell_msk_addr 0x0724, rmcnt__msk_addr 0x07C2, txbuf_msk_addr 0x070C, . . . CM622 SAR Boot Configuration: txind_q_addr 0x14000 txcmd_q_addr 0x20000 . . . SUNI-622 Framer Register Values: show controllers (line card image) CF-634 Cisco IOS Configuration Fundamentals Command Reference April 2010 Master Rst and Ident/Load Meters Reg (#0x0): 0x10 Master Configuration Reg (#0x1): 0x1F Master Interrupt Status Reg (#0x2): 0x00 PISO Interrupt Reg (#0x3): 0x04 Master Auto Alarm Reg (#0x4): 0x03 Master Auto Alarm Reg (#0x5): 0x07 Parallel Output Port Reg (#0x6): 0x02 . . . BERM Line BIP Threshold LSB Reg (#0x74): 0x00 BERM Line BIP Threshold MSB Reg (#0x75): 0x00 Router# The following is partial sample output from the show controllers command: Router# execute-on slot 6 show controllers Interface POS0 Hardware is BFLC POS lcpos_instance struct 60311B40 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000400 SUNI rsop intr status 00 CRC32 enabled, HDLC enc, int clock no loop Interface POS1 Hardware is BFLC POS lcpos_instance struct 603142E0 RX POS ASIC addr space 12000000 TX POS ASIC addr space 12000100 SUNI framer addr space 12000600 SUNI rsop intr status 00 CRC32 enabled, HDLC enc, int clock no loop . . . Router# The following is partial sample output from the show controllers pos framers command: Router# execute-on slot 6 show controllers pos framers Framer 0, addr=0x12000400: master reset C0 master config 1F rrate sts3c trate sts3c fixptr master control 00 clock rcv cntrl D0 RACP control 84 RACP gfc control 0F TACP control status 04 hcsadd RACP intr enable 04 RSOP cntrl intr enable 00 RSOP intr status 00 TPOP path sig lbl (c2) 13 SPTB control 04 tnull SPTB status 00 Framer 1, addr=0x12000600: master reset C0 master config 1F rrate sts3c trate sts3c fixptr show controllers (line card image) CF-635 Cisco IOS Configuration Fundamentals Command Reference April 2010 master control 00 clock rcv cntrl D0 RACP control 84 RACP gfc control 0F TACP control status 04 hcsadd RACP intr enable 04 RSOP cntrl intr enable 00 RSOP intr status 00 TPOP path sig lbl (c2) 13 SPTB control 04 tnull SPTB status 00 Framer 2, addr=0x12000800: master reset C0 master config 1F rrate sts3c trate sts3c fixptr master control 00 clock rcv cntrl D0 RACP control 84 RACP gfc control 0F TACP control status 04 hcsadd RACP intr enable 04 RSOP cntrl intr enable 00 RSOP intr status 00 TPOP path sig lbl (c2) 13 SPTB control 04 tnull SPTB status 00 . . . Router# The following is partial sample output from the show controllers fia command: Router# execute-on slot 7 show controllers fia ========= Line Card (Slot 7) ======= Fabric configuration: Full bandwidth redundant Master Scheduler: Slot 17 From Fabric FIA Errors ----------------------- redund fifo parity 0 redund overflow 0 cell drops 0 crc32 lkup parity 0 cell parity 0 crc32 0 0 1 2 3 4 -------- -------- -------- -------- -------- los 0 0 0 0 0 crc16 0 0 0 0 0 To Fabric FIA Errors ----------------------- sca not pres 0 req error 0 uni fifo overflow 0 grant parity 0 multi req 0 uni fifo undrflow 0 cntrl parity 0 uni req 0 crc32 lkup parity 0 multi fifo 0 empty dst req 0 handshake error 0 The following is a sample output from the show controllers events command: Router# execute-on slot 7 show controllers events Switching Stats Packets punt to RP: 935 HW engine punt: 62 HW engine reject: 38113520 show controllers (line card image) CF-636 Cisco IOS Configuration Fundamentals Command Reference April 2010 RX HW Engine Reject Counters Unrecognized Protocol ID: 19182546 IP TTL Expired: 14706652 Unrecognized L2 Frame: 4224320 IPv6 Control pkts: 2 The following is a sample output from the show controllers events punt-verbose command: Router# execute-on slot 7 show controllers events punt-verbose RP Punted L2 Statistics in Verbose ------------------------------------ HDLC Encap : 927 RP Punted L3 Statistics in Verbose ------------------------------------ ICMP : 40 UDP : 441 OSPF : 211 IPV6 : 40 RP Punted L3 Application Statistics in Verbose ----------------------------------------------- LDP : 441 DF Bit not Set : 692 The following is a partial sample output from the show controllers events punt-verbose all command which displays the zero and non-zero value of packets punt to RP from LC: Router# execute-on slot 7 show controllers events punt-verbose all RP Punted L2 Statistics in Verbose ------------------------------------ L2 Protocol - 0 : 0 ARPA Encap : 0 L2 Protocol - 2 : 0 L2 Protocol - 3 : 0 L2 Protocol - 4 : 0 HDLC Encap : 941 L2 Protocol - 6 : 0 L2 Protocol - 7 : 0 L2 Protocol - 8 : 0 L2 Protocol - 9 : 0 L2 Protocol - 10 : 0 L2 Protocol - 11 : 0 L2 Protocol - 12 : 0 L2 Protocol - 13 : 0 L2 Protocol - 14 : 0 L2 Protocol - 15 : 0 PPP Encap : 0 L2 Protocol - 17 : 0 L2 Protocol - 18 : 0 L2 Protocol - 19 : 0 Frame Relay Encap : 0 L2 Protocol - 21 : 0 L2 Protocol - 22 : 0 L2 Protocol - 23 : 0 L2 Protocol - 24 : 0 L2 Protocol - 25 : 0 L2 Protocol - 26 : 0 L2 Protocol - 27 : 0 L2 Protocol - 28 : 0 L2 Protocol - 29 : 0 show controllers (line card image) CF-637 Cisco IOS Configuration Fundamentals Command Reference April 2010 L2 Protocol - 30 : 0 L2 Protocol - 31 : 0 L2 Protocol - 32 : 0 ATM Encap : 0 L2 Protocol - 34 : 0 L2 Protocol - 35 : 0 RP Punted L3 Statistics in Verbose ------------------------------------ HOPOPT : 0 ICMP : 40 IGMP : 0 L3 Protocol - 3 : 0 IPINIP : 0 L3 Protocol - 5 : 0 RP Punted L3 Application Statistics in Verbose ----------------------------------------------- MPLS OAM : 0 FTP : 0 FTPD : 0 TFTP : 0 ..... The following is a sample output from the show controllers events clear command: Router# execute-on slot 7 show controllers events clear Drop, switching and reject counters cleared The following is a sample output from the show controllers events punt-sniff command: Router# execute-on slot 7 show controllers events punt-sniff Punt Sniff Statistics -------------------------------- Word Location Occurance 0x60000000 34 0 0xB6010102 37 5 Note: Location offset taken from the begining of BufferHeader(32 bytes). The following is a sample output from the show controllers events punt-sniff word1 0x60000000 command. This command is used to sniff a packet with a hexa-decimal value 0x60000000 from the start of the buffer header of the packet being punt to RP: Router# execute-on slot 7 show controllers events punt-sniff word1 0x60000000 The following is a sample output from the show controllers events punt-sniff word1 0x60000000 34 command. This command is used to sniff a packet with a hexa-decimal value 0x60000000 0 at the location 34 from the start of the buffer header of the packet being punt to RP: Router# execute-on slot 7 show controllers events punt-sniff word1 0x60000000 34 The following is a sample output from the show controllers events punt-sniff none command. This command is used to clear the counter of packets to be sniffed: Router# execute-on slot 7 show controllers events punt-sniff none Related Commands Command Description clear controllers Resets the T1 or E1 controller. show controllers logging CF-638 Cisco IOS Configuration Fundamentals Command Reference April 2010 show controllers logging To display logging information about a Versatile Interface Processor (VIP) card, use the show controllers logging command in privileged EXEC mode. show controllers vip slot-number logging Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines This command displays the state of syslog error and event logging, including host addresses, and whether console logging is enabled. When enabled, “trap logging” allows messages to be sent to a remote host (a syslog server). Examples The following is sample output from the show controllers logging command: Router# show controllers vip 1 logging show logging from Slot 1: Syslog logging:enabled (0 messages dropped, 1 messages rate-limited, 0 flushes, 0 overruns) Console logging: disabled Monitor logging: level debugging, 0 messages logged Buffer logging: level debugging, 24 messages logged Trap logging: level informational, 266 messages logged. Logging to 209.165.202.129 Exception Logging size: 4096 bytes Count and timestamp logging messages:disabled Log Buffer (8192 bytes): smallest_local_pool_entries = 256, global particles = 5149 highest_local_visible_bandwidth = 155000 00:00:05:%SYS-5-RESTART:System restarted -- . . . Table 66 describes the significant fields shown in the display. vip slot-number VIP slot number. Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show controllers logging CF-639 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Table 66 show controllers logging Field Descriptions Field Description Syslog logging Shows general state of system logging (enabled or disabled), and status of logged messages (number of messages dropped, rate-limited, or flushed). Console logging Logging to the console port. Shows "disabled" or, if enabled, the severity level limit and number of messages logged. Enabled using the logging console command. Monitor logging Logging to the monitor (all TTY lines). Shows "disabled" or, if enabled, the severity level limit and number of messages logged. Enabled using the logging monitor command. Buffer logging Logging to the standard syslog buffer. Shows "disabled" or, if enabled, the severity level limit and number of messages logged. Enabled using the logging buffered command. Trap logging Logging to a remote host (syslog host). Shows "disabled" or, if enabled, the severity level limit and number of messages logged. (The word "trap" means a trigger in the system software for sending error messages to a remote host.) Enabled using the logging host command. The severity level limit is set using the logging trap command. Command Description show logging Displays the state of logging (syslog). show controllers tech-support CF-640 Cisco IOS Configuration Fundamentals Command Reference April 2010 show controllers tech-support To display general information about a Versatile Interface Processor (VIP) card when reporting a problem, use the show controllers tech-support command in privileged EXEC mode. show controllers vip slot-number tech-support Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines Use this command to help collect general information about a VIP card when you are reporting a problem. This command displays the equivalent of the following show commands for the VIP card: • more system:running-config • show buffers • show controllers • show interfaces • show processes cpu • show processes memory • show stacks • show version For a sample display of the show controllers tech-support command output, refer to these show commands. Related Commands vip slot-number VIP slot number. Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description more system:running-config Displays the running configuration. show buffers Displays statistics for the buffer pools on the network server. show controllers Displays information that is specific to the hardware. show interfaces Uses the show interfaces EXEC command to display ALC information. show processes Displays information about the active processes. show processes memory Displays memory used. show stacks Monitors the stack usage of processes and interrupt routines. show controllers tech-support CF-641 Cisco IOS Configuration Fundamentals Command Reference April 2010 show tech-support Displays general information about the router when reporting a problem. show version Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images. Command Description show coverage history CF-642 Cisco IOS Configuration Fundamentals Command Reference April 2010 show coverage history To display the system history table, use the show coverage history command in privileged EXEC mode. show coverage history [all | first number-of-entries | last number-of-entries | status] Syntax Description Command Modes Privileged EXEC (#) Command History Examples The following is sample output from the show coverage history command. The output is self-explanatory. Router# show coverage history status History table size is 23 entries. 0 entries have been used. Low-level count handler has been called 0 times. There were 0 entries not traced due to recursion detection. There were 0 entries not traced due to internal pauses. Related Commands all (Optional) Displays the entire history table. first (Optional) Displays the oldest entries in the history table. number-of-entries (Optional) Number of entries to be displayed. The range is from 1 to 100000. last (Optional) Displays the latest entries in the history table. status (Optional) Displays the status of the history system. Release Modification 12.4(24)T This command was introduced in a release earlier than Cisco IOS Release 12.4(24)T. Command Description coverage history Enables the system to record the history of the events. show data-corruption CF-643 Cisco IOS Configuration Fundamentals Command Reference April 2010 show data-corruption To display data inconsistency errors of the present software version, use the show data-corruption command in user EXEC or privileged EXEC mode. show data-corruption Syntax Description This command has no arguments or keywords. Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines Use this command to display all data inconsistency errors or the corrupt data. If there are no data errors, the “No data inconsistency errors have been recorded” message is displayed. Examples The following is sample output from show data-corruption command. The fields are self-explanatory. Router# show data-corruption Data inconsistency records for: 3800 Software (C3845-ADVIPSERVICESK9-M), Version 12.4(24)T, RELEASE SOFTWARE (fc2) Technical Support: http://www.cisco.com/techsupport Compiled Thu 17-Dec-09 09:02 by xyz Count Traceback 1842 60523C58, 616E85FC 60523C58 62A9F648 1: Jun 12 18:24:33.960 2: Jun 12 18:24:33.960 3: Jun 12 18:24:33.960 1842: Jun 19 00:30:51.350 Release Modification 12.2(22)SE This command was introduced. 12.2(33)SRB This command was integrated into Cisco IOS Release 12.2(33)SRB. 12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI. Cisco IOS 2.3 XE This command was integrated into Cisco IOS XE Release 2.3. show debugging CF-644 Cisco IOS Configuration Fundamentals Command Reference April 2010 show debugging To display information about the types of debugging that are enabled for your router, use the show debugging command in privileged EXEC mode. show debugging Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC (#) Command History Examples The following is sample output from the show debugging command. In this example, the remote host is not configured or connected. Router# show debugging ! TCP: TCP Packet debugging is on TCP ECN debugging is on ! Router# telnet 10.1.25.234 ! Trying 10.1.25.234 ... ! 00:02:48: 10.1.25.31:11001 <---> 10.1.25.234:23 out ECN-setup SYN 00:02:48: tcp0: O CLOSED 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 ECE CWR SYN WIN 4128 00:02:50: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:02:50: cwnd from 1460 to 1460, ssthresh from 65535 to 2920 00:02:50: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 ECE CWR SYN WIN 4128 00:02:54: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:02:54: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 00:02:54: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 ECE CWR SYN WIN 4128 00:03:02: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:03:02: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 Release Modification 11.1 This command was introduced. 12.3(7)T The output of this command was enhanced to show TCP Explicit Congestion Notification (ECN) configuration. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(31)SB2 This command was integrated into Cisco IOS Release 12.2(31)SB2. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. 12.4(20)T The output of this command was enhanced to show the user-group debugging configuration. show debugging CF-645 Cisco IOS Configuration Fundamentals Command Reference April 2010 00:03:02: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 ECE CWR SYN WIN 4128 00:03:18: 10.1.25.31:11001 <---> 10.1.25.234:23 SYN with ECN disabled 00:03:18: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:03:18: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 00:03:18: tcp0: O SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 SYN WIN 4128 00:03:20: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:03:20: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 00:03:20: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 SYN WIN 4128 00:03:24: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:03:24: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 00:03:24: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 SYN WIN 4128 00:03:32: 10.1.25.31:11001 <---> 10.1.25.234:23 congestion window changes 00:03:32: cwnd from 1460 to 1460, ssthresh from 2920 to 2920 00:03:32: tcp0: R SYNSENT 10.1.25.234:11001 10.1.25.31:23 seq 1922220018 OPTS 4 SYN WIN 4128 !Connection timed out; remote host not responding The following is sample output from the show debugging command when user-group debugging is configured: Router# show debugging ! usergroup: Usergroup Deletions debugging is on Usergroup Additions debugging is on Usergroup Database debugging is on Usergroup API debugging is on ! Table 67 describes the significant fields in the output. Table 67 show debugging Field Descriptions Field Description OPTS 4 Bytes of TCP expressed as a number. In this case, the bytes are 4. ECE Echo congestion experience. CWR Congestion window reduced. SYN Synchronize connections—Request to synchronize sequence numbers, used when a TCP connection is being opened. WIN 4128 Advertised window size, in bytes. In this case, the bytes are 4128. cwnd Congestion window (cwnd)—Indicates that the window size has changed. ssthresh Slow-start threshold (ssthresh)—Variable used by TCP to determine whether or not to use slow-start or congestion avoidance. usergroup Statically defined usergroup to which source IP addresses are associated. show declassify CF-646 Cisco IOS Configuration Fundamentals Command Reference April 2010 show declassify To display the state of the declassify function (enabled, in progress, and so forth) and the sequence of declassification steps that will be performed, use the show declassify command in global configuration mode. show declassify Syntax Description This command has no arguments or keywords. Note The show declassify command is supported on the Cisco 3200 series routers only. Command Modes Global configuration Command History Examples The following example is sample output for the show declassify command: Router# show declassify Declassify facility: Enabled=Yes In Progress=No Erase flash=Yes Erase nvram=Yes Obtain memory size Shutdown Interfaces Declassify Console and Aux Ports Erase flash Declassify NVRAM Declassify Communications Processor Module Declassify RAM, D-Cache, and I-Cache Table 68 describes the significant fields shown in the display. Release Modification 12.3(8)YD This command was introduced. 12.4(2)T This command was integrated into Cisco IOS Release 12.4(2)T. Table 68 show declassify Field Descriptions Field Description Enabled A “Yes” value indicates that zeroization is enabled. A “No” value indicates that zeroization is disabled. In Progress A “Yes” value indicates that zeroization is currently in progress. A “No” value indicates that zeroization is currently not in progress. show declassify CF-647 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Erase flash A “Yes” value indicates that erasure of Flash memory is enabled. A “No” value indicates that the erasure of Flash memory is disabled. Erase nvram A “Yes” value indicates that the erasure of NVRAM is enabled. A “No” value indicates that the erasure of NVRAM is disabled. Obtain memory size Obtain the main memory size in order to understand how much of the memory is to be scrubbed. Shutdown Interfaces Shut down any and all network interfaces. Declassify Console and AUX Ports Remove potentially sensitive information from console and AUX port FIFOs. Erase flash Erase Flash memory. Declassify NVRAM Erase NVRAM. Declassify Communications Processor Module Erase the memory in the Communications Processor Module (CPM). Declassify RAM, D-Cache, and I-Cache Scrub the main memory, erase the Data Cache (D-Cache), and erase the Instruction Cache (I-Cache). Table 68 show declassify Field Descriptions (continued) Field Description Command Description service declassify Invokes declassification. show derived-config CF-648 Cisco IOS Configuration Fundamentals Command Reference April 2010 show derived-config To display the composite results of all the configuration commands that apply to an interface, including commands that come from sources such as static templates, dynamic templates, dialer interfaces, and authentication, authorization, and accounting (AAA) per-user attributes, use the show derived-config command in privileged EXEC mode. show derived-config [interface type number] Syntax Description Command Modes Privileged EXEC Command History Usage Guidelines Configuration commands can be applied to an interface from sources such as static templates, dynamic templates bound by resource pooling, dialer interfaces, AAA per-user attributes and the configuration of the physical interface. The show derived-config command displays all the commands that apply to an interface. The output for the show derived-config command is nearly identical to that of the show running-config command. It differs when the configuration for an interface is derived from a template, a dialer interface, or some per-user configuration. In those cases, the commands derived from the template, dialer interface, and so on, will be displayed for the affected interface. If the same command is configured differently in two different sources that apply to the same interface, the command coming from the source that has the highest precedence will appear in the display. Examples The following examples show sample output for the show running-config and show derived-config commands for serial interface 0:23 and dialer interface 0. The output of the show running-config and show derived-config commands is the same for dialer interface 0 because none of the commands that apply to that interface are derived from any sources other than the configuration of the dialer interface. The output for the show running-config and show derived-config commands for serial interface 0:23 differs because some of the commands that apply to serial interface 0:23 come from dialer interface 0. Router# show running-config interface Serial0:23 Building configuration... Current configuration :296 bytes ! interface Serial0:23 description PRI to ADTRAN (#4444150) interface type number (Optional) Displays the derived configuration for a specific interface. If you use the interface keyword, you must specify the interface type and the interface number (for example, interface ethernet 0). Release Modification 12.1 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show derived-config CF-649 Cisco IOS Configuration Fundamentals Command Reference April 2010 ip unnumbered Loopback0 encapsulation ppp dialer rotary-group 0 isdn switch-type primary-dms100 isdn incoming-voice modem isdn calling-number 4444150 peer default ip address pool old_pool end Router# show running-config interface Dialer0 Building configuration... Current configuration :257 bytes ! interface Dialer0 description Dialin Users ip unnumbered Loopback0 no ip proxy-arp encapsulation ppp dialer in-band dialer idle-timeout 30 dialer-group 1 peer default ip address pool new_pool ppp authentication pap chap callin end Router# show derived-config interface Serial0:23 Building configuration... Derived configuration :332 bytes ! interface Serial0:23 description PRI to ADTRAN (#4444150) ip unnumbered Loopback0 encapsulation ppp dialer rotary-group 0 isdn switch-type primary-dms100 isdn incoming-voice modem isdn calling-number 4444150 peer default ip address pool new_pool ppp authentication pap chap callin end Router# show derived-config interface Dialer0 Building configuration... Derived configuration :257 bytes ! interface Dialer0 description Dialin Users ip unnumbered Loopback0 no ip proxy-arp encapsulation ppp dialer in-band dialer idle-timeout 30 dialer-group 1 peer default ip address pool new_pool ppp authentication pap chap callin end show derived-config CF-650 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Command Description show running-config Displays the contents of the currently running configuration file or the configuration for a specific interface. show diagnostic cns CF-651 Cisco IOS Configuration Fundamentals Command Reference April 2010 show diagnostic cns To display the information about the CNS subject, use the show diagnostic cns command in user EXEC or privileged EXEC mode. show diagnostic cns {publish | subscribe} Syntax Description Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines This command is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2. The CNS subsystem communicates with remote network applications through the CNS-event agent and follows the publish and subscribe model. An application sets itself up to receive events by subscribing to the approprate event subject name. Examples This example shows how to display the subject with which the diagnostic results is published: Router# show diagnostic cns publish Subject: cisco.cns.device.diag_results This example shows how to display the subscribed subject: Router# show diagnostic cns subscribe Subject: cisco.cns.device.diag_get_results Related Commands publish Displays the subject with which the diagnostic results is published. subscribe Displays the subscribed subjects. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description diagnostic cns Configures the CNS diagnostics. show diagnostic sanity CF-652 Cisco IOS Configuration Fundamentals Command Reference April 2010 show diagnostic sanity To display sanity check results, use the show diagnostic sanity command in privileged EXEC mode. show diagnostic sanity Syntax Description This command has no arguments or keywords. Defaults Displays information for all the Gigabit Ethernet WAN interfaces in the Cisco 7600 series router. Command Modes Privileged EXEC Command History Usage Guidelines The sanity check runs a set of predetermined checks on the configuration with a possible combination of certain system states to compile a list of warning conditions. The checks are designed to look for anything that seems out of place and are intended to serve as an aid to maintaining the system sanity. The following is a list of the checks that are run and the action taken when the condition is found: • Checks whether the default gateways are reachable. If so, the system stops pinging. • If a port auto-negotiates to half duplex, the system flags it. Trunking Checks • If a trunk port has the mode set to “on,” the system flags it. • If a port is trunking and mode is auto, the system flags it. • If a trunk port is not trunking and the mode is desirable, the system flags it. • If a trunk port negotiates to half duplex, the system flags it. Channeling Checks • If a port has channeling mode set to on, the system flags it. • If a port is not channeling and the mode is set to desirable, the system flags it. • If a VLAN has a Spanning-Tree root of 32K (root is not set), the system flags it. Spanning-Tree VLAN Checks • If a VLAN has a max age on the Spanning-Tree root that is different than the default, the system flags it. • If a VLAN has a fwd delay on the Spanning-Tree root that is different than the default, the system flags it. • If a VLAN has a fwd delay on the bridge that is different than the default, the system flags it. Release Modification 12.2(18)SXE Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show diagnostic sanity CF-653 Cisco IOS Configuration Fundamentals Command Reference April 2010 • If a VLAN has a fwd delay on the bridge that is different than the default, the system flags it. • If a VLAN has a hello time on the bridge that is different than the default, the system flags it. Spanning-Tree Port Checks • If a port has a port cost that is different than the default, the system flags it. • If a port has a port priority that is different than the default, the system flags it. UDLD Checks • If a port has UDLD disabled, the system flags it. • If a port had UDLD shut down, the system flags it. • If a port had a UDLD undetermined state, the system flags it. Assorted Port Checks • If a port had receive flow control disabled, the system flags it. • If a trunk port had PortFast enabled, the system flags it. • If a inline power port has any of the following states: – denied – faulty – other – off The system flags it. • If a port has a native VLAN mismatch, the system flags it. • If a port has a duplex mismatch, the system flags it. Bootstring and Config Register Checks • The config register on the primary supervisor engine (and on the secondary supervisor engine if present) must be one of the following values: 0x2 , 0x102, or 0x2102. • The system verifies the bootstring on the primary supervisor engine (and on the secondary supervisor engine if present). The system displays a message if the bootstring is empty. • The system verifies that every file is specified in the bootstring. The system displays a message if the file is absent or shows up with a wrong checksum. If only device: is specified as a filename, then the system verifies that the first file is on the device. Assorted Checks • The system displays a message if IGMP snooping is disabled. • The system displays a message if any of the values of the snmp community access strings {RO,RW,RW-ALL} is the same as the default. • The system displays a message if any of the modules are in states other than “Ok.” • The system displays a message that lists all the tests that failed (displayed as an “F”) in the show test all command. • The system displays a message if fast is not configured on the switch anywhere. • The system displays a message if there is enough room for the crashinfo file on the bootflash:. • The system displays a message if multicast routing is enabled globally but is not applied to all interfaces. show diagnostic sanity CF-654 Cisco IOS Configuration Fundamentals Command Reference April 2010 • The system displays a message if IGMP snooping is disabled and RGMP is enabled. Examples This example displays samples of the messages that could be displayed with the show diagnostic sanity command: Router# show diagnostic sanity Pinging default gateway 10.6.141.1 .... Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 10.6.141.1, timeout is 2 seconds: ..!!. Success rate is 0 percent (0/5) IGMP snooping disabled please enable it for optimum config. IGMP snooping disabled but RGMP enabled on the following interfaces, please enable IGMP for proper config : Vlan1, Vlan2, GigabitEthernet1/1 Multicast routing is enabled globally but not enabled on the following interfaces: GigabitEthernet1/1, GigabitEthernet1/2 A programming algorithm mismatch was found on the device bootflash: Formatting the device is recommended. The bootflash: does not have enough free space to accomodate the crashinfo file. Please check your confreg value : 0x0. Please check your confreg value on standby: 0x0. The boot string is empty. Please enter a valid boot string . Could not verify boot image "disk0:" specified in the boot string on the slave. Invalid boot image "bootflash:asdasd" specified in the boot string on the slave. Please check your boot string on the slave. UDLD has been disabled globally - port-level UDLD sanity checks are being bypassed. OR [ The following ports have UDLD disabled. Please enable UDLD for optimum config: Fa9/45 The following ports have an unknown UDLD link state. Please enable UDLD on both sides of the link: Fa9/45 ] The following ports have portfast enabled: Fa9/35, Fa9/45 The following ports have trunk mode set to on: Fa4/1, Fa4/13 The following trunks have mode set to auto: Fa4/2, Fa4/3 show diagnostic sanity CF-655 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following ports with mode set to desirable are not trunking: Fa4/3, Fa4/4 The following trunk ports have negotiated to half-duplex: Fa4/3, Fa4/4 The following ports are configured for channel mode on: Fa4/1, Fa4/2, Fa4/3, Fa4/4 The following ports, not channeling are configured for channel mode desirable: Fa4/14 The following vlan(s) have a spanning tree root of 32768: 1 The following vlan(s) have max age on the spanning tree root different from the default: 1-2 The following vlan(s) have forward delay on the spanning tree root different from the default: 1-2 The following vlan(s) have hello time on the spanning tree root different from the default: 1-2 The following vlan(s) have max age on the bridge different from the default: 1-2 The following vlan(s) have fwd delay on the bridge different from the default: 1-2 The following vlan(s) have hello time on the bridge different from the default: 1-2 The following vlan(s) have a different port priority than the default on the port FastEthernet4/1 1-2 The following ports have recieve flow control disabled: Fa9/35, Fa9/45 The following inline power ports have power-deny/faulty status: Gi7/1, Gi7/2 The following ports have negotiated to half-duplex: Fa9/45 The following vlans have a duplex mismatch: Fas 9/45 The following interafaces have a native vlan mismatch: interface (native vlan - neighbor vlan) Fas 9/45 (1 - 64) The value for Community-Access on read-only operations for SNMP is the same as default. Please verify that this is the best value from a security point of view. show diagnostic sanity CF-656 Cisco IOS Configuration Fundamentals Command Reference April 2010 The value for Community-Access on write-only operations for SNMP is the same as default. Please verify that this is the best value from a security point of view. The value for Community-Access on read-write operations for SNMP is the same as default. Please verify that this is the best value from a security point of view. Please check the status of the following modules: 8,9 Module 2 had a MINOR_ERROR. The Module 2 failed the following tests: TestIngressSpan The following ports from Module2 failed test1: 1,2,4,48 show disk CF-657 Cisco IOS Configuration Fundamentals Command Reference April 2010 show disk To display flash or file system information for a disk, use the show disk command in user or privileged EXEC mode. show {disk0 | disk1} [all | filesys] Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The show disk command is supported only on platforms that have a disk file system. Note The name of the ATA monlib file may contain a platform name that does not match the platform that you are using. Different platforms may have a similar or the same name for their ATA monlib file. Examples The following example displays information about disk 0. The output is self-explanatory. Router# show disk0 all -#- --length-- -----date/time------ path 1 19539160 Jan 27 2004 23:08:40 c7200-is-mz.123-5.7.PI3a 1011679232 bytes available (19546112 bytes used) ATA Flash Card Geometry/Format Info ATA CARD GEOMETRY Number of Heads: 16 Number of Cylinders 1999 Sectors per Track 63 disk0 Selects disk 0 as the disk to display information about. disk1 Selects disk 1 as the disk to display information about. all (Optional) Specifies that all flash information will be displayed for the selected disk. filesys (Optional) Specifies that file system information will be displayed for the selected disk. Release Modification 12.2 This command was introduced in a release prior to Cisco IOS Release 12.2. 12.3(7)T This command was enhanced to display information about the ATA ROM monitor library (monlib) file. 12.2(25)S This command was integrated into the Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show disk CF-658 Cisco IOS Configuration Fundamentals Command Reference April 2010 Sector Size 512 Total Sectors 2014992 ATA CARD FORMAT Number of FAT Sectors 246 Sectors Per Cluster 32 Number of Clusters 62941 Number of Data Sectors 2014789 Base Root Sector 632 Base FAT Sector 140 Base Data Sector 664 ATA MONLIB INFO Image Monlib size = 67256 Disk monlib size = 71680 Name = c7200-atafslib-m Monlib Start sector = 2 Monlib End sector = 133 Monlib updated by = C7200-IS-M12.3(5.7)PI3a Monlib version = 1 show disk0: CF-659 Cisco IOS Configuration Fundamentals Command Reference April 2010 show disk0: To display flash or file system information for a disk located in slot 0, use the show disk command in user EXEC or privileged EXEC mode. show disk0: [all | filesys] Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The show disk0: command is supported only on platforms that have a disk file system located in slot 0. Use the show disk0: command to display details about the files in a particular ATA PCMCIA flash disk memory card. For more information regarding file systems and flash cards, access the PCMCIA Filesystem Compatibility Matrix and Filesystem Information document at the following URL: http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751 5.shtml Note The name of the ATA monlib file may contain a platform name that does not match the platform that you are using. Different platforms may have a similar name or the same name for their ATA monlib file. Examples The following examples show displays of information about the flash disks or file system information for a disk. The output is self-explanatory. c7200# show disk0: -#- --length-- -----date/time------ path all (Optional) The all keyword displays complete information about flash memory, including information about the individual devices in flash memory and the names and sizes of all system image files stored in flash memory, including those that are invalid. filesys (Optional) Displays the device information block, the status information, and the usage information. Release Modification 11.3AA This command was introduced. 12.2 This command was incorporated into Cisco IOS Release 12.2. 12.3(7)T This command was enhanced to display information about the ATA ROM monitor library (monlib) file. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show disk0: CF-660 Cisco IOS Configuration Fundamentals Command Reference April 2010 1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T 2 32768 Feb 24 2006 13:30:30 +00:00 file1.log 34738176 bytes available (29540352 bytes used) c7200# show disk0: all -#- --length-- -----date/time------ path 1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T 2 32768 Feb 24 2006 13:30:30 +00:00 file1.log 34738176 bytes available (29540352 bytes used) ATA Flash Card Geometry/Format Info ATA CARD GEOMETRY Number of Heads: 4 Number of Cylinders 984 Sectors per Cylinder 32 Sector Size 512 Total Sectors 125952 ATA CARD FORMAT Number of FAT Sectors 62 Sectors Per Cluster 8 Number of Clusters 15693 Number of Data Sectors 125812 Base Root Sector 232 Base FAT Sector 108 Base Data Sector 264 ATA MONLIB INFO Image Monlib size = 73048 Disk monlib size = 55296 Name = NA Monlib end sector = NA Monlib Start sector = NA Monlib updated by = NA Monlib version = NA c7200# show disk0: filesys ATA Flash Card Geometry/Format Info ATA CARD GEOMETRY Number of Heads: 4 Number of Cylinders 984 Sectors per Cylinder 32 Sector Size 512 Total Sectors 125952 ATA CARD FORMAT Number of FAT Sectors 62 Sectors Per Cluster 8 Number of Clusters 15693 Number of Data Sectors 125812 Base Root Sector 232 Base FAT Sector 108 Base Data Sector 264 ATA MONLIB INFO Image Monlib size = 73048 Disk monlib size = 55296 Name = NA show disk0: CF-661 Cisco IOS Configuration Fundamentals Command Reference April 2010 Monlib end sector = NA Monlib Start sector = NA Monlib updated by = NA Monlib version = NA Related Commands Command Description dir disk0: Displays a directory listing of files on an ATA PCMCIA flash disk card located in slot 0. dir disk1: Displays a directory listing of files on an ATA PCMCIA flash disk card located in slot 1. show disk1: Displays flash or file system information for a disk located in slot 1. show disk1: CF-662 Cisco IOS Configuration Fundamentals Command Reference April 2010 show disk1: To display flash or file system information for a disk located in slot 1, use the show disk1: command in user EXEC or privileged EXEC mode. show disk1: [all | filesys] Syntax Description Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The show disk1: command is supported only on platforms that have a disk file system. Use the show disk01: command to display details about the files in a particular ATA PCMCIA flash disk memory card located in slot 1. For more information regarding file systems and flash cards, access the PCMCIA Filesystem Compatibility Matrix and Filesystem Information document at the following URL: http://www.cisco.com/en/US/partner/products/hw/routers/ps341/products_tech_note09186a00800a751 5.shtml Note The name of the ATA monlib file may contain a platform name that does not match the platform that you are using. Different platforms may have a similar name or the same name for their ATA monlib file. Examples The following examples show displays of information about the flash disks or file system information for a disk. The output is self-explanatory. c7200# show disk1: -#- --length-- -----date/time------ path all (Optional) The all keyword displays complete information about flash memory, including information about the individual devices in flash memory and the names and sizes of all system image files stored in flash memory, including those that are invalid. filesys (Optional) Displays the device information block, the status information, and the usage information. Release Modification 11.3AA This command was introduced. 12.2 This command was incorporated into Cisco IOS Release 12.2. 12.3(7)T This command was enhanced to display information about the ATA ROM monitor library (monlib) file. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show disk1: CF-663 Cisco IOS Configuration Fundamentals Command Reference April 2010 1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T 2 32768 Feb 24 2006 13:30:30 +00:00 file1.log 34738176 bytes available (29540352 bytes used) c7200# show disk1: all -#- --length-- -----date/time------ path 1 29505176 Feb 27 2006 17:56:52 +00:00 c7200-jk9o3s-mz.124-6.T 2 32768 Feb 24 2006 13:30:30 +00:00 file1.log 34738176 bytes available (29540352 bytes used) ATA Flash Card Geometry/Format Info ATA CARD GEOMETRY Number of Heads: 4 Number of Cylinders 984 Sectors per Cylinder 32 Sector Size 512 Total Sectors 125952 ATA CARD FORMAT Number of FAT Sectors 62 Sectors Per Cluster 8 Number of Clusters 15693 Number of Data Sectors 125812 Base Root Sector 232 Base FAT Sector 108 Base Data Sector 264 ATA MONLIB INFO Image Monlib size = 73048 Disk monlib size = 55296 Name = NA Monlib end sector = NA Monlib Start sector = NA Monlib updated by = NA Monlib version = NA c7200# show disk1: filesys ATA Flash Card Geometry/Format Info ATA CARD GEOMETRY Number of Heads: 4 Number of Cylinders 984 Sectors per Cylinder 32 Sector Size 512 Total Sectors 125952 ATA CARD FORMAT Number of FAT Sectors 62 Sectors Per Cluster 8 Number of Clusters 15693 Number of Data Sectors 125812 Base Root Sector 232 Base FAT Sector 108 Base Data Sector 264 ATA MONLIB INFO Image Monlib size = 73048 Disk monlib size = 55296 Name = NA show disk1: CF-664 Cisco IOS Configuration Fundamentals Command Reference April 2010 Monlib end sector = NA Monlib Start sector = NA Monlib updated by = NA Monlib version = NA Related Commands Command Description dir disk0: Displays a directory listing of files on an ATA PCMCIA flash disk card located in slot 0. dir disk1: Displays a directory listing of files on an ATA PCMCIA flash disk card located in slot 1. show disk0: Displays flash or file system information for a disk located in slot 0. show environment CF-665 Cisco IOS Configuration Fundamentals Command Reference April 2010 show environment To display temperature, voltage, fan, and power supply information, use the show environment command in user EXEC or privileged EXEC mode. show environment [alarms | all | fans | hardware | last | leds | power-supply | table | temperature | voltages] Cisco 7000 Series, Cisco 7200 Series, Cisco 7304, and Cisco 7500 Series show environment [all | last | table] Cisco ASR 1000 Series show environment {all | counters | history sensor | location sensor | sensor sensor | table sensor} Syntax Description Command Default If no options are specified, the default is all. alarms (Optional) Displays the alarm contact information. all (Optional) Displays a detailed listing of all environmental monitor parameters (for example, the power supplies, temperature readings, voltage readings, and blower speeds). This is the default. fans (Optional) Displays blower and fan information. hardware (Optional) Displays hardware-specific information. last (Optional) Displays information on the last measurement made. leds (Optional) Displays the status of the MBus LEDs on the clock and scheduler cards and switch fabric cards. power-supply (Optional) Displays power supply voltage and current information. If applicable, displays the status of the redundant power supply. table (Optional) Displays the temperature, voltage, and blower ranges and thresholds. On the Cisco 7200 series, including the NPE-G2 in the Cisco 7200 VXR, the Cisco 7304 routers, and the Cisco 7500 series routers, the table keyword displays only the temperature and voltage thresholds. temperature (Optional) Displays temperature information. voltages (Optional) Displays voltage information. counters Displays operational counters. history Displays sensor state change history. location Displays sensors by location. sensor Displays sensor summary. sensor Sensor name. show environment CF-666 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines The availability of keywords depends on your system and platform. The command does not support SPAs on the Cisco 7200 series and on the NPE-G2 in the Cisco 7200 VXR routers. A routine runs once a minute that reads environmental measurements from sensors and stores the output into a buffer. For shared port adapters (SPAs), the temperature and voltage sensors are read every few seconds to get environmental data. The environmental buffer is displayed on the console when you use the show environment command. If a measurement exceeds desired margins, but has not exceeded fatal margins, a warning message is printed to the system console. The system software queries the sensors for measurements once a minute, but warnings for a given test point are printed at most once every hour for sensor readings in the warning range and once every 5 minutes for sensor readings in the critical range. If a measurement is out of line within these time segments, an automatic warning message appears on the console. As noted, you can query the environmental status with the show environment command at any time to determine whether a measurement is at the warning or critical tolerance. A SPA is shut down when any of the SPA environment readings exceed the shutdown threshold. If a shutdown occurs because of detection of fatal environmental margins, the last measured value from each sensor is stored in internal nonvolatile memory. For environmental specifications, refer to the hardware installation and configuration publication for your individual chassis. For network processor engines (NPEs), network services engines (NSEs), line cards, and modular services cards (MSCs), environmental information is recorded in the CISCO-ENVMON-MIB. SPAs are not supported by the CISCO-ENVMON-MIB. In Cisco IOS Release 12.2(20)S2 and later, the CISCO-ENTITY-SENSOR-MIB supports environmental information for SPAs, as well as NPEs, NSEs, line cards, and MSCs. Release Modification 10.0 This command was introduced. 11.2 GS The alarms, fans, hardware, leds, power-supply, table, temperature, and voltages keywords were added for the Cisco 12000 series GSRs. 11.3(6)AA This command was expanded to monitor the RPS and board temperature for the Cisco AS5300 platform, Cisco 3600 series routers, Cisco 7200 series routers, and the Cisco 12000 series GSRs. 12.2(20)S This command was integrated into Cisco IOS Release 12.2(20)S. 12.2(20)S2 This command was integrated into Cisco IOS Release 12.2(20)S2 to support MSCs and SPAs on the Cisco 7304 router using the all, last, and table keywords. 12.4(4)XD This command was integrated into Cisco IOS Release 12.4(4)XD to support the NPE-G2 on the Cisco 7200 VXR using the all, last, and table keywords. Command output was modified for the NPE-G2. 12.2(31)SB2 This command was integrated into Cisco IOS Release 12.2(31)SB2. Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE Release 2.1 on the Cisco ASR 1000 Series Routers. show environment CF-667 Cisco IOS Configuration Fundamentals Command Reference April 2010 If the Cisco 12000 series GSR exceeds environmental conditions, a message similar to the following is displayed on the console: %GSR_ENV-2-WARNING: Slot 3 Hot Sensor Temperature exceeds 40 deg C; Check cooling systems Note Blower temperatures that exceed environmental conditions do not generate a warning message. You can also enable Simple Network Management Protocol (SNMP) notifications (traps or informs) to alert a network management system (NMS) when environmental thresholds are reached using the snmp-server enable traps envmon and snmp-server host global configuration commands. Whenever Cisco IOS software detects a failure or recovery event from the DRPS unit, it sends an SNMP trap to the configured SNMP server. Unlike console messages, only one SNMP trap is sent when the failure event is first detected. Another trap is sent when the recovery is detected. Cisco AS5300 DRPS software reuses the MIB attributes and traps defined in CISCO-ENVMON-MIB and CISCO-ACCESS-ENVMON-MIB. CISCO-ENVMON-MIB is supported by all Cisco routers with RPS units, and CISCO-ACCESS-ENVMON-MIB is supported by the Cisco 3600 series routers. A power supply trap defined in CISCO-ENVMON-MIB is sent when a failure is detected and when a failure recovery occurs for the following events: input voltage fail, DC output voltage fail, thermal fail, and multiple failure events. A fan failure trap defined in CISCO-ENVMON-MIB is sent when a fan failure or recovery event is detected by Cisco IOS software. A temperature trap defined in CISCO-ACCESS-ENVMON-MIB is sent when a board over-temperature condition is detected by Cisco IOS software. CISCO-ACCESS-ENVMON-MIB also defines an over-voltage trap. A similar trap is defined in CISCO-ENVMON-MIB, but it requires the ciscoEnvMonVoltageStatusValue in varbinds. This value indicates the current value of the voltage in the RPS. With Cisco AS5300 RPS units, the current voltage value is not sent to the motherboard. CISCO-ENVMON-MIB is extended to add a new enumerated value, internalRedundant(5), for MIB attribute ciscoEnvMonSupplySource. This is used to identify a RPS unit. Examples Cisco ASR 1000 Series Routers In the following example, the show environment all command displays system temperature, voltage, fan, and power supply conditions. (It does not display environmental information for SPAs.) The State column in show environment all output should show “Normal” except for fans where it indicates fan speed. A fan speed of 65% is normal. Router# show environment all Sensor List: Environmental Monitoring Sensor Location State Reading V1: VMA F0 Normal 1801 mV V1: VMB F0 Normal 1206 mV V1: VMC F0 Normal 1206 mV V1: VMD F0 Normal 1103 mV V1: VME F0 Normal 1005 mV V1: 12v F0 Normal 11967 mV V1: VDD F0 Normal 3295 mV V1: GP1 F0 Normal 905 mV V2: VMA F0 Normal 3295 mV V2: VMB F0 Normal 2495 mV V2: VMC F0 Normal 1499 mV V2: VMD F0 Normal 1098 mV show environment CF-668 Cisco IOS Configuration Fundamentals Command Reference April 2010 V2: VME F0 Normal 1000 mV V2: VMF F0 Normal 1000 mV V2: 12v F0 Normal 11923 mV V2: VDD F0 Normal 3295 mV V2: GP1 F0 Normal 751 mV Temp: Inlet F0 Normal 27 Celsius Temp: Asic1 F0 Normal 44 Celsius Temp: Exhaust1 F0 Normal 36 Celsius Temp: Exhaust2 F0 Normal 34 Celsius Temp: Asic2 F0 Normal 40 Celsius V1: VMA 0 Normal 1103 mV V1: VMB 0 Normal 1201 mV V1: VMC 0 Normal 1503 mV V1: VMD 0 Normal 1801 mV V1: VME 0 Normal 2495 mV V1: VMF 0 Normal 3295 mV V1: 12v 0 Normal 11967 mV V1: VDD 0 Normal 3295 mV V1: GP1 0 Normal 751 mV V1: GP2 0 Normal 903 mV V2: VMB 0 Normal 1201 mV V2: 12v 0 Normal 11967 mV V2: VDD 0 Normal 3291 mV V2: GP2 0 Normal 903 mV Temp: Left 0 Normal 28 Celsius Temp: Center 0 Normal 29 Celsius Temp: Asic1 0 Normal 42 Celsius Temp: Right 0 Normal 27 Celsius V1: VMA 1 Normal 1103 mV V1: VMB 1 Normal 1201 mV V1: VMC 1 Normal 1503 mV V1: VMD 1 Normal 1801 mV V1: VME 1 Normal 2495 mV V1: VMF 1 Normal 3295 mV V1: 12v 1 Normal 11953 mV V1: VDD 1 Normal 3291 mV V1: GP1 1 Normal 754 mV V1: GP2 1 Normal 903 mV V2: VMB 1 Normal 1206 mV V2: 12v 1 Normal 11967 mV V2: VDD 1 Normal 3291 mV V2: GP2 1 Normal 905 mV Temp: Left 1 Normal 28 Celsius Temp: Center 1 Normal 30 Celsius Temp: Asic1 1 Normal 44 Celsius Temp: Right 1 Normal 28 Celsius PEM Iout P0 Normal 37 A PEM Vout P0 Normal 12 V AC PEM Vin P0 Normal 116 V AC Temp: PEM P0 Normal 28 Celsius Temp: FC P0 Fan Speed 65% 25 Celsius Temp: FM P1 Normal 1 Celsius Temp: FC P1 Fan Speed 65% 25 Celsius V1: VMA R0 Normal 1118 mV V1: VMB R0 Normal 3315 mV V1: VMC R0 Normal 2519 mV V1: VMD R0 Normal 1811 mV V1: VME R0 Normal 1513 mV V1: VMF R0 Normal 1220 mV V1: 12v R0 Normal 12011 mV V1: VDD R0 Normal 3300 mV V1: GP1 R0 Normal 913 mV V1: GP2 R0 Normal 1247 mV Temp: CPU R0 Normal 29 Celsius show environment CF-669 Cisco IOS Configuration Fundamentals Command Reference April 2010 Temp: Outlet R0 Normal 30 Celsius Temp: Inlet R0 Normal 25 Celsius Temp: Asic1 R0 Normal 30 Celsius Table 69 describes the significant fields shown in the display. Cisco 7000 Series Routers, Cisco 7200 Series Routers In the following example, the typical show environment display is shown when no warning conditions are in the system for the Cisco 7000 series and Cisco 7200 series routers. This information may vary slightly depending on the platform you are using. The date and time of the query are displayed, along with the data refresh information and a message indicating that there are no warning conditions. Router> show environment Environmental Statistics Environmental status as of 13:17:39 UTC Thu Jun 6 1996 Data is 7 second(s) old, refresh in 53 second(s) All Environmental Measurements are within specifications Table 70 describes the significant fields shown in the display. Table 69 show environment all Field Descriptions Field Description Sensor Sensor name. Location Chassis slot. State State description. One of the following values: • Critical—Critical alarm indicating a service-affecting condition. • Fan Speed—Fan speed (65% is normal). • Major—Major alarm indicating immediate action is needed. • Minor—Minor alarm indicating warning conditions. • Normal—Sensor reading is in acceptable range. • Shutdown—If automatic shutdown is enabled, indicates that the router will shut down. Reading Voltage or temperature detected by the sensor. Table 70 show environment Field Descriptions Field Description Environmental status as of... Current date and time. Data is..., refresh in... Environmental measurements are output into a buffer every 60 seconds, unless other higher-priority processes are running. Status message If environmental measurements are not within specification, warning messages are displayed. show environment CF-670 Cisco IOS Configuration Fundamentals Command Reference April 2010 NPE-G2 in Cisco 7200 VXR Routers In the following example, additional temperature and voltage readings for the NPE-G2 in the Cisco 7200 VXR router are displayed by the show environment all command. Power supplies 1 and 2 are on, and all monitored variables are within the normal operating range. Router_npe-g2# show environment all Power Supplies: Power Supply 1 is Zytek AC Power Supply. Unit is on. Power Supply 2 is Zytek AC Power Supply. Unit is on. Temperature readings: NPE Inlet measured at 25C/77F NPE Outlet measured at 28C/82F CPU Die measured at 56C/132F =======> additional temperature reading on NPE-G2 Voltage readings: +3.30 V measured at +3.32 V =======> additional voltage reading on NPE-G2 +1.50 V measured at +1.48 V =======> additional voltage reading on NPE-G2 +2.50 V measured at +2.46 V =======> additional voltage reading on NPE-G2 +1.80 V measured at +1.75 V =======> additional voltage reading on NPE-G2 +1.20 V measured at +1.17 V =======> additional voltage reading on NPE-G2 VDD_CPU measured at +1.28 V =======> additional voltage reading on NPE-G2 VDD_MEM measured at +2.50 V =======> additional voltage reading on NPE-G2 VTT measured at +1.25 V =======> additional voltage reading on NPE-G2 +3.45 V measured at +3.39 V -11.95 measured at -11.93 V +5.15 V measured at +4.96 V +12.15 V measured at +12.18 V Envm stats saved 0 time(s) since reload Table 71 show environment all Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description Power Supply x is present. Specifies whether the indicated (x) power supply slot is populated. If a power supply slot is populated, the manufacturer name and whether it is an AC or DC power supply is displayed. Unit is ... Indicates whether the power supply status is on or off. Temperature readings Indicates the temperature of air coming in and going out of the NPE Inlet, NPE Outlet, and CPU Die areas. NPE Inlet measured at 25C/77F Indicates that the temperature measurements at the inlet area of the chassis is 25C/77F, which is within normal operating range. System shutdown for NPE Inlet is 80C/176F. NPE Outlet measured at 28C/82F Indicates that the temperature measurements at the outlet area of the chassis is 28C/82F, which is within normal operating range. System shutdown for NPE Outlet is 84C/183F. CPU Die measured at 56C/132F Indicates that the temperature measurement at the CPU Die (internal silicon of the CPU) area of the chassis is 56C/132F, which is within normal operating range. System shutdown for CPU Die is 100C/212F. show environment CF-671 Cisco IOS Configuration Fundamentals Command Reference April 2010 In the following example, the show environment last command displays the previously saved measurements (readings) from the last environmental reading before the router was shut down. The command also displays the reason why the router was shut down, which was “power supply shutdown” in this case. Router_npe-g2# show environment last NPE Inlet previously measured at 26C/78F NPE Outlet previously measured at 28C/82F CPU Die previously measured at 56C/132F +3.30 V previously measured at +3.32 +1.50 V previously measured at +1.48 +2.50 V previously measured at +2.46 +1.80 V previously measured at +1.75 +1.20 V previously measured at +1.17 VDD_CPU previously measured at +1.28 VDD_MEM previously measured at +2.50 VTT previously measured at +1.25 +3.45 V previously measured at +3.39 -11.95 previously measured at -11.93 +5.15 V previously measured at +4.96 +12.15 V previously measured at +12.18 last shutdown reason - power supply shutdown Voltage readings: +3.30 V measured at +3.32 V +1.50 V measured at +1.48 V System voltage measurements that indicate the actual measured value for the specified power rail, which is named after the expected target value. For example, the +3.30 V rail, with an expected value of +3.30 V, actually measures at +3.32 V. This is within the target range. For example, the +1.50 V rail, with an expected value of +1.50 V, actually measures at +1.48 V. This is within the target range. VDD_CPU measured at +1.28 V Indicates +1.28 V is the measured voltage of the VDD_CPU power rail, which is within normal operating range. The expected value is 1.3 V. VDD_MEM measured at +2.50 V Indicates +2.50 V is the measured voltage of the VDD_MEM power rail, which is within normal operating range. The expected value is 2.5 V. VTT measured at +1.25 V Indicates +1.25 V is the measured voltage of the VTT power rail, which is within normal operating range. The expected value is 1.25 V. Table 71 show environment all Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description Table 72 show environment last Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description NPE Inlet previously measured at 26C/78F The last measured temperature of the inlet air of the router prior to shutdown. NPE Outlet previously measured at 28C/82F The last measured temperature of the outlet air of the router prior to shutdown. CPU Die previously measured at 56C/132F The last measured temperature of the CPU Die prior to shutdown. show environment CF-672 Cisco IOS Configuration Fundamentals Command Reference April 2010 In the following example, the show environment table command displays threshold levels in a table format of the environmental monitor parameters. It displays the high warning, high critical, and high shutdown temperature thresholds of the NPE inlet, NPE outlet, and CPU Die. It also displays the low and high critical voltage thresholds, and low and high shut down voltage thresholds for the power rails on the NPE-G2 in the Cisco 7200 VXR. Note The low range temperatures, such as the LowShut, LowCrit, and LowWarn temperature thresholds, are not checked and are not displayed on the NPE-G2. Also the warning voltage thresholds, such as LowWarn and HighWarn, are not checked and are not displayed on the NPE-G2. Router_npe-g2# show environment table Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut NPE Inlet 44C/111F 59C/138F NPE Outlet 49C/120F 64C/147F CPU Die 75C/167F 85C/185F System shutdown for NPE Inlet is 80C/176F System shutdown for NPE Outlet is 84C/183F System shutdown for CPU Die is 100C/212F +3.30 V +2.30 +3.12 +3.47 +4.29 +1.50 V +1.05 +1.40 +1.56 +1.95 +2.50 V +1.71 +2.34 +2.61 +3.28 +1.80 V +1.25 +1.67 +1.91 +2.34 +1.20 V +0.82 +1.13 +1.28 +1.56 VDD_CPU +0.89 +1.21 +1.36 +1.71 VDD_MEM +1.71 +2.34 +2.61 +3.28 VTT +0.85 +1.17 +1.32 +1.64 +3.45 V +2.38 +3.28 +3.63 +4.49 -11.95 V -8.44 -11.56 -12.84 -15.78 +5.15 V +3.59 +4.88 +5.42 +6.71 +12.15 V +8.55 +11.48 +12.77 +15.82 +3.30 V previously measured at +3.32 The last measured voltage of the 3.30 V power rail prior to shutdown. VDD_CPU previously measured at +1.28 The last measured voltage of the VDD_CPU power rail prior to shutdown. VDD_MEM previously measured at +2.50 The last measured voltage of the VDD_MEM power rail prior to shutdown. VTT previously measured at +1.25 The last measured voltage of the VTT power rail prior to shutdown. last shutdown reason Indicates the reason for the shutdown. Table 72 show environment last Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description show environment CF-673 Cisco IOS Configuration Fundamentals Command Reference April 2010 Table 73 show environment table Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description Sample Point This is the area for which temperature or system voltage thresholds are displayed. LowShut This is the LowShut voltage threshold. If the voltage value is below the LowShut threshold, the router shuts down. Note The LowShut temperature value is not checked and its threshold is not displayed on the NPE-G2. LowCrit This is the low critical voltage threshold. If the voltage value is below the LowCrit threshold, a critical message is issued for an out-of-tolerance voltage value. The system continues to operate. However, the system is approaching shutdown. Note The LowCrit temperature value is not checked and its threshold is not displayed on the NPE-G2. LowWarn The LowWarn temperature threshold and LowWarn voltage threshold are not checked and the threshold information is not displayed on the NPE-G2. HighWarn This is the HighWarn temperature threshold. If the temperature reaches the HighWarn threshold, a warning message is issued for an out-of-tolerance temperature value. The system continues to operate, but operator action is recommended to bring the system back to a normal state. Note The HighWarn voltage threshold is not checked and its threshold is not displayed on the NPE-G2. HighCrit This is the HighCrit temperature or voltage threshold. If the temperature or voltage reaches the HighCrit level, a critical message is issued. The system continues to operate. However, the system is approaching shutdown. Note Beware that if the temperature reaches or exceeds the HighShut value, a Shutdown message is issued and the router shuts down. HighShut This is the HighShut temperature or voltage threshold. If the temperature or voltage level reaches or exceeds the HighShut value, a Shutdown message is issued and the router shuts down. show environment CF-674 Cisco IOS Configuration Fundamentals Command Reference April 2010 NPE Inlet 44C/111F 59C/138F These are the HighWarn and HighCrit temperature thresholds, respectively, for the NPE Inlet. If the NPE Inlet temperature value reaches the HighWarn (44C/111F) and HighCrit (59C/138F) levels, warning and critical messages, respectively, are issued. If the value reaches 44C/111F or greater, you receive a warning message indicating HighWarn. The system continues to operate, but operator action is recommended to bring the system back to a normal state. If the value reaches 59C/138F or greater, you receive a critical (HighCrit) message instead, that indicates the system continues to operate, but the system is approaching shutdown. Note Beware if the temperature reaches or exceeds 80C/176F, which is the HighShut value, a Shutdown message is issued, and the NPE Inlet area shuts down. NPE Outlet 49C/120F 64C/147F These are the HighWarn and HighCrit temperature thresholds, respectively, for the NPE Outlet. If the NPE Outlet temperature value reaches the HighWarn (49C/120F) and HighCrit (64C/147F) levels, warning and critical messages, respectively, are issued. If the value reaches 49C/120F or greater, you receive a warning message indicating HighWarn. The system continues to operate, but operator action is recommended to bring the system back to a normal state. If the value reaches 64C/147F or greater, you receive a critical (HighCrit) message instead that indicates the system continues to operate, but the system is approaching shutdown. Note Beware if the temperature reaches or exceeds 84C/183F, which is the HighShut value, a Shutdown message is issued, and the NPE Outlet area shuts down. Table 73 show environment table Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description show environment CF-675 Cisco IOS Configuration Fundamentals Command Reference April 2010 CPU Die 75C/167F 85C/185F These are the HighWarn and HighCrit temperature thresholds, respectively, for the CPU Die. If the CPU Die temperature value reaches the HighWarn (75C/167F) and HighCrit (85C/185F) levels, warning and critical messages, respectively, are issued. If the value reaches 75C/167F or greater, you receive a warning message indicating HighWarn. The system continues to operate, but operator action is recommended to bring the system back to a normal state. If the value reaches 85C/185F or greater, you receive a critical (HighCrit) message instead, that indicates the system continues to operate, but the system is approaching shutdown. Note Beware if the temperature reaches or exceeds 100C/212F, which is the HighShut value, a Shutdown message is issued and the CPU Die area shuts down. System shutdown for NPE Inlet is 80C/176F This is the HighShut temperature threshold for the NPE Inlet. If the temperature reaches or exceeds 80C/176F, a Shutdown message is issued and the NPE Inlet area is shut down. System shutdown for NPE Outlet is 84C/183F This is the HighShut temperature threshold for the NPE Outlet. If the temperature reaches or exceeds 84C/183F, a Shutdown message is issued and the NPE Outlet area is shut down. System shutdown for CPU Die is 100C/212F This is the HighShut temperature threshold for the CPU Die. If the temperature reaches or exceeds 100C/212F, a Shutdown message is issued and the CPU Die area is shut down. +3.30 V +2.30 +3.12 +3.47 +4.29 The voltage thresholds for the +3.30 V power rail are as follows: • +2.30 is the LowShut voltage threshold. • +3.12 is the LowCrit voltage threshold. • +3.47 is the HighCrit voltage threshold. • +4.29 is the HighShut voltage threshold. Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2. Table 73 show environment table Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description show environment CF-676 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco 7000 Series Routers The following are examples of messages that display on the system console when a measurement has exceeded an acceptable margin: ENVIRONMENTAL WARNING: Air flow appears marginal. ENVIRONMENTAL WARNING: Internal temperature measured 41.3(C) ENVIRONMENTAL WARNING: +5 volt testpoint measured 5.310(V) The system displays the following message if voltage or temperature exceed maximum margins: SHUTDOWN: air flow problem VDD_CPU +0.89 +1.21 +1.36 +1.71 The voltage thresholds for the VDD_CPU power rail are as follows: • +0.89 is the LowShut voltage threshold. • +1.21 is the LowCrit voltage threshold. • +1.36 is the HighCrit voltage threshold. • +1.71 is the HighShut voltage threshold. Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2. VDD_MEM +1.71 +2.34 +2.61 +3.28 The voltage thresholds for the VDD_MEM power rail are as follows: • +1.71 is the LowShut voltage threshold. • +2.34 is the LowCrit voltage threshold. • +2.61 is the HighCrit voltage threshold. • +3.28 is the HighShut voltage threshold. Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2. VTT +0.85 +1.17 +1.32 +1.64 The voltage thresholds for the VTT power rail are as follows: • +0.85 is the LowShut voltage threshold. • +1.17 is the LowCrit voltage threshold. • +1.32 is the HighCrit voltage threshold. • +1.64 is the HighShut voltage threshold. Note The LowWarn and HighWarn voltage levels are not checked and their thresholds are not displayed on the NPE-G2. Table 73 show environment table Field Descriptions for NPE-G2 in Cisco 7200 VXR Router Field Description show environment CF-677 Cisco IOS Configuration Fundamentals Command Reference April 2010 In the following example, there have been two intermittent power failures since a router was turned on, and the lower power supply is not functioning. The last intermittent power failure occurred on Monday, June 10, 1996, at 11:07 p.m. 7000# show environment all Environmental Statistics Environmental status as of 23:19:47 UTC Wed Jun 12 1996 Data is 6 second(s) old, refresh in 54 second(s) WARNING: Lower Power Supply is NON-OPERATIONAL Lower Power Supply:700W, OFF Upper Power Supply: 700W, ON Intermittent Powerfail(s): 2 Last on 23:07:05 UTC Mon Jun 10 1996 +12 volts measured at 12.05(V) +5 volts measured at 4.96(V) -12 volts measured at -12.05(V) +24 volts measured at 23.80(V) Airflow temperature measured at 38(C) Inlet temperature measured at 25(C) Table 74 describes the significant fields shown in the display. The following example is for the Cisco 7000 series routers. The router retrieves the environmental statistics at the time of the last shutdown. In this example, the last shutdown was Friday, May 19, 1995, at 12:40 p.m., so the environmental statistics at that time are displayed. Router# show environment last Environmental Statistics Environmental status as of 14:47:00 UTC Sun May 21 1995 Data is 6 second(s) old, refresh in 54 second(s) WARNING: Upper Power Supply is NON-OPERATIONAL LAST Environmental Statistics Environmental status as of 12:40:00 UTC Fri May 19 1995 Table 74 show environment all Field Descriptions for the Cisco 7000 Series Routers Field Description Environmental status as of... Date and time of last query. Data is..., refresh in... Environmental measurements are output into a buffer every 60 seconds, unless other higher-priority processes are running. WARNING: If environmental measurements are not within specification, warning messages are displayed. Lower Power Supply Type of power supply installed and its status (on or off). Upper Power Supply Type of power supply installed and its status (on or off). Intermittent Powerfail(s) Number of power hits (not resulting in shutdown) since the system was last booted. Voltage specifications System voltage measurements. Airflow and inlet temperature Temperature of air coming in and going out. show environment CF-678 Cisco IOS Configuration Fundamentals Command Reference April 2010 Lower Power Supply: 700W, ON Upper Power Supply: 700W, OFF No Intermittent Powerfails +12 volts measured at 12.05(V) +5 volts measured at 4.98(V) -12 volts measured at -12.00(V) +24 volts measured at 23.80(V) Airflow temperature measured at 30(C) Inlet temperature measured at 23(C) Table 75 describes the significant fields shown in the display. The following example shows sample output for the current environmental status in tables that list voltage and temperature parameters. There are three warning messages: one each about the lower power supply, the airflow temperature, and the inlet temperature. In this example, voltage parameters are shown to be in the normal range, airflow temperature is at a critical level, and inlet temperature is at the warning level. Router> show environment table Environmental Statistics Environmental status as of Mon 11-2-1992 17:43:36 Data is 52 second(s) old, refresh in 8 second(s) WARNING: Lower Power Supply is NON-OPERATIONAL WARNING: Airflow temperature has reached CRITICAL level at 73(C) WARNING: Inlet temperature has reached WARNING level at 41(C) Voltage Parameters: SENSE CRITICAL NORMAL CRITICAL -------|--------------------|------------------------|-------------------- +12(V) 10.20 12.05(V) 13.80 +5(V) 4.74 4.98(V) 5.26 -12(V) -10.20 -12.05(V) -13.80 +24(V) 20.00 24.00(V) 28.00 Table 75 show environment last Field Descriptions for the Cisco 7000 Series Routers Field Description Environmental status as of... Date and time of last query. Data is..., refresh in... Environmental measurements are output into a buffer every 60 seconds, unless other higher-priority processes are running. WARNING: If environmental measurements are not within specification, warning messages are displayed. LAST Environmental Statistics Displays test point values at time of the last environmental shutdown. Lower Power Supply Upper Power Supply For the Cisco 7000 router, indicates the status of the two 700W power supplies. For the Cisco 7010 router, indicates the status of the single 600W power supply. show environment CF-679 Cisco IOS Configuration Fundamentals Command Reference April 2010 Temperature Parameters: SENSE WARNING NORMAL WARNING CRITICAL SHUTDOWN -------|-------------|------------|-------------|--------------|----------- Airflow 10 60 70 73(C) 88 Inlet 10 39 41(C) 46 64 Table 76 describes the significant fields shown in the display. Cisco 7200 Series Routers The system displays the following message if the voltage or temperature enters the “Warning” range: %ENVM-4-ENVWARN: Chassis outlet 3 measured at 55C/131F The system displays the following message if the voltage or temperature enters the “Critical” range: %ENVM-2-ENVCRIT: +3.45 V measured at +3.65 V The system displays the following message if the voltage or temperature exceeds the maximum margins: %ENVM-0-SHUTDOWN: Environmental Monitor initiated shutdown The following message is sent to the console if a power supply has been inserted or removed from the system. This message relates only to systems that have two power supplies. %ENVM-6-PSCHANGE: Power Supply 1 changed from Zytek AC Power Supply to removed The following message is sent to the console if a power supply has been powered on or off. In the case of the power supply being shut off, this message can be due to the user shutting off the power supply or to a failed power supply. This message relates only to systems that have two power supplies. %ENVM-6-PSLEV: Power Supply 1 state changed from normal to shutdown The following is sample output from the show environment all command on the Cisco 7200 series routers when there is a voltage warning condition in the system: 7200# show environment all Power Supplies: Power supply 1 is unknown. Unit is off. Power supply 2 is Zytek AC Power Supply. Unit is on. Temperature readings: chassis inlet measured at 25C/77F chassis outlet 1 measured at 29C/84F Table 76 show environment table Field Descriptions for the Cisco 7000 Series Routers Field Description SENSE (Voltage Parameters) Voltage specification for a DC line. SENSE (Temperature Parameters) Air being measured. Inlet measures the air coming in, and Airflow measures the temperature of the air inside the chassis. WARNING System is approaching an out-of-tolerance condition. NORMAL All monitored conditions meet normal requirements. CRITICAL Out-of-tolerance condition exists. SHUTDOWN Processor has detected condition that could cause physical damage to the system. show environment CF-680 Cisco IOS Configuration Fundamentals Command Reference April 2010 chassis outlet 2 measured at 36C/96F chassis outlet 3 measured at 44C/111F Voltage readings: +3.45 V measured at +3.83 V:Voltage in Warning range! +5.15 V measured at +5.09 V +12.15 measured at +12.42 V -11.95 measured at -12.10 V Table 77 describes the significant fields shown in the display. The following example is for the Cisco 7200 series routers. This example shows the measurements immediately before the last shutdown and the reason for the last shutdown (if appropriate). 7200# show environment last chassis inlet previously measured at 27C/80F chassis outlet 1 previously measured at 31C/87F chassis outlet 2 previously measured at 37C/98F chassis outlet 3 previously measured at 45C/113F +3.3 V previously measured at 4.02 +5.0 V previously measured at 4.92 +12.0 V previously measured at 12.65 -12.0 V previously measured at 11.71 last shutdown reason - power supply shutdown Table 78 describes the significant fields shown in the display. The following example is for the Cisco 7200 series routers. This information lists the temperature and voltage shutdown thresholds for each sensor. 7200# show environment table Sample Point LowCritical LowWarning HighWarning HighCritical chassis inlet 40C/104F 50C/122F chassis outlet 1 43C/109F 53C/127F chassis outlet 2 75C/167F 75C/167F Table 77 show environment all Field Descriptions for the Cisco 7200 Series Router Field Description Power Supplies Current condition of the power supplies including the type and whether the power supply is on or off. Temperature readings Current measurements of the chassis temperature at the inlet and outlet locations. Voltage readings Current measurement of the power supply test points. Table 78 show environment last Field Descriptions for the Cisco 7200 Series Router Field Description chassis inlet Temperature measurements at the inlet area of the chassis. chassis outlet Temperature measurements at the outlet areas of the chassis. voltages Power supply test point measurements. last shutdown reason Possible shutdown reasons are power supply shutdown, critical temperature, and critical voltage. show environment CF-681 Cisco IOS Configuration Fundamentals Command Reference April 2010 chassis outlet 3 55C/131F 65C/149F +3.45 V +2.76 +3.10 +3.80 +4.14 +5.15 V +4.10 +4.61 +5.67 +6.17 +12.15 V +9.72 +10.91 +13.37 +14.60 -11.95 V -8.37 -9.57 -14.34 -15.53 Shutdown system at 70C/158F Table 79 describes the significant fields shown in the display. Cisco 7500 Series Routers The sample output for the Cisco 7500 series routers may vary depending on the specific model (for example, the Cisco 7513 router). The following is sample output from the show environment all command on the Cisco 7500 series routers: 7500# show environment all Arbiter type 1, backplane type 7513 (id 2) Power supply #1 is 1200W AC (id 1), power supply #2 is removed (id 7) Active fault conditions: none Fan transfer point: 100% Active trip points: Restart_Inhibit 15 of 15 soft shutdowns remaining before hard shutdown 1 0123456789012 Dbus slots: X XX X card inlet hotpoint exhaust RSP(6) 35C/95F 47C/116F 40C/104F RSP(7) 35C/95F 43C/109F 39C/102F Shutdown temperature source is ‘hotpoint’ on RSP(6), requested RSP(6) +12V measured at 12.31 +5V measured at 5.21 -12V measured at -12.07 +24V measured at 22.08 Table 79 show environment table Field Descriptions for the Cisco 7200 Series Router Field Description Sample Point Area for which measurements are taken. LowCritical Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown. LowWarning Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighWarning Level at which a warning message is issued. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighCritical Level at which a critical message is issued. For the chassis, the router is shut down. For the power supply, the power supply is shut down. Shutdown system at The system is shut down if the specified temperature is met. show environment CF-682 Cisco IOS Configuration Fundamentals Command Reference April 2010 +2.5 reference is 2.49 PS1 +5V Current measured at 59.61 A (capacity 200 A) PS1 +12V Current measured at 5.08 A (capacity 35 A) PS1 -12V Current measured at 0.42 A (capacity 3 A) PS1 output is 378 W Table 80 describes the significant fields shown in the display. The following example is for the Cisco 7500 series routers. This example shows the measurements immediately before the last shutdown. 7500# show environment last RSP(4) Inlet previously measured at 37C/98F RSP(4) Hotpoint previously measured at 46C/114F Table 80 show environment all Field Descriptions for the Cisco 7500 Series Routers Field Description Arbiter type 1 Numbers indicating the arbiter type and backplane type. Power supply Number and type of power supply installed in the chassis. Active fault conditions: Lists any fault conditions that exist (such as power supply failure, fan failure, and temperature too high). Fan transfer point: Software-controlled fan speed. If the router is operating below its automatic restart temperature, the transfer point is reduced by 10 percent of the full range each minute. If the router is at or above its automatic restart temperature, the transfer point is increased in the same way. Active trip points: Compares temperature sensor against the values displayed at the bottom of the show environment table command output. 15 of 15 soft shutdowns remaining When the temperature increases above the “board shutdown” level, a soft shutdown occurs (that is, the cards are shut down, and the power supplies, fans, and CI continue to operate). When the system cools to the restart level, the system restarts. The system counts the number of times this occurs and keeps the up/down cycle from continuing forever. When the counter reaches zero, the system performs a hard shutdown, which requires a power cycle to recover. The soft shutdown counter is reset to its maximum value after the system has been up for 6 hours. Dbus slots: Indicates which chassis slots are occupied. card, inlet, hotpoint, exhaust Temperature measurements at the inlet, hotpoint, and exhaust areas of the card. The (6) and (7) indicate the slot numbers. Dual Route Switch Processor (RSP) chassis can show two RSPs. Shutdown temperature source Indicates which of the three temperature sources is selected for comparison against the “shutdown” levels listed with the show environment table command. Voltages (+12V, +5V, -12V, +24V, +2.5) Voltages measured on the backplane. PS1 Current measured on the power supply. show environment CF-683 Cisco IOS Configuration Fundamentals Command Reference April 2010 RSP(4) Exhaust previously measured at 52C/125F +12 Voltage previously measured at 12.26 +5 Voltage previously measured at 5.17 -12 Voltage previously measured at -12.03 +24 Voltage previously measured at 23.78 Table 81 describes the significant fields shown in the display. The following example is for the Cisco 7500 series router. This information lists the temperature and voltage thresholds for each sensor. These thresholds indicate when error messages occur. There are two level of messages: warning and critical. 7500# show environment table Sample Point LowCritical LowWarning HighWarning HighCritical RSP(4) Inlet 44C/111F 50C/122F RSP(4) Hotpoint 54C/129F 60C/140F RSP(4) Exhaust +12 Voltage 10.90 11.61 12.82 13.38 +5 Voltage 4.61 4.94 5.46 5.70 -12 Voltage -10.15 -10.76 -13.25 -13.86 +24 Voltage 20.38 21.51 26.42 27.65 2.5 Reference 2.43 2.51 Shutdown boards at 70C/158F Shutdown power supplies at 76C/168F Restart after shutdown below 40C/104F Table 82 describes the significant fields shown in the display. Table 81 show environment last Field Descriptions for the Cisco 7500 Series Routers Field Description RSP(4) Inlet, Hotpoint, Exhaust Temperature measurements at the inlet, hotpoint, and exhaust areas of the card. Voltages Voltages measured on the backplane. Table 82 show environment table Field Descriptions for the Cisco 7500 Series Routers Field Description Sample Point Area for which measurements are taken. LowCritical Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown. LowWarning Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighWarning Level at which a warning message is issued. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighCritical Level at which a critical message is issued. For the chassis, the router is shut down. For the power supply, the power supply is shut down. show environment CF-684 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco AS5300 Series Access Servers In the following example, keywords and options are limited according to the physical characteristics of the system is shown: as5300# show environment ? all All environmental monitor parameters last Last environmental monitor parameters table Temperature and voltage ranges | Output modifiers as5300# show environment table %This option not available on this platform Cisco 12000 Series GSRs The following examples are for the Cisco 12000 series GSRs. The following is sample output from the show environment command for a Cisco 12012 router. Slots 0 through 11 are the line cards, slots 16 and 17 are the clock and scheduler cards, slots 18 through 20 are the switch fabric cards, slots 24 through 26 are the power supplies, and slots 28 and 29 are the blowers. An “NA” in the table means that no values were returned. In some cases it is because the equipment is not supported for that environmental parameter (for example, the power supply and blowers in slots 24, 26, 28, and 29 do not have a 3V power supply, so an NA is displayed). Router# show environment Slot # 3V 5V MBUS 5V Hot Sensor Inlet Sensor (mv) (mv) (mv) (deg C) (deg C) 0 3300 4992 5040 42.0 37.0 2 3296 4976 5136 40.0 33.0 4 3280 4992 5120 38.5 31.5 7 3280 4984 5136 42.0 32.0 9 3292 4968 5160 39.5 31.5 11 3288 4992 5152 40.0 30.5 16 3308 NA 5056 42.5 38.0 17 3292 NA 5056 40.5 36.5 18 3304 NA 5176 36.5 35.0 19 3300 NA 5184 37.5 33.5 20 3304 NA 5168 36.5 34.0 24 NA 5536 5120 NA 31.5 26 NA 5544 5128 NA 31.5 28 NA NA 5128 NA NA 29 NA NA 5104 NA NA Slot # 48V AMP_48 (Volt) (Amp) 24 46 12 26 46 19 Shutdown boards at The card is shut down if the specified temperature is met. Shutdown power supplies at The system is shut down if the specified temperature is met. Restart after shutdown The system will restart when the specified temperature is met. Table 82 show environment table Field Descriptions for the Cisco 7500 (continued)Series Field Description show environment CF-685 Cisco IOS Configuration Fundamentals Command Reference April 2010 Slot # Fan 0 Fan 1 Fan 2 (RPM) (RPM) (RPM) 28 2160 2190 2160 29 2130 2190 2070 Table 83 describes the significant fields shown and lists the equipment supported by each environmental parameter. “NA” indicates that the reading could not be obtained, so the command should be run again. The following is sample output from the show environment all command for the Cisco 12008 router. Slots 0 through 7 are the line cards, slots 16 and 17 are the clock scheduler cards (the clock scheduler cards control the fans), slots 18 through 20 are the switch fabric cards, and slots 24 and 26 are the power supplies. The Cisco 12008 router does not support slots 25, 27, 28, and 29. An “NA” in the table means that no values were returned. In some cases it is because the equipment is not supported for that environmental parameter (for example, the power supplies in slots 24 and 26 do not have a hot sensor, so an NA is displayed). Router# show environment all Slot # Hot Sensor Inlet Sensor (deg C) (deg C) 2 31.0 22.0 5 33.5 26.5 16 25.5 21.5 18 22.0 21.0 19 22.5 21.0 24 NA 29.5 26 NA 24.5 Table 83 show environment Field Descriptions for the Cisco 12000 Series Routers Field Description Slot # Slot number of the equipment. On the Cisco 12012 router, slots 0 through 11 are the line cards, slots 16 and 17 are the clock and scheduler cards, slots 18 through 20 are the switch fabric cards, slots 24 through 27 are the power supplies, and slots 28 and 29 are the blowers. 3V (mv) Measures the 3V power supply on the card. The 3V power supply is on the line cards, GRP card, clock and scheduler cards, and switch fabric cards. 5V (mv) Measures the 5V power supply on the card. The 5V power supply is on the line cards, GRP card, and power supplies. MBUS 5V (mv) Measures the 5V MBus on the card. The 5V MBus is on all equipment. Hot Sensor (deg C) Measures the temperature at the hot sensor on the card. The hot sensor is on the line cards, GRP card, clock and scheduler cards, switch fabric cards, and blowers. Inlet Sensor (deg C) Measures the current inlet temperature on the card. The inlet sensor is on the line cards, GRP card, clock and scheduler cards, switch fabric cards, and power supplies. 48V (Volt) Measures the DC power supplies. AMP_48 (Amp) Measures the AC power supplies. Fan 0, Fan 1, Fan 2 (RPM) Measures the fan speed in rotations per minute. show environment CF-686 Cisco IOS Configuration Fundamentals Command Reference April 2010 Slot # 3V 5V MBUS 5V (mv) (mv) (mv) 2 3292 5008 5136 5 3292 5000 5128 16 3272 NA 5128 18 3300 NA 5128 19 3316 NA 5128 Slot # 5V MBUS 5V 48V AMP_48 (mv) (mv) (Volt) (Amp) 24 0 5096 3 0 26 5544 5144 47 3 Slot # Fan Information 16 Voltage 16V Speed slow: Main Fans Ok Power Supply fans Ok Alarm Indicators No alarms Slot # Card Specific Leds 16 Mbus OK SFCs Failed 18 Mbus OK 19 Mbus OK 24 Input Failed 26 Input Ok The following is sample output from the show environment table command for a Cisco 12012 router. The show environment table command lists the warning, critical, and shutdown limits on your system and includes the GRP card and line cards (slots 0 to 15), clock and scheduler cards (slots 16 and 17), switch fabric cards (slots 18 to 20), and blowers. Router# show environment table Hot Sensor Temperature Limits (deg C): Warning Critical Shutdown GRP/GLC (Slots 0-15) 40 46 57 CSC (Slots 16-17) 46 51 65 SFC (Slots 18-20) 41 46 60 Inlet Sensor Temperature Limits (deg C): Warning Critical Shutdown GRP/GLC (Slots 0-15) 35 40 52 CSC (Slots 16-17) 40 45 59 SFC (Slots 18-20) 37 42 54 3V Ranges (mv): Warning Critical Shutdown Below Above Below Above Below Above GRP/GLC (Slots 0-15) 3200 3400 3100 3500 3050 3550 CSC (Slots 16-17) 3200 3400 3100 3500 3050 3550 SFC (Slots 18-20) 3200 3400 3100 3500 3050 3550 5V Ranges (mv): Warning Critical Shutdown Below Above Below Above Below Above GRP/GLC (Slots 0-15) 4850 5150 4750 5250 4680 5320 MBUS_5V Ranges (mv): Warning Critical Shutdown Below Above Below Above Below Above GRP/GLC (Slots 0-15) 5000 5250 4900 5350 4750 5450 CSC (Slots 16-17) 4820 5150 4720 5250 4750 5450 SFC (Slots 17-20) 5000 5250 4900 5350 4750 5450 show environment CF-687 Cisco IOS Configuration Fundamentals Command Reference April 2010 Blower Operational Range (RPM): Top Blower: Warning Critical Below Below Fan 0 1000 750 Fan 1 1000 750 Fan 2 1000 750 Bottom Blower: Warning Critical Below Below Fan 0 1000 750 Fan 1 1000 750 Fan 2 1000 750 The following is sample output from the show environment leds command for a Cisco 12012 router. The show environment leds command lists the status of the MBus LEDs on the clock, scheduler, and the switch fabric cards. Router# show environment leds 16 leds Mbus OK 18 leds Mbus OK 19 leds Mbus OK 20 leds Mbus OK Cisco 7304 Router The following is sample output from the show environment all command on a Cisco 7304 router with modular services cards (MSCs) and shared port adapters (SPAs) installed: Router# show environment all Power Supplies: Power supply 1 is AC power supply. Unit is on. Power supply 2 is empty. Fans: Fan 1 is on. Fan 2 is on. Temperature readings: Active RP (NPEG100, slot 0): npeg100 outlet measured at 29C/84F npeg100 inlet measured at 34C/93F npeg100 hotspot measured at 35C/95F Line card (7304-MSC-100, slot 4): 7304-MSC-100 measured at 32C/89F Card in subslot 4/0: SPA-4FE-7304 inlet measured at 31C/87F SPA-4FE-7304 outlet measured at 32C/89F Voltage readings: Active RP (NPEG100, slot 0): npe outlet 2.5 V measured at 2.496 V npe outlet 3.3 V measured at 3.302 V npe outlet 5.0 V measured at 4.992 V npe outlet 12.0 V measured at 11.812 V npe outlet 3.3c V measured at 3.199 V npe inlet 1.5 V measured at 1.494 V npe outlet 1.8 V measured at 1.790 V npe outlet 1.2 V measured at 1.198 V npe outlet 1.2c V measured at 1.198 V show environment CF-688 Cisco IOS Configuration Fundamentals Command Reference April 2010 Line card (7304-MSC-100, slot 4): 7304-MSC-100 0.75 V measured at 0.733 V 7304-MSC-100 1.5 V measured at 1.494 V 7304-MSC-100 2.5 V measured at 2.483 V 7304-MSC-100 3.3 V measured at 3.250 V 7304-MSC-100 12 V measured at 11.937 V Card in subslot 4/0: SPA-4FE-7304 1.8V measured at 1.802 V SPA-4FE-7304 1.5V measured at 1.503 V SPA-4FE-7304 2.5V measured at 2.474 V SPA-4FE-7304 3.3V measured at 3.252 V SPA-4FE-7304 1.0V measured at 1.015 V Envm stats saved 13 time(s) since reload The following is sample output from the show environment last command on a Cisco 7304 router with MSCs and SPAs installed and an NSE-100: Router# show environment last Temperature information: NSE board: nse outlet is unmeasured nse inlet is unmeasured nse hotspot is unmeasured nse db is unmeasured Line card slot 4: 7304-MSC-100 is unmeasured Card in subslot 4/1: SPA-4FE-7304 inlet previously measured at 30C/86F SPA-4FE-7304 outlet previously measured at 32C/89F Voltage information: NSE board: nse outlet 1.8 V is unmeasured nse outlet 2.5 V is unmeasured nse outlet 3.3 V is unmeasured nse outlet 5 V is unmeasured nse outlet 12 V is unmeasured nse inlet 1.8 V is unmeasured nse inlet 3.3 V is unmeasured nse inlet 1.5 V is unmeasured nse hotspot 1.8 V is unmeasured nse db 1.65 V is unmeasured nse db 1.8 V is unmeasured Line card slot 4: 7304-MSC-100 0.75 V is unmeasured 7304-MSC-100 1.5 V is unmeasured 7304-MSC-100 2.5 V is unmeasured 7304-MSC-100 3.3 V is unmeasured 7304-MSC-100 12 V is unmeasured Card in subslot 4/1: SPA-4FE-7304 1.8V previously measured at 1.823 V SPA-4FE-7304 1.5V previously measured at 1.512 V SPA-4FE-7304 2.5V previously measured at 2.504 V SPA-4FE-7304 3.3V previously measured at 3.258 V SPA-4FE-7304 1.0V previously measured at 1.014 V Last shutdown reason: shutdown undefined show environment CF-689 Cisco IOS Configuration Fundamentals Command Reference April 2010 The following is sample output from the show environment table command on a Cisco 7304 router with MSCs and SPAs installed: Router# show environment table Temperature tables: Active RP (NPEG100, slot 0): Sample Point HighWarning HighCritical HighShutdown npeg100 outlet 53C/127F 68C/154F 73C/163F npeg100 inlet 53C/127F 68C/154F 73C/163F npeg100 hotspot 53C/127F 68C/154F 73C/163F Line card (7304-MSC-100, slot 4): Sample Point HighWarning HighCritical HighShutdown 7304-MSC-100 48C/118F 63C/145F 68C/154F Card in subslot 4/0: Sample Point HighWarning HighCritical HighShutdown SPA-4FE-7304 inlet 52C/125F 67C/152F 72C/161F SPA-4FE-7304 outlet 52C/125F 67C/152F 72C/161F Voltage tables: Active RP (NPEG100, slot 0): Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut npe outlet 2.5 V 2.275 V 2.375 V 2.400 V 2.600 V 2.625 V 2.725 V npe outlet 3.3 V 3.003 V 3.135 V 3.185 V 3.415 V 3.465 V 3.597 V npe outlet 5.0 V 4.500 V 4.750 V 4.800 V 5.200 V 5.250 V 5.500 V npe outlet 12.0 V 9.960 V 10.440 V 10.800 V 13.200 V 13.560 V 14.040 V npe outlet 3.3c V 3.003 V 3.135 V 3.185 V 3.415 V 3.465 V 3.597 V npe inlet 1.5 V 1.350 V 1.425 V 1.455 V 1.545 V 1.575 V 1.650 V npe outlet 1.8 V 1.620 V 1.710 V 1.728 V 1.872 V 1.890 V 1.980 V npe outlet 1.2 V 1.128 V 1.164 V 1.167 V 1.233 V 1.236 V 1.272 V npe outlet 1.2c V 1.128 V 1.164 V 1.167 V 1.233 V 1.236 V 1.272 V Line card (7304-MSC-100, slot 4): Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut 7304-MSC-100 0.75 0.559 V 0.600 V 0.600 V 0.900 V 0.900 V 0.941 V 7304-MSC-100 1.5 V 1.350 V 1.440 V 1.455 V 1.545 V 1.560 V 1.650 V 7304-MSC-100 2.5 V 2.250 V 2.375 V 2.400 V 2.600 V 2.625 V 2.750 V 7304-MSC-100 3.3 V 2.970 V 3.135 V 3.168 V 3.432 V 3.465 V 3.630 V 7304-MSC-100 12 V 9.960 V 10.440 V 10.800 V 13.200 V 13.560 V 14.040 V Card in subslot 4/0: Sample Point LowShut LowCrit LowWarn HighWarn HighCrit HighShut SPA-4FE-7304 1.8V 1.620 V 1.710 V 1.728 V 1.872 V 1.890 V 1.980 V SPA-4FE-7304 1.5V 1.350 V 1.425 V 1.440 V 1.560 V 1.575 V 1.650 V SPA-4FE-7304 2.5V 2.250 V 2.375 V 2.400 V 2.600 V 2.625 V 2.750 V SPA-4FE-7304 3.3V 2.970 V 3.135 V 3.168 V 3.432 V 3.465 V 3.630 V SPA-4FE-7304 1.0V 0.900 V 0.950 V 0.960 V 1.040 V 1.050 V 1.100 V Table 84 describes the significant fields shown in the display. Table 84 show environment table Field Descriptions for the Cisco 7304 Router Field Description Sample Point Area for which measurements are taken. LowShut Lowest level for an out-of-tolerance condition at which the system shuts itself down. For out-of-tolerance conditions with SPA environment variables, only the SPA is shut down. LowCrit/LowCritical Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown. show environment CF-690 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands LowWarn/LowWarning Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighWarn/HighWarning Level at which a warning message is issued for an out-of-tolerance voltage condition. The system continues to operate, but operator action is recommended to bring the system back to a normal state. HighCrit/HighCritical Level at which a critical message is issued for an out-of-tolerance voltage condition. The system continues to operate; however, the system is approaching shutdown. HighShut/HighShutdown Highest level for an out-of-tolerance condition at which the system shuts itself down. For out-of-tolerance conditions with SPA environment variables, only the SPA is shut down. Table 84 show environment table Field Descriptions for the Cisco 7304 Router (continued) Field Description Command Description snmp-server enable traps envmon Controls (enables or disables) environmental monitoring SNMP notifications. snmp-server host Specifies how SNMP notifications should be sent (as traps or informs), the version of SNMP to use, the security level of the notifications (for SNMPv3), and the recipient (host) of the notifications. show environment alarm CF-691 Cisco IOS Configuration Fundamentals Command Reference April 2010 show environment alarm To display the information about the environmental alarm, use the show environment alarm command in user EXEC or privileged EXEC mode. show environment alarm [{status | threshold} [frutype]] Syntax Description Defaults If you do not enter a frutype, all the information about the environmental alarm status is displayed. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines Valid values for the frutype are as follows: • clock number—1 and 2. • earl slot—See the Note for valid values. • module slot—See the Note for valid values. • rp slot—See the Note for valid values. • power-supply number—1 and 2. • supervisor slot—See the Note for valid values. • vtt number—1 to 3. Note The slot argument designates the module and port number. Valid values for slot depend on the chassis and module that are used. For example, if you have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the slot number are from 1 to 13 and valid values for the port number are from 1 to 48. status (Optional) Displays the operational FRU status. threshold (Optional) Displays the preprogrammed alarm thresholds. frutype (Optional) Alarm type; valid values are all, backplane, clock number, earl slot, fan-tray, module slot, rp slot, power-supply number, supervisor slot, and vtt number. See the Note for a list of valid values for number and slot. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show environment alarm CF-692 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to display all the information about the status of the environmental alarm: Router> show environment alarm threshold environmental alarm thresholds: power-supply 1 fan-fail: OK threshold #1 for power-supply 1 fan-fail: (sensor value != 0) is system minor alarm power-supply 1 power-output-fail: OK threshold #1 for power-supply 1 power-output-fail: (sensor value != 0) is system minor alarm fantray fan operation sensor: OK threshold #1 for fantray fan operation sensor: (sensor value != 0) is system minor alarm operating clock count: 2 threshold #1 for operating clock count: (sensor value < 2) is system minor alarm threshold #2 for operating clock count: (sensor value < 1) is system major alarm operating VTT count: 3 threshold #1 for operating VTT count: (sensor value < 3) is system minor alarm threshold #2 for operating VTT count: (sensor value < 2) is system major alarm VTT 1 OK: OK threshold #1 for VTT 1 OK: (sensor value != 0) is system minor alarm VTT 2 OK: OK threshold #1 for VTT 2 OK: (sensor value != 0) is system minor alarm VTT 3 OK: OK threshold #1 for VTT 3 OK: (sensor value != 0) is system minor alarm clock 1 OK: OK threshold #1 for clock 1 OK: (sensor value != 0) is system minor alarm clock 2 OK: OK threshold #1 for clock 2 OK: (sensor value != 0) is system minor alarm module 1 power-output-fail: OK threshold #1 for module 1 power-output-fail: (sensor value != 0) is system major alarm module 1 outlet temperature: 21C threshold #1 for module 1 outlet temperature: (sensor value > 60) is system minor alarm threshold #2 for module 1 outlet temperature: (sensor value > 70) is system major alarm module 1 inlet temperature: 25C threshold #1 for module 1 inlet temperature: (sensor value > 60) is system minor alarm threshold #2 for module 1 inlet temperature: (sensor value > 70) is system major alarm module 1 device-1 temperature: 30C threshold #1 for module 1 device-1 temperature: (sensor value > 60) is system minor alarm threshold #2 for module 1 device-1 temperature: (sensor value > 70) is system major alarm module 1 device-2 temperature: 29C threshold #1 for module 1 device-2 temperature: (sensor value > 60) is system minor alarm threshold #2 for module 1 device-2 temperature: (sensor value > 70) is system major alarm module 5 power-output-fail: OK show environment alarm CF-693 Cisco IOS Configuration Fundamentals Command Reference April 2010 threshold #1 for module 5 power-output-fail: (sensor value != 0) is system major alarm module 5 outlet temperature: 26C threshold #1 for module 5 outlet temperature: (sensor value > 60) is system minor alarm threshold #2 for module 5 outlet temperature: (sensor value > 75) is system major alarm module 5 inlet temperature: 23C threshold #1 for module 5 inlet temperature: (sensor value > 50) is system minor alarm threshold #2 for module 5 inlet temperature: (sensor value > 65) is system major alarm EARL 1 outlet temperature: N/O threshold #1 for EARL 1 outlet temperature: (sensor value > 60) is system minor alarm threshold #2 for EARL 1 outlet temperature: (sensor value > 75) is system major alarm EARL 1 inlet temperature: N/O threshold #1 for EARL 1 inlet temperature: (sensor value > 50) is system minor alarm threshold #2 for EARL 1 inlet temperature: (sensor value > 65) is system major alarm Router> Related Commands Command Description show environment status Displays the information about the operational FRU status. show environment temperature Displays the current temperature readings. show environment cooling CF-694 Cisco IOS Configuration Fundamentals Command Reference April 2010 show environment cooling To display the information about the cooling parameter, use the show environment cooling command in user EXEC or privileged EXEC mode. show environment cooling Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines This command is not supported in Cisco 7600 series routers that are configured with a Supervisor Engine 2. Examples This example shows how to display the information about the cooling parameter: Router> show environment cooling fan-tray 1: fan-tray 1 fan-fail: failed fan-tray 2: fan 2 type: FAN-MOD-9 fan-tray 2 fan-fail: OK chassis cooling capacity: 690 cfm ambient temperature: 55C chassis per slot cooling capacity: 75 cfm module 1 cooling requirement: 70 cfm module 2 cooling requirement: 70 cfm module 5 cooling requirement: 30 cfm module 6 cooling requirement: 70 cfm module 8 cooling requirement: 70 cfm module 9 cooling requirement: 30 cfm Router> Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description hw-module fan-tray version Sets the fan-type (high or low power) version. show environment status CF-695 Cisco IOS Configuration Fundamentals Command Reference April 2010 show environment status To display the information about the operational FRU status, use the show environment status command in user EXEC or privileged EXEC mode. show environment status [frutype] Syntax Description Defaults If you do not enter a frutype, all FRU status information is displayed. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines Valid values for the frutype are as follows: • all—No arguments. • backplane—No arguments. • clock number—1 and 2. • earl slot—See the Note for valid values. • fan-tray—No arguments. • module slot—See the Note for valid values. • power-supply number—1 and 2. • rp slot—See the Note for valid values. • supervisor slot—See the Note for valid values. • vtt number—1 to 3. Note The slot argument designates the module and port number. Valid values for slot depend on the chassis and module that are used. For example, if you have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the slot number are from 1 to 13 and valid values for the port number are from 1 to 48. frutype (Optional) FRU type; see the Note for a list of valid values. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(18)SXF The output of the show environment status power-supply command was changed to include information about the high-capacity power supplies. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show environment status CF-696 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to display the information about the environmental status: Router> show environment status backplane: operating clock count: 2 operating VTT count: 3 fan-tray: fantray fan operation sensor: OK VTT 1: VTT 1 OK: OK VTT 2: VTT 2 OK: OK VTT 3: VTT 3 OK: OK clock 1: clock 1 OK: OK, clock 1 clock-inuse: not-in-use clock 2: clock 2 OK: OK, clock 2 clock-inuse: in-use power-supply 1: power-supply 1 fan-fail: OK power-supply 1 power-output-fail: OK module 1: module 1 power-output-fail: OK module 1 outlet temperature: 21C module 1 inlet temperature: 25C module 1 device-1 temperature: 30C module 1 device-2 temperature: 29C EARL 1 outlet temperature: N/O EARL 1 inlet temperature: N/O module 5: module 5 power-output-fail: OK module 5 outlet temperature: 26C module 5 inlet temperature: 23C module 5 device-1 temperature: 26C module 5 device-2 temperature: 27C Router> This example shows how to display the information about the high-capacity power supplies: Route># show environment status power-supply 2 power-supply 2: power-supply 2 fan-fail: OK power-supply 2 power-input 1: none power-supply 2 power-input 2: AC low power-supply 2 power-input 3: AC high power-supply 2 power-input 4: AC high power-supply 2 power-output: low (mode 1) power-supply 2 power-output-fail: OK Table 85 describes the fields that are shown in the example. Table 85 show environment status Command Output Fields Field Description operating clock count Physical clock count. operating VTT count Physical VTT count. fan tray fan operation sensor System fan tray failure status. The failure of the system fan tray is indicated as a minor alarm. show environment status CF-697 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands VTT 1, VTT2, and VTT3 Status of the chassis backplane power monitors that are located on the rear of the chassis, under the rear cover. Operation of at least two VTTs is required for the system to function properly. A minor system alarm is signaled when one of the three VTTs fails. A major alarm is signaled when two or more VTTs fail and the supervisor engine is accessible through the console port. clock # clock-inuse Clock status. Failure of either clock is considered to be a minor alarm. power-supply # fan-fail Fan failure. Fan failures on either or both (if any) power supplies are considered minor alarms. power-input-fail Power input failure status (none, AC high, AC low). power-output-fail Power output failure status (high, low). outlet temperature Exhaust temperature value. inlet temperature Intake temperature value. device-1 and device-2 temperature Two devices that measure the internal temperature on each indicated module. The temperature shown indicates the temperature that the device is recording. The devices are not placed at an inlet or an exit but are additional reference points. Table 85 show environment status Command Output Fields (continued) Field Description Command Description show environment alarm Displays the information about the environmental alarm. show environment temperature Displays the current temperature readings. show environment temperature CF-698 Cisco IOS Configuration Fundamentals Command Reference April 2010 show environment temperature To display the current temperature readings, use the show environment temperature command in user EXEC or privileged EXEC mode. show environment temperature [frutype] Syntax Description Defaults If you do not enter a frutype, the module and EARL temperature readings are displayed. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines Valid values for the frutype are as follows: • earl slot—See the Note below for valid values. • module slot—See the Note below for valid values. • rp slot—See the the Note below for valid values. • vtt number—1 to 3. • clock number—1 and 2. frutype (Optional) Field replaceable unit (FRU) type; see the “Usage Guidelines” section for a list of valid values. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17a)SX The show environment temperature module command output was updated to include the following information: • The name of the ASIC of this sensor. • The names of the ASIC are listed if there is more than one ASIC. • The type of sensor is listed if there is more than one sensor on the ASIC. • Current temperature. • Major/minor threshold as read in the IDPROM. • Status of whether the current temperature has exceeded any temperature thresholds. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show environment temperature CF-699 Cisco IOS Configuration Fundamentals Command Reference April 2010 Note The slot argument designates the module and port number. Valid values for slot depend on the chassis and module that are used. For example, if you have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the slot number are from 1 to 13 and valid values for the port number are from 1 to 48. The show environment temperature module command output includes the updated information after an SCP response is received. In the output display, the following applies: • N/O means not operational—The sensor is broken, returning impossible values. • N/A means not available—The sensor value is presently not available; try again later. • VTT 1, 2, and 3 refer to the power monitors that are located on the chassis backplane under the rear cover. Examples This example shows how to display the temperature information for a specific module: Router> show environment temperature module 5 module 5 outlet temperature: 34C module 5 inlet temperature: 27C module 5 device-1 temperature: 42C module 5 device-2 temperature: 41C module 5 asic-1 (SSO-1) temp: 29C module 5 asic-2 (SSO-2) temp: 29C module 5 asic-3 (SSO-3) temp: 29C module 5 asic-4 (SSO-4) temp: 28C module 5 asic-5 (SSA-1) temp: 29C module 5 asic-6 (HYPERION-1) temp: 29C Router> This example shows how to display the temperature readings for all modules: Router> show environment temperature VTT 1 outlet temperature: 25C VTT 2 outlet temperature: 24C VTT 3 outlet temperature: 28C module 1 outlet temperature: 24C module 1 device-2 temperature: 29C RP 1 outlet temperature: 25C RP 1 inlet temperature: 29C EARL 1 outlet temperature: 25C EARL 1 inlet temperature: 22C module 5 outlet temperature: 27C module 5 inlet temperature: 22C Router> Table 86 describes the fields that are shown in the example. Table 86 show environment temperature Command Output Fields Field Description outlet temperature Exhaust temperature value. show environment temperature CF-700 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands inlet temperature Intake temperature value. device-1 and device-2 temperature Two devices that measure the internal temperature on the indicated module. The temperature shown indicates the temperature that the device is recording. The devices are not placed at an inlet or an exit but are additional reference points. Table 86 show environment temperature Command Output Fields Field Description Command Description show environment alarm Displays the information about the environmental alarm. show environment status Displays the information about the operational FRU status. show errdisable detect CF-701 Cisco IOS Configuration Fundamentals Command Reference April 2010 show errdisable detect To display the error-disable detection status, use the show errdisable detect command in user EXEC or privileged EXEC mode. show errdisable detect Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Examples This example shows how to display the error-disable detection status: Router> show errdisable detect ErrDisable Reason Detection status ----------------- ---------------- udld Enabled bpduguard Enabled rootguard Enabled packet-buffer-err Enabled pagp-flap Enabled dtp-flap Enabled link-flap Enabled Router# Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17b)SXA This command was changed to include packet-buffer error status information. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description errdisable detect cause Enables the error-disable detection. show errdisable recovery CF-702 Cisco IOS Configuration Fundamentals Command Reference April 2010 show errdisable recovery To display the information about the error-disable recovery timer, use the show errdisable recovery command in EXEC mode. show errdisable recovery Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes EXEC Command History Examples This example shows how to display the information about the error-disable recovery timer: Router# show errdisable recovery ErrDisable Reason Timer Status ----------------- -------------- udld Enabled bpduguard Enabled rootguard Enabled pagp-flap Enabled dtp-flap Enabled link-flap Enabled Timer interval:300 seconds Interfaces that will be enabled at the next timeout: Interface Errdisable reason Time left(sec) --------- ----------------- -------------- Fa9/4 link-flap 279 Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description errdisable recovery Configures the recovery mechanism variables. show interfaces status Displays the interface status or a list of interfaces in an error-disabled state on LAN ports only. show fastblk CF-703 Cisco IOS Configuration Fundamentals Command Reference April 2010 show fastblk To display fast block memory information, use the show fastblk command in privileged EXEC mode. show fastblk [detailed] Syntax Description Command Modes Privileged EXEC (#) Command History Usage Guidelines Use this command to display allocated fast block memory pool details. When no memory pools are allocated, the “no fastblk memory pools allocated” message is displayed. Examples The following is sample output from the show fastblk command using the detailed keyword. The fields are self-explanatory. Router# show fastblk detailed Pool name: SCTP ApplReq flags:DYN_POOL total = 400 inuse = 0, free = 400, max = 0 increment = 200, threshold = 100, hist max = 400 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62968A2C, total = 400, inuse= 0, free = 400 delete count = 0, flags: Pool name: SCTP BufSegHdr flags:DYN_POOL total = 9000 inuse = 0, free = 9000, max = 0 increment = 4500, threshold = 6750, hist max = 9000 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62B8E2F4, total = 9000, inuse= 0, free = 9000 delete count = 0, flags: Pool name: SCTP DestAddr flags:DYN_POOL total = 80 inuse = 0, free = 80, max = 0 increment = 40, threshold = 20, hist max = 80 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62972534, total = 80, inuse= 0, free = 80 delete count = 0, flags: Pool name: SCTP Addr flags:DYN_POOL POOL_HAS_GRWN total = 200 inuse = 100, free = 100, max = 0 increment = 50, threshold = 50, hist max = 200 alloc failures = 31, sub-pool creation failures = 0 subpool: blks = 0x6271B6D0, total = 50, inuse= 0, free = 50 delete count = 0, flags: DYN_SUBPOOL subpool: blks = 0x6271D730, total = 50, inuse= 0, free = 50 delete count = 0, flags: DYN_SUBPOOL subpool: blks = 0x6297680C, total = 100, inuse= 100, free = 0 delete count = 0, flags: Pool name: SCTP ChunkDesc flags:DYN_POOL detailed (Optional) Displays detailed allocated fast block memory pool information. Release Modification 12.4(22)T This command was introduced. show fastblk CF-704 Cisco IOS Configuration Fundamentals Command Reference April 2010 total = 9000 inuse = 0, free = 9000, max = 0 increment = 4500, threshold = 6750, hist max = 9000 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62BE6160, total = 1471, inuse= 0, free = 1471 delete count = 0, flags: subpool: blks = 0x62D8D768, total = 7529, inuse= 0, free = 7529 delete count = 0, flags: Pool name: SCTP DgramHdr flags:DYN_POOL total = 9000 inuse = 0, free = 9000, max = 0 increment = 4500, threshold = 6750, hist max = 9000 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62BFE848, total = 9000, inuse= 0, free = 9000 delete count = 0, flags: Pool name: SCTP Assoc flags:DYN_POOL total = 100 inuse = 0, free = 100, max = 0 increment = 50, threshold = 25, hist max = 100 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62E0A778, total = 100, inuse= 0, free = 100 delete count = 0, flags: Pool name: SCTP Instance flags:DYN_POOL total = 200 inuse = 50, free = 150, max = 0 increment = 100, threshold = 50, hist max = 200 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62C33434, total = 200, inuse= 50, free = 150 delete count = 0, flags: Pool name: SCTP Assoc Stats flags:DYN_POOL total = 100 inuse = 0, free = 100, max = 0 increment = 50, threshold = 25, hist max = 100 alloc failures = 0, sub-pool creation failures = 0 subpool: blks = 0x62C39EA0, total = 100, inus show file descriptors CF-705 Cisco IOS Configuration Fundamentals Command Reference April 2010 show file descriptors To display a list of open file descriptors, use the show file descriptors command in EXEC mode. show file descriptors Syntax Description This command has no arguments or keywords. Command Modes EXEC Command History Usage Guidelines File descriptors are the internal representations of open files. You can use this command to learn if another user has a file open. Examples The following is sample output from the show file descriptors command: Router# show file descriptors File Descriptors: FD Position Open PID Path 0 187392 0001 2 tftp://dirt/hampton/c4000-i-m.a 1 184320 030A 2 flash:c4000-i-m.a Table 87 describes the fields shown in the display. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 87 show file descriptors Field Descriptions Field Description FD File descriptor. The file descriptor is a small integer used to specify the file once it has been opened. Position Byte offset from the start of the file. Open Flags supplied when opening the file. PID Process ID of the process that opened the file. Path Location of the file. show file information CF-706 Cisco IOS Configuration Fundamentals Command Reference April 2010 show file information To display information about a file, use the show file information command in EXEC mode. show file information file-url Syntax Description Command Modes EXEC Command History Examples The following is sample output from the show file information command: Router# show file information tftp://dirt/hampton/c2500-j-l.a tftp://dirt/hampton/c2500-j-l.a: type is image (a.out) [relocatable, run from flash] file size is 8624596 bytes, run size is 9044940 bytes [8512316+112248+420344] Foreign image Router# show file information slot0:c7200-js-mz slot0:c7200-js-mz: type is image (elf) [] file size is 4770316 bytes, run size is 4935324 bytes Runnable image, entry point 0x80008000, run from ram Router1# show file information nvram:startup-config nvram:startup-config: type is ascii text Table 88 describes the possible file types. file-url The URL of the file to display. Release Modification 11.3 AA This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 88 Possible File Types Types Description image (a.out) Runnable image in a.out format. image (elf) Runnable image in elf format. ascii text Configuration file or other text file. coff Runnable image in coff format. ebcdic Text generated on an IBM mainframe. show file information CF-707 Cisco IOS Configuration Fundamentals Command Reference April 2010 lzw compression Lzw compressed file. tar Text archive file used by the Channel Interface Processor (CIP). Table 88 Possible File Types (continued) Types Description show file systems CF-708 Cisco IOS Configuration Fundamentals Command Reference April 2010 show file systems To list available file systems, use the show file systems command in privileged EXEC mode. show file systems Syntax Description This command has no arguments or keywords. Command Modes Privileged EXEC Command History Usage Guidelines Use this command to learn the alias names, the Prefixes column in the output of the file systems that your router supports. Examples The following is sample output from the show file systems command: Router# show file systems File Systems: Size(b) Free(b) Type Flags Prefixes - - ram rw tmp: - - opaque rw system: 42541056 42541056 disk rw disk1: disk1:0:# 512065536 30834688 disk rw disk0:# 65536000 19811932 flash rw bootflash: sup-bootflash: - - opaque ro ivfs: 129004 102228 nvram rw const_nvram: 125802334 0 opaque ro microcode: sup-microcode: 0 609689428 opaque rw image: sup-image: - - opaque rw null: - - opaque ro tar: 1964024 1949453 nvram rw nvram: - - network rw rcp: - - network rw tftp: - - network rw http: - - network rw ftp: Release Modification 11.3AA This command was introduced. 12.3(7)T This command was enhanced to display information about the ATA ROM monitor library (monlib) file. 12.2(25)S This command was integrated into Cisco IOS Release 12.2(25)S. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2(33)SXI This command was integrated into Cisco IOS Release 12.2(33)SXI and the output was modified. 12.4(24)T This command was integrated into Cisco IOS Release 12.4(24)T and the output was modified. show file systems CF-709 Cisco IOS Configuration Fundamentals Command Reference April 2010 - - disk rw disk1:1: - - disk rw disk1:2: 512065536 30842880 disk rw slavedisk0:# - - disk rw slavedisk1: slavedisk1:0: 65536000 19328264 flash rw slavesup-bootflash: 1964024 1919757 nvram rw slavenvram: 129004 102228 nvram rw slaveconst_nvram: 65536000 65536000 flash rw slavebootflash: - - nvram rw slavercsf: - - opaque rw slavesystem: - - disk rw slavedisk1:1: - - disk rw slavedisk1:2: - - disk rw slavedisk1:3: Table 89 describes the significant fields shown in the display. Table 89 show file systems Field Descriptions Field Description Size(b) Amount of memory in the file system (in bytes). Free(b) Amount of free memory in the file system (in bytes). Type Type of file system. The file system can be one of the following types: • disk—The file system is for a rotating medium. • flash—The file system is for a flash memory device. • network—The file system is a network file system (TFTP, rcp, FTP, and so on). • nvram—The file system is for an NVRAM device. • opaque—The file system is a locally generated “pseudo” file system (for example, the “system”) or a download interface, such as brimux. • ram—The file system is for a RAM or EPROM device. • tty—The file system is for a collection of terminal devices. • unknown—The file system is of unknown type. Flags Permissions for the file system. The file system can have one of the following permission states: • ro—The file system is Read Only. • wo—The file system is Write Only. • rw—The file system is Read/Write. Prefixes Alias for the file system. Prefixes marked with a pound symbol (#) indicate a bootable disk. show flh-log CF-710 Cisco IOS Configuration Fundamentals Command Reference April 2010 show flh-log The show flh-log command has been replaced by the more flh:logfile command. See the description of the more flh:logfile command for more information. show fm inspect CF-711 Cisco IOS Configuration Fundamentals Command Reference April 2010 show fm inspect To display the list and status of the access control lists (ACLs) and ports on which context based access control (CBAC) is configured, use the show fm inspect command in user EXEC or privileged EXEC mode. show fm inspect [detail | interface type mod/port] Syntax Description Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines If you can configure a VLAN access control list (VACL) on the port before you configure CBAC, the status displayed is INACTIVE; otherwise, it is ACTIVE. If policy feature card (PFC) resources are exhausted, the command displays BRIDGE and is followed by the number of failed currently active NetFlow requests that have been sent to the MSFC2 for processing. The show fm inspect command output includes this information: • interface:—Interface on which the internet protocol (IP) inspect feature is enabled • (direction)—Direction in which the IP inspect feature is enabled (IN or OUT) • acl name:—Name that is used to identify packets being inspected • status:—(ACTIVE or INACTIVE) displays if HW-assist is provided for this interface+direction (ACTIVE=hardware assisted or INACTIVE) The optional detail keyword displays the ACEs that are part of the ACL that is used for IP inspect on the given interface direction. Examples This example shows how to display the list and status of CBAC-configured ACLs and ports: Router> show fm inspect detail (Optional) Displays all of the flow information. interface type Interface type; possible valid values are ethernet, fastethernet, gigabitethernet, tengigabitethernet, port-channel, pos, atm, null, tunnel, and ge-wan. mod/port Module and port number. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show fm inspect CF-712 Cisco IOS Configuration Fundamentals Command Reference April 2010 interface:Vlan305(in) status :ACTIVE acl name:deny interfaces: Vlan305(out):status ACTIVE Related Commands Command Description show fm summary Displays a summary of FM Information. show fm interface CF-713 Cisco IOS Configuration Fundamentals Command Reference April 2010 show fm interface To display the detailed information about the feature manager on a per-interface basis, use the show fm interface command in user EXEC or privileged EXEC mode. show fm interface {interface type mod/port | null interface-number | port-channel number | vlan vlan-id} Syntax Description Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Usage Guidelines The pos, atm, and ge-wan keywords are supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2. The interface-number argument designates the module and port number. Valid values for interface-number depend on the specified interface type and the chassis and module that are used. For example, if you specify a Gigabit Ethernet interface and have a 48-port 10/100BASE-T Ethernet module that is installed in a 13-slot chassis, valid values for the module number are from 1 to 13 and valid values for the port number are from 1 to 48. The port-channel number values from 257 to 282 are supported on the CSM and the FWSM only. type Interface type; possible valid values are ethernet, fastethernet, gigabitethernet, tengigabitethernet, port-channel, pos, atm, null, tunnel, and ge-wan. mod/port Module and port number. null interface-number Specifies the null interface; the valid value is 0. port-channel number Specifies the channel interface; valid values are a maximum of 64 values ranging from 1 to 282. vlan vlan-id Specifies the virtual local area network (VLAN); valid values are from 1 to 4094. Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17a)SX The order of the information that is displayed in the show fm interface vlan command output was changed. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show fm interface CF-714 Cisco IOS Configuration Fundamentals Command Reference April 2010 Examples This example shows how to display the detailed information about the feature manager on a specified interface: Router> show fm interface fastethernet 2/26 Interface:FastEthernet2/26 IP is enabled hw[EGRESS] = 1, hw[INGRESS] = 0 hw_force_default[EGRESS] = 0, hw_force_default[INGRESS] = 1 mcast = 0 priority = 2 reflexive = 0 inbound label:24 protocol:ip feature #:1 feature id:FM_IP_ACCESS ACL:113 vmr IP value #1:0, 0, 0, 0, 0, 0, 0, 6 - 1 vmr IP mask #1:0, 0, FFFF, FFFF, 0, 0, 0, FF vmr IP value #2:642D4122, 0, 0, 0, 1, 0, 0, 6 - 1 vmr IP mask #2:FFFFFFFF, 0, 0, 0, 1, 0, 0, FF vmr IP value #3:0, 64020302, 0, 0, 6, 0, 0, 6 - 1 vmr IP mask #3:0, FFFFFFFF, 0, 0, 6, 0, 0, FF vmr IP value #4:0, 64020302, 0, 0, A, 0, 0, 6 - 1 vmr IP mask #4:0, FFFFFFFF, 0, 0, A, 0, 0, FF vmr IP value #5:0, 64020302, 0, 0, 12, 0, 0, 6 - 1 vmr IP mask #5:0, FFFFFFFF, 0, 0, 12, 0, 0, FF vmr IP value #6:0, 0, 0, 0, 0, 0, 0, 0 - 2 vmr IP mask #6:0, 0, 0, 0, 0, 0, 0, 0 outbound label:3 protocol:ip feature #:1 feature id:FM_IP_WCCP Service ID:0 Service Type:0 Router> This example shows how to display the detailed information about the feature manager on a specific VLAN: Router> show fm interface vlan 21 Interface: Vlan21 IP is disabled hw_state[INGRESS] = not reduced, hw_state[EGRESS] = not reduced mcast = 0 priority = 0 flags = 0x0 inbound label: 8 Feature IP_VACL: ----------------------------------------------------------------------------- FM_FEATURE_IP_VACL_INGRESS i/f: Vl21 map name: test ============================================================================= ------------------------------------------------------------ IP Seq. No: 10 Seq. Result : VACL_ACTION_FORWARD_CAPTURE ------------------------------------------------------------ DPort - Destination Port SPort - Source Port Pro - Protocol X - XTAG TOS - TOS Value Res - VMR Result RFM - R-Recirc. Flag MRTNP - M-Multicast Flag R - Reflexive flag - F-Fragment flag - T-Tcp Control N - Non-cachable - M-More Fragments - P-Mask Priority(H-High, L-Low) Adj. - Adj. Index T - M(Mask)/V(Value) FM - Flow Mask NULL - Null FM SAO - Source Only FM DAO - Dest. Only FM SADA - Sour.& Dest. Only VSADA - Vlan SADA Only FF - Full Flow VFF - Vlan Full Flow F-VFF - Either FF or VFF A-VSD - Atleast VSADA show fm interface CF-715 Cisco IOS Configuration Fundamentals Command Reference April 2010 A-FF - Atleast FF A-VFF - Atleast VFF A-SON - Atleast SAO A-DON - Atleast DAO A-SD - Atleast SADA SHORT - Shortest A-SFF - Any short than FF A-EFF - Any except FF A-EVFF- Any except VFF A-LVFF- Any less than VFF ERR - Flowmask Error +----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+ |Indx|T| Dest Ip Addr | Source Ip Addr|DPort|SPort|Pro|RFM|X|ToS|MRTNP|Adj.| FM | +----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+ 1 V 22.2.2.2 21.1.1.1 0 0 0 --- 0 0 ----L ---- SHORT M 255.255.255.255 255.255.255.255 0 0 0 000 0 0 TM_PERMIT_RESULT 2 V 32.2.2.2 31.1.1.1 0 0 0 --- 0 0 ----L ---- SHORT M 255.255.255.255 255.255.255.255 0 0 0 000 0 0 TM_PERMIT_RESULT 3 V 0.0.0.0 0.0.0.0 0 0 0 --- 0 0 ----L ---- SHORT M 0.0.0.0 0.0.0.0 0 0 0 000 0 0 TM_L3_DENY_RESULT ------------------------------------------------------------ IP Seq. No: 65536 Seq. Result : VACL_ACTION_DROP ------------------------------------------------------------ +----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+ |Indx|T| Dest Ip Addr | Source Ip Addr|DPort|SPort|Pro|RFM|X|ToS|MRTNP|Adj.| FM | +----+-+---------------+---------------+-----+-----+---+---+-+---+-----+----+------+ 1 V 0.0.0.0 0.0.0.0 0 0 0 --- 0 0 ----L ---- SHORT M 0.0.0.0 0.0.0.0 0 0 0 000 0 0 TM_PERMIT_RESULT Router> Related Commands Command Description show fm summary Displays a summary of FM Information. show fm reflexive CF-716 Cisco IOS Configuration Fundamentals Command Reference April 2010 show fm reflexive To display the information about the reflexive entry for the dynamic feature manager, use the show fm reflexive command in privileged EXEC mode. show fm reflexive Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes Privileged EXEC Command History Examples This example shows how to display the information about the reflexive entry for the dynamic feature manager: Router# show fm reflexive Reflexive hash table: Vlan613:refacl, OUT-REF, 64060E0A, 64060D0A, 0, 0, 7, 783, 6 Router# Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show fm summary CF-717 Cisco IOS Configuration Fundamentals Command Reference April 2010 show fm summary To display a summary of feature manager information, use the show fm summary command in user EXEC or privileged EXEC mode. show fm summary Syntax Description This command has no arguments or keywords. Defaults This command has no default settings. Command Modes User EXEC Privileged EXEC Command History Examples This example shows how to display a summary of feature manager information: Router> show fm summary Current global ACL merge algorithm:BDD Interface:FastEthernet2/10 ACL merge algorithm used: inbound direction: ODM outbound direction:BDD TCAM screening for features is ACTIVE outbound TCAM screening for features is ACTIVE inbound Interface:FastEthernet2/26 ACL merge algorithm used: inbound direction: ODM outbound direction:BDD TCAM screening for features is ACTIVE outbound TCAM screening for features is INACTIVE inbound . . . Router> Related Commands Release Modification 12.2(14)SX Support for this command was introduced on the Supervisor Engine 720. 12.2(17d)SXB Support for this command on the Supervisor Engine 2 was extended to Release 12.2(17d)SXB. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Command Description show fm interface Displays the detailed information about the feature manager on a per-interface basis. show funi CF-718 Cisco IOS Configuration Fundamentals Command Reference April 2010 show funi To display the frame-based user-network interface information, use the show funi command in user EXEC or privileged EXEC mode. show funi {arp-server [atm atm-interface-number] | class-links {vpi/vci-value | vci-value | connection-name} | ilmi-configuration | ilmi-status [atm atm-interface-number] | map | pvc [vpi/vci-value | vci-value | connection-name | dbs | ppp] | route | traffic | vp [atm-vpi-number] | vc [atm-vcd-number | connection-name | detail [prefix {interface | vc_name | vcd | vpi/vci}] | interface atm atm-interface-number [connection-name | detail [prefix {interface | vc_name | vcd | vpi/vci}]] | range lower-vcd-limit upper-vcd-limit [connection-name | detail [prefix {interface | vc_name | vcd | vpi/vci}]] | interface atm atm-interface-number [connection-name | detail [prefix {interface | vc_name | vcd | vpi/vci}]] | summary [atm atm-interface-number]]} Syntax Description arp-server Displays Asynchronous Transfer Mode (ATM) address resolution protocol server table information. atm atm-interface-number (Optional) Specifies the ATM interface and the ATM interface number. class-links Displays ATM VC-class links information. vpi/vci-value (Optional) Specifies the Virtual Path Identifier or Virtual Channel Identifier (VPI/VCI) value (slash is mandatory). vci-value (Optional) Specifies the virtual circuit interface value. connection-name (Optional) Specifies the connection name. ilmi-configuration Displays the top-level Integrated Local Management Interface (ILMI) information. ilmi-status Display ATM interface ILMI information. map Displays ATM static mapping information. pvc Displays ATM Permanent Virtual Circuits (PVC) information. dbs Displays the DBS information on a virtual circuit. ppp Displays the PPP over ATM information route Displays ATM route information. traffic Displays ATM statistics. vp Displays ATM virtual path information. atm-vpi-number (Optional) Specifies the VPI number. vc Displays ATM virtual circuit information. atm-vcd-number (Optional) Specifies the ATM Virtual Circuit Descriptor (VCD) number. detail Displays the detailed information of all VCs. prefix (Optional) Specifies the prefix for the output ordering. interface Specifies the type of interface. When this keyword is used along with the prefix keyword it displays the interface values in ascending order. vc_name Displays the VC names in the alphabetical order. vcd Displays the VCD value in the ascending order. vpi/vci Displays the VPI/VCI value in the ascending order. show funi CF-719 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines Use this command to display the frame-based user-network interface information with the available keywords and arguments. Examples The following is sample output from the show funi traffic command. The fields are self-explanatory: Router# show funi traffic Input OAM Queue: 0/4136 (size/max) 0 Input packets 0 Output packets 0 Broadcast packets 0 Packets received on non-existent VC 0 Packets attempted to send on non-existent VC 0 OAM cells received F5 InEndloop: 0, F5 InSegloop: 0, F5 InAIS: 0, F5 InRDI: 0 F5 InEndcc: 0, F5 InSegcc: 0, F4 InEndloop: 0, F4 InSegloop: 0, F4 InAIS: 0, F4 InRDI: 0 0 OAM cells sent F5 OutEndloop: 0, F5 OutSegloop: 0, F5 OutAIS: 0 F5 OutRDI: 0 F5 OutEndcc: 0, F5 OutSegcc: 0, F4 OutEndloop: 0, F4 OutSegloop: 0, F4 OutRDI: 0 F4 OutAIS: 0 0 OAM cell drops The following is sample out from the show funi vc detail prefix interface command. The fields are self-explanatory: Router# show funi vc detail prefix interface Description: N/A ATM2/0 ATM2/0: VCD: 1, VPI: 1, VCI: 100 ATM2/0 UBR, PeakRate: 0 (0 cps) ATM2/0 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12 ATM2/0 OAM frequency: 0 second(s) ATM2/0 InARP frequency: 15 minutes(s) ATM2/0 Transmit priority 6 ATM2/0 InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0 InCells: 0, OutCells: 0 ATM2/0 InPRoc: 0, OutPRoc: 0, Broadcasts: 0 ATM2/0 InFast: 0, OutFast: 0, InAS: 0, OutAS: 0 range Displays the range of VCs. lower-vcd-limit Specifies the lower limit VCD value. upper-vcd-limit Specifies the upper limit VCD value. summary Display summary of VCs. Release Modification 12.4(24)T This command was introduced. Cisco IOS XE 2.3 This command was implemented on Cisco ASR 1000 series routers. show funi CF-720 Cisco IOS Configuration Fundamentals Command Reference April 2010 ATM2/0 InPktDrops: 0, OutPktDrops: 0 ATM2/0 CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation: 0, CPIE0 ATM2/0 Out CLP=1 Pkts: 0, Cells: 0 ATM2/0 OAM cells received: 0 ATM2/0 OAM cells sent: 0 ATM2/0 Status: INACTIVE Description: N/A ATM2/0 ATM2/0: VCD: 2, VPI: 1, VCI: 101 ATM2/0 UBR, PeakRate: 0 (0 cps) ATM2/0 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12 ATM2/0 OAM frequency: 0 second(s) The following is sample out from the show funi vc detail prefix vc_name command. The fields are self-explanatory: Router# show funi vc detail prefix vc_name Description: N/A ATM2/0: VCD: 1, VPI: 1, VCI: 100 UBR, PeakRate: 0 (0 cps) AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12 OAM frequency: 0 second(s) InARP frequency: 15 minutes(s) Transmit priority 6 InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0 InCells: 0, OutCells: 0 InPRoc: 0, OutPRoc: 0, Broadcasts: 0 InFast: 0, OutFast: 0, InAS: 0, OutAS: 0 InPktDrops: 0, OutPktDrops: 0 CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation: 0, CPIErrors: 0 Out CLP=1 Pkts: 0, Cells: 0 OAM cells received: 0 OAM cells sent: 0 Status: INACTIVE Description: N/A ATM2/0: VCD: 2, VPI: 1, VCI: 101 UBR, PeakRate: 0 (0 cps) AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 12 OAM frequency: 0 second(s) InARP frequency: 15 minutes(s) The following is sample out from the show funi vc detail prefix pvi/vci command. The fields are self-explanatory: Router# show funi vc detail prefix vpi/vci Description: N/A VPI/VCI: 1/100 ATM2/0: VCD: 1, VPI: 1, VCI: 100 VPI/VCI: 1/100 UBR, PeakRate: 0 (0 cps) VPI/VCI: 1/100 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 2 VPI/VCI: 1/100 OAM frequency: 0 second(s) VPI/VCI: 1/100 InARP frequency: 15 minutes(s) VPI/VCI: 1/100 Transmit priority 6 VPI/VCI: 1/100 InPkts: 0, OutPkts: 0, InBytes: 0, OutBytes: 0 InCells: 0, OutCells: 0 VPI/VCI: 1/100 InPRoc: 0, OutPRoc: 0, Broadcasts: 0 VPI/VCI: 1/100 InFast: 0, OutFast: 0, InAS: 0, OutAS: 0 VPI/VCI: 1/100 InPktDrops: 0, OutPktDrops: 0 VPI/VCI: 1/100 CrcErrors: 0, SarTimeOuts: 0, OverSizedSDUs: 0, LengthViolation:0 VPI/VCI: 1/100 Out CLP=1 Pkts: 0, Cells: 0 VPI/VCI: 1/100 OAM cells received: 0 VPI/VCI: 1/100 OAM cells sent: 0 VPI/VCI: 1/100 Status: INACTIVE Description: N/A show funi CF-721 Cisco IOS Configuration Fundamentals Command Reference April 2010 VPI/VCI: 1/101 ATM2/0: VCD: 2, VPI: 1, VCI: 101 VPI/VCI: 1/101 UBR, PeakRate: 0 (0 cps) VPI/VCI: 1/101 AAL5-LLC/SNAP, etype:0x0, Flags: 0xC20, VCmode: 0x0, Encapsize: 2 show identity policy CF-722 Cisco IOS Configuration Fundamentals Command Reference April 2010 show identity policy To display identity policy information in a tabular form, use the show identity policy command in privileged EXEC mode. show identity policy [name] Syntax Description Command Modes Privileged EXEC (#) Command History Examples The following is output from the show identity policy command: Router# show identity policy Policy Name ACL Redirect ACL Redirect URL =============================================================================== p1 some-acl NONE NONE p2 another-acl redirect-acl http://www.foo.com/bar.html Router# The following is output for the policy named p2: Router# show identity policy p2 Name: p2 Description: NONE Access-Group: another-acl URL-Redirect Match ACL: redirect-acl URL-Redirect URL: http://www.foo.com/bar.html Router# Related Commands name (Optional) Name of the identity policy. Release Modification 12.2(18)SX This command was introduced. Command Description show running-configuration Displays the running configuration for a router. show identity profile CF-723 Cisco IOS Configuration Fundamentals Command Reference April 2010 show identity profile To display identity profile information in a tabular form, use the show identity profile command in privileged EXEC mode. show identity profile [ default | dot1x | eapoudp] Syntax Description Command Modes Privileged EXEC (#) Command History Examples The following is output from the show identity profile command: Router# show running identity profile Service Type: default Default Authorized Device Policy: NONE Default Non-Authorized Device Policy: NONE Device / Address / Mask Allowed Policy ============================================================== Cisco IP Phone Authorized DEFAULT Service Type: dot1x Default Authorized Device Policy: NONE Default Non-Authorized Device Policy: NONE Device / Address / Mask Allowed Policy ============================================================== 0001.0203.0405 / ffff.ffff.ffff Authorized p2 Service Type: eapoudp Device / Address / Mask Allowed Policy ============================================================== 10.0.0.0 / 255.0.0.0 Authorized p1 Router# Related Commands default (Optional) Displays default identity profile information. dot1x (Optional) Displays 802.1x identity profile information. eapoudp (Optional) Displays EAPoUDP identity profile information. Release Modification 12.2(18)SX This command was introduced. Command Description show running-configuration Displays the running configuration for a router. show gsr CF-724 Cisco IOS Configuration Fundamentals Command Reference April 2010 show gsr To display hardware information on the Cisco 12000 series Gigabit Switch Routers (GSRs), use the show gsr command in EXEC mode. show gsr [chassis-info [details]] Syntax Description Command Modes EXEC Command History Usage Guidelines Use this command to determine the type of hardware installed in your Cisco 12000 series GSR router. Examples The following is sample output from the show gsr command for a Cisco 12012 router. This command shows the type and state of the card installed in the slot. Router# show gsr Slot 0 type = Route Processor state = IOS Running MASTER Slot 7 type = 1 Port Packet Over SONET OC-12c/STM-4c state = Card Powered Slot 16 type = Clock Scheduler Card state = Card Powered PRIMARY CLOCK The following is sample output from the show gsr chassis-info command for a Cisco 12012 router: Router# show gsr chassis-info Backplane NVRAM [version 0x20] Contents - Chassis: type 12012 Fab Ver: 1 Chassis S/N: ZQ24CS3WT86MGVHL PCA: 800-3015-1 rev: A0 dev: 257 HW ver: 1.0 Backplane S/N: A109EXPR75FUNYJK MAC Addr: base 0000.EAB2.34FF block size: 1024 RMA Number: 0x5F-0x2D-0x44 code: 0x01 hist: 0x1A chassis-info (Optional) Displays backplane NVRAM information. details (Optional) In addition to the information displayed, this option includes hexadecimal output of the backplane NVRAM information. Release Modification 11.2GS This command was introduced to support the Cisco 12000 series GSRs. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show gt64010 (7200) CF-725 Cisco IOS Configuration Fundamentals Command Reference April 2010 show gt64010 (7200) To display all GT64010 internal registers and interrupt status on the Cisco 7200 series routers, use the show gt64010 command in EXEC mode. show gt64010 Syntax Description This command has no arguments or keywords. Command Modes EXEC Command History Usage Guidelines This command displays information about the CPU interface, DRAM/device address space, device parameters, direct memory access (DMA) channels, timers and counters, and protocol control information (PCI) internal registers. The information is generally useful for diagnostic tasks performed by technical support only. Examples The following is a partial sample output for the show gt64010 command: Router# show gt64010 GT64010 Channel 0 DMA: dma_list=0x6088C3EC, dma_ring=0x4B018480, dma_entries=256 dma_free=0x6088CECC, dma_reqt=0x6088CECC, dma_done=0x6088CECC thread=0x6088CEAC, thread_end=0x6088CEAC backup_thread=0x0, backup_thread_end=0x0 dma_working=0, dma_complete=6231, post_coalesce_frames=6231 exhausted_dma_entries=0, post_coalesce_callback=6231 GT64010 Register Dump: Registers at 0xB4000000 CPU Interface: cpu_interface_conf : 0x80030000 (b/s 0x00000380) addr_decode_err : 0xFFFFFFFF (b/s 0xFFFFFFFF) Processor Address Space : ras10_low : 0x00000000 (b/s 0x00000000) ras10_high : 0x07000000 (b/s 0x00000007) ras32_low : 0x08000000 (b/s 0x00000008) ras32_high : 0x0F000000 (b/s 0x0000000F) cs20_low : 0xD0000000 (b/s 0x000000D0) cs20_high : 0x74000000 (b/s 0x00000074) cs3_boot_low : 0xF8000000 (b/s 0x000000F8) cs3_boot_high : 0x7E000000 (b/s 0x0000007E) pci_io_low : 0x00080000 (b/s 0x00000800) pci_io_high : 0x00000000 (b/s 0x00000000) pci_mem_low : 0x00020000 (b/s 0x00000200) pci_mem_high : 0x7F000000 (b/s 0x0000007F) Release Modification 11.2 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. show gt64010 (7200) CF-726 Cisco IOS Configuration Fundamentals Command Reference April 2010 internal_spc_decode : 0xA0000000 (b/s 0x000000A0) bus_err_low : 0x00000000 (b/s 0x00000000) bus_err_high : 0x00000000 (b/s 0x00000000) . . . show hardware CF-727 Cisco IOS Configuration Fundamentals Command Reference April 2010 show hardware To display the hardware-specific information for a router, use the show hardware command in user EXEC or privileged EXEC mode. show hardware Syntax Description This command has no arguments or keywords. Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines Use the show hardware command to display the hardware specific information for a router. Examples The following is sample output from the show hardware command: Router# show hardware Cisco IOS Software, 7200 Software (C7200-ADVENTERPRISEK9-M), Version 12.4(22)T,) Technical Support: http://www.cisco.com/techsupport Copyright (c) 1986-2008 by Cisco Systems, Inc. Compiled Fri 10-Oct-08 10:10 by prod_rel_team ROM: System Bootstrap, Version 12.2(4r)B2, RELEASE SOFTWARE (fc2) BOOTLDR: 7200 Software (C7200-KBOOT-M), Version 12.3(16), RELEASE SOFTWARE (fc4) Router uptime is 1 day, 16 hours, 32 minutes System returned to ROM by reload at 04:13:23 UTC Wed Aug 12 2009 System image file is "disk0:Default-IOS-Image-Do-Not-Delete" Last reload reason: Reload Command This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately. A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html If you require further assistance please contact us by sending email to export@cisco.com. Release Modification 12.4(22)T This command was introduced. show hardware CF-728 Cisco IOS Configuration Fundamentals Command Reference April 2010 Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memo. Processor board ID 31410931 R7000 CPU at 350MHz, Implementation 39, Rev 3.3, 256KB L2 Cache 6 slot VXR midplane, Version 2.7 Last reset from power-on PCI bus mb0_mb1 (Slots 0, 1, 3 and 5) has a capacity of 600 bandwidth points. Current configuration on bus mb0_mb1 has a total of 600 bandwidth points. This configuration is within the PCI bus capacity and is supported. PCI bus mb2 (Slots 2, 4, 6) has a capacity of 600 bandwidth points. Current configuration on bus mb2 has a total of 180 bandwidth points This configuration is within the PCI bus capacity and is supported. Please refer to the following document "Cisco 7200 Series Port Adaptor Hardware Configuration Guidelines" on Cisco.com for c7200 bandwidth points oversubscription and usage guidelines. 2 FastEthernet interfaces 4 Serial interfaces 125K bytes of NVRAM. 62976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes). 125440K bytes of ATA PCMCIA card at slot 1 (Sector size 512 bytes). 8192K bytes of Flash internal SIMM (Sector size 256K). Configuration register is 0x2002 Related Commands Command Description show interfaces Displays statistics for all interfaces configured on the router or access server. show health-monitor CF-729 Cisco IOS Configuration Fundamentals Command Reference April 2010 show health-monitor To display the system Health Monitor status information, use the show health-monitor command in user EXEC or privileged EXEC mode. show health-monitor [summary] Syntax Description Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines Use this command to display the state of the hardware and software subsystem. Health Monitor is a Cisco IOS subsystem that monitors the state of the individual hardware and software subsystems. This monitoring helps in early detection and recovery of faults in the subsystem. Examples The following is sample output from show health-monitor command. The fields are self explanatory. Router# show health-monitor summary Chassis: Power Supply Failure Temperature OK Fans OK Memory: Free Memory processor OK Memory Fragmentation Processor OK Free Memory I/O OK Memory Fragmentation I/O OK DFC's: Slot 1 - Empty DFC Not in operation Slot 2 - Empty DFC Not in operation Slot 3 - AS5X-FC OK Slot 4 - Empty DFC Not in operation Slot 5 - Empty DFC Not in operation Slot 6 - Empty DFC Not in operation Slot 7 - Empty DFC Not in operation summary (Optional) Displays a summary of the status information. Release Modification 15.0(1)M This command was introduced in a release earlier than Cisco IOS Release 15.0(1)M. show history CF-730 Cisco IOS Configuration Fundamentals Command Reference April 2010 show history To list the commands you have entered in the current EXEC session, use the show history command in EXEC mode. show history Syntax Description This command has no arguments or keywords. Command Modes EXEC Command History Usage Guidelines The command history feature provides a record of EXEC commands you have entered. The number of commands that the history buffer will record is determined by the history size line configuration command or the terminal history size EXEC command. Table 90 lists the keys and functions you can use to recall commands from the command history buffer. Examples The following is sample output from the show history command, which lists the commands the user has entered in EXEC mode for this session: Router# show history help where show hosts show history Router# Related Commands Release Modification 10.0 This command was introduced. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. Table 90 History Keys Key Function Ctrl-P or Up Arrow1 1. The arrow keys function only with ANSI-compatible terminals. Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands. Ctrl-N or Down Arrow1 Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands. show history CF-731 Cisco IOS Configuration Fundamentals Command Reference April 2010 Command Description history size Enables the command history function, or changes the command history buffer size for a particular line. terminal history size Enables the command history feature for the current terminal session, or changes the size of the command history buffer for the current terminal session. show history all CF-732 Cisco IOS Configuration Fundamentals Command Reference April 2010 show history all To display command history and reload information of a router, use the show history all command in user EXEC or privileged EXEC mode. show history all Syntax Description This command has no arguments or keywords. Command Modes User EXEC (>) Privileged EXEC (#) Command History Usage Guidelines Use the show history all command to display command history and reload information of a router. Examples The following is sample output from the show history all command: Router# show history all This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately. A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html If you require further assistance please contact us by sending email to export@cisco.com. Cisco 7206VXR (NPE400) processor (revision A) with 491520K/32768K bytes of memo. Processor board ID 31410931 R7000 CPU at 350MHz, Implementation 39, Rev 3.3, 256KB L2, 4096KB L3 Cache 6 slot VXR midplane, Version 2.7 Last reset from power-on PCI bus mb0_mb1 (Slots 0, 1, 3 and 5) has a capacity of 600 bandwidth points. Current configuration on bus mb0_mb1 has a total of 600 bandwidth points. This configuration is within the PCI bus capacity and is supported. PCI bus mb2 (Slots 2, 4, 6) has a capacity of 600 bandwidth points. Current configuration on bus mb2 has a total of 180 bandwidth points This configuration is within the PCI bus capacity and is supported. Release Modification 12.4(22)T This command was introduced. show history all CF-733 Cisco IOS Configuration Fundamentals Command Reference April 2010 Please refer to the following document "Cisco 7200 Series Port Adaptor Hardware Configuration Guidelines" on Cisco.com for c7200 bandwidth points oversubscription and usage guidelines. 2 FastEthernet interfaces 4 Serial interfaces 125K bytes of NVRAM. Installed image archive Aug 12 04:17:08.415: %LINEPROTO-5-UPDOWN: Line protocol on Interface VoIP-Nullp Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface FastEthernet0/0, changed state p Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface FastEthernet0/1, changed state p Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface Serial2/0, changed state to down Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface Serial2/1, changed state to down Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface Serial3/0, changed state to up Aug 12 04:17:08.419: %LINK-3-UPDOWN: Interface Serial3/1, changed state to up Aug 12 04:17:08.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface SSLVPN-VIp 62976K bytes of ATA PCMCIA card at slot 0 (Sector size 512 bytes). 125440K bytes of ATA PCMCIA card at slot 1 (Sector size 512 bytes). 8192K bytes of Flash internal SIMM (Sector size 256K). Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEtherp Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEtherp Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial2/0n Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial2/1n Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial3/0p Aug 12 04:17:09.419: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial3/1p Aug 12 04:17:12.411: %LINK-3-UPDOWN: Interface Serial3/0, changed state to down Aug 12 04:17:12.411: %LINK-3-UPDOWN: Interface Serial3/1, changed state to down Aug 12 04:17:13.411: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial3/0n Aug 12 04:17:13.411: %LINEPROTO-5-UPDOWN: Line protocol on Interface Serial3/1n --- System Configuration Dialog --- Would you like to enter the initial configuration dialog? [yes/no]: % Please answer 'yes' or 'no'. Would you like to enter the initial configuration dialog? [yes/no]: no Would you like to terminate autoinstall? [yes]: yes CMD: 'access-list 199 permit icmp host 10.10.10.10 host 20.20.20.20' 04:18:15 U9 CMD: 'crypto map NiStTeSt1 10 ipsec-manual' 04:18:15 UTC Wed Aug 12 2009 CMD: 'match address 199 ' 04:18:15 UTC Wed Aug 12 2009 CMD: 'set peer 20.20.20.20 ' 04:18:15 UTC Wed Aug 12 2009 CMD: 'exit' 04:18:15 UTC Wed Aug 12 2009 CMD: 'no access-list 199' 04:18:15 UTC Wed Aug 12 2009 CMD: 'no crypto map NiStTeSt1' 04:18:15 UTC Wed Aug 12 2009 Aug 12 04:18:15.403: %SYS-5-RESTART: System restarted -- Cisco IOS Software, 7200 Software (C7200-ADVENTERPRISEK9-M), Version 12.4(22)T,) Technical Support: http://www.cisco.com/techsupport Copyright (c) 1986-2008 by Cisco Systems, Inc. Compiled Fri 10-Oct-08 10:10 by prod_rel_team Aug 12 04:18:15.415: %ENTITY_ALARM-6-INFO: ASSERT INFO Fa0/0 Physical Port Adm Aug 12 04:18:15.415: %ENTITY_ALARM-6-INFO: ASSERT INFO Fa0/1 Physical Port Adm Aug 12 04:18:15.499: %CRYPTO-6-ISAKMP_ON_OFF: ISAKMP is OFF Aug 12 04:18:15.499: %CRYPTO-6-GDOI_ON_OFF: GDOI is OFF Aug 12 04:18:15.599: %ENTITY_ALARM-6-INFO: ASSERT INFO Se2/0 Physical Port Adm Aug 12 04:18:15.599: %ENTITY_ALARM-6-INFO: ASSERT INFO Se2/1 Physical Port Adm Aug 12 04:18:15.599: %ENTITY_ALARM-6-INFO: ASSERT INFO Se3/0 Physical Port Adm show history all CF-734 Cisco IOS Configuration Fundamentals Command Reference April 2010 Aug 12 04:18:15.599: %ENTITY_ALARM-6-INFO: ASSERT INFO Se3/1 Physical Port Adm Aug 12 04:18:15.599: %SNMP-5-COLDSTART: SNMP agent on host Router is undergoint Aug 12 04:18:15.823: %SYS-6-BOOTTIME: Time taken to reboot after reload = 314s Aug 12 04:18:16.715: %LINK-5-CHANGED: Interface Serial2/0, changed state to adn Aug 12 04:18:16.719: %LINK-5-CHANGED: Interface FastEthernet0/0, changed staten Aug 12 04:18:16.723: %LINK-5-CHANGED: Interface FastEthernet0/1, changed staten Aug 12 04:18:16.727: %LINK-5-CHANGED: Interface Serial2/1, changed state to adn Aug 12 04:18:16.727: %LINK-5-CHANGED: Interface Serial3/0, changed state to adn Aug 12 04:18:16.727: %LINK-5-CHANGED: Interface Serial3/1, changed state to adn Aug 12 04:18:17.719: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthern Aug 12 04:18:17.723: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEther9 CMD: 'conf t' 04:18:30 UTC Wed Aug 12 2009 CMD: 'hostname 7206-3' 04:19:02 UTC Wed Aug 12 2009 CMD: 'ip host sjc-tftp02 171.69.17.17' 04:19:02 UTC Wed Aug 12 2009 CMD: 'ip host sjc-tftp01 171.69.17.19' 04:19:03 UTC Wed Aug 12 2009 CMD: 'ip host dirt 171.69.1.129' 04:19:03 UTC Wed Aug 12 2009 CMD: 'interface FastEthernet0/0' 04:19:03 UTC Wed Aug 12 2009 CMD: 'no ip proxy-arp' 04:19:03 UTC Wed Aug 12 2009 CMD: 'ip address 10.4.9.80 255.255.255.0' 04:19:03 UTC Wed Aug 12 2009 CMD: 'no shutdown' 04:19:04 UTC Wed Aug 12 2009 CMD: 'exit' 04:19:04 UTC Wed Aug 12 2009 CMD: 'ip classless' 04:19:05 UTC Wed Aug 12 2009 Aug 12 04:19:06.123: %LINK-3-UPDOWN: Interface FastEthernet0/0, changed state p *Aug 12 04:19:06.123: %ENTITY_ALARM-6-INFO: CLEAR INFO Fa0/0 Physical Port Admi9 CMD: 'ip default-network 0.0.0.0' 04:19:06 UTC Wed Aug 12 2009 CMD: 'ip default-gateway 10.4.9.1' 04:19:06 UTC Wed Aug 12 2009 CMD: 'config-register 0x2002' 04:19:07 UTC Wed Aug 12 2009 Related Commands Command Description show history Displays commands entered in the current EXEC session. show hosts CF-735 Cisco IOS Configuration Fundamentals Command Reference April 2010 show hosts To display the default domain name, the style of name lookup service, a list of name server hosts, and the cached list of hostnames and addresses specific to a particular Domain Name System (DNS) view or for all configured DNS views, use the show hosts command in privileged EXEC mode. show hosts [vrf vrf-name] [view [view-name | default] [all] [hostname | summary] Syntax Description Command Modes Privileged EXEC (#) Command History vrf vrf-name (Optional) The vrf-name argument specifies the name of the Virtual Private Network (VPN) routing and forwarding (VRF) instance associated with the DNS view whose hostname cache entries are to be displayed. Default is the global VRF (that is, the VRF whose name is a NULL string) with the specified or default DNS view. Note More than one DNS view can be associated with a VRF. To uniquely identify a DNS view, specify both the view name and the VRF with which it is associated. view view-name (Optional) The view-name argument specifies the DNS view whose hostname cache information is to be displayed. Default is the default (unnamed) DNS view associated with the specified or global VRF. Note More than one DNS view can be associated with a VRF. To uniquely identify a DNS view, specify both the view name and the VRF with which it is associated. default (Optional) Displays the default view. all (Optional) Display all the host tables. hostname (Optional) The specified hostname cache information displayed is to be limited to entries for a particular hostname. Default is the hostname cache information for all hostname entries in the cache. summary (Optional) The specified hostname cache information is to be displayed in brief summary format. Disabled by default. Release Modification 10.0 This command was introduced. 12.2T Support was added for Cisco modem user interface feature. 12.4(4)T The vrf, all, and summary keywords and vrf-name and hostname arguments were added. 12.4(9)T The view keyword and view-name argument were added. 12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA. 12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. show hosts CF-736 Cisco IOS Configuration Fundamentals Command Reference April 2010 Usage Guidelines This command displays the default domain name, the style of name lookup service, a list of name server hosts, and the cached list of hostnames and addresses specific to a particular DNS view or for all configured DNS views. If you specify the show hosts command without any optional keywords or arguments, only the entries in the global hostname cache will be displayed. If the output from this command extends beyond the bottom of the screen, press the Space bar to continue or press the Q key to terminate command output. Examples The following is sample output from the show hosts command with no parameters specified: Router# show hosts Default domain is CISCO.COM Name/address lookup uses domain service Name servers are 192.0.2.220 Host Flag Age Type Address(es) EXAMPLE1.CISCO.COM (temp, OK) 1 IP 192.0.2.10 EXAMPLE2.CISCO.COM (temp, OK) 8 IP 192.0.2.50 EXAMPLE3.CISCO.COM (temp, OK) 8 IP 192.0.2.115 EXAMPLE4.CISCO.COM (temp, EX) 8 IP 192.0.2.111 EXAMPLE5.CISCO.COM (temp, EX) 0 IP 192.0.2.27 EXAMPLE6.CISCO.COM (temp, EX) 24 IP 192.0.2.30 The following is sample output from the show hosts command that specifies the VRF vpn101: Router# show hosts vrf vpn101 Default domain is example.com Domain list: example1.com, example2.com, example3.com Name/address lookup uses domain service Name servers are 192.0.2.204, 192.0.2.205, 192.0.2.206 Codes: UN - unknown, EX - expired, OK - OK, ?? - revalidate temp - temporary, perm - permanent NA - Not Applicable None - Not defined Host Port Flags Age Type Address(es) user None (perm, OK) 0 IP 192.0.2.001 www.example.com None (perm, OK) 0 IP 192.0.2.111 192.0.2.112 Table 91 describes the significant fields shown in the display. Table 91 show hosts Field Descriptions Field Description Default domain Default domain name to be used to complete unqualified names if no domain list is defined. Domain list List of default domain names to be tried in turn to complete unqualified names. Name/address lookup Style of name lookup service. Name servers List of name server hosts. show hosts CF-737 Cisco IOS Configuration Fundamentals Command Reference April 2010 Related Commands Host Learned or statically defined hostname. Statically defined hostname-to-address mappings can be added to the DNS hostname cache for a DNS view by using the ip hosts command. Port TCP port number to connect to when using the defined hostname in conjunction with an EXEC connect or Telnet command. Flags Indicates additional information about the hostname-to-IP address mapping. Possible values are as follows: • EX—Entries marked EX are expired. • OK—Entries marked OK are believed to be valid. • perm—A permanent entry is entered by a configuration command and is not timed out. • temp—A temporary entry is entered by a name server; the Cisco IOS software removes the entry after 72 hours of inactivity. • ??—Entries marked ?? are considered suspect and subject to revalidation. Age Number of hours since the software last referred to the cache entry. Type Type of address. For example, IP, Connectionless Network Service (CLNS), or X.121. If you have used the ip hp-host global configuration command, the show hosts command will display these hostnames as type HP-IP. Address(es) IP address of the host. One host may have up to eight addresses. Table 91 show hosts Field Descriptions (continued) Field Description Command Description clear host Removes static hostname-to-address mappings from the hostname cache for the specified DNS view or all DNS views. ip host Defines static hostname-to-address mappings in the DNS hostname cache for a DNS view. show html CF-738 Cisco IOS Configuration Fundamentals Command Reference April 2010 show html To display module and port information, use the show html command in privileged EXEC mode. show html {module [ports [l2]] | port [all | l2 | l3] [shortnames]} {command line | count | names | options} Syntax Description Command Modes Privileged EXEC (#) Command History Usage Guidelines Use the show html command to display module and port information. Examples The following is sample output from the show html command using the port and names keywords. The field descriptions are self-explanatory. Router# show html port names this[0] = "FastEthernet0/0"; this[1] = "FastEthernet0/1"; this[2] = "Serial2/0"; this[3] = "Serial2/1"; module Displays module information. ports (Optional) Displays the number of ports on the module. l2 (Optional) Displays information about the Layer2 (l2) module. port Displays port information. all (Optional)Displays information about the Layer 2 and Layer 3 modules. l2 (Optional) Displays information about the Layer2 (l2) module. l3 (Optional) Displays information about the Layer3 (l3) module. shortnames (Optional) Displays port short names. command Displays execute command over ports information. line Displays command to execute over modules information. count Displays the module count. names Displays the module names. options Displays the module options. Release Modification 12.4(24)T This command was introduced in a release earlier than Cisco IOS Release 12.4(24)T. 12.2(33)SXI This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SXI. 12.2(33)SRC This command was integrated into a release earlier than Cisco IOS Release 12.2(33)SRC. show html CF-739 Cisco IOS Configuration Fundamentals Command Reference April 2010 this[4] = "Serial3/0"; this[5] = "Serial3/0.1"; this[6] = "Serial3/1"; this[7] = "Tunnel0"; this[8] = "Tunnel1"; this[9] = "Tunnel2"; this[10] = "Tunnel3"; this[11] = "Virtual-Access1"; this[12] = "Virtual-Template1"; this[13] = "vmi1"; this[14] = "vmi2"; The following is sample output from the show html command using the port, all, and options keywords. The ouput is self-explanatory. Router# show html port all options