Command Reference Cisco
Uploaded by
Ngurah AgadisaCommand Reference Cisco
Uploaded by
Ngurah AgadisaCommand Reference, Cisco IOS XE Cupertino 17.7.
x (Catalyst 9300
Switches)
First Published: 2021-12-07
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
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.
The documentation set for this product strives to use bias-free language. For purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on
age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that
is hardcoded in the user interfaces of the product software, language used based on standards documentation, or language that is used by a referenced third-party product.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
https://www.cisco.com/c/en/us/about/legal/trademarks.html. 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)
© 2021 Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1 Using the Command-Line Interface 1
Using the Command-Line Interface 2
Understanding Command Modes 2
Understanding the Help System 3
Understanding Abbreviated Commands 4
Understanding no and default Forms of Commands 4
Understanding CLI Error Messages 5
Using Configuration Logging 5
Using Command History 5
Changing the Command History Buffer Size 5
Recalling Commands 6
Disabling the Command History Feature 6
Using Editing Features 7
Enabling and Disabling Editing Features 7
Editing Commands through Keystrokes 7
Editing Command Lines that Wrap 9
Searching and Filtering Output of show and more Commands 10
Accessing the CLI 10
Accessing the CLI through a Console Connection or through Telnet 11
PART I Cisco SD-Access 13
CHAPTER 2 Cisco SD-Access Commands 15
broadcast-underlay 17
database-mapping 18
dynamic-eid 21
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
iii
Contents
eid-record-provider 22
eid-record-subscriber 23
eid-table 24
encapsulation 26
etr 27
etr map-server 28
extranet 29
first-packet-petr 30
instance-id 32
ip pim lisp core-group-range 33
ip pim lisp transport multicast 34
ip pim rp-address 35
ip pim sparse mode 36
ipv4 multicast multitopology 37
ip pim ssm 38
itr 39
itr map-resolver 40
locator default-set 41
locator-set 42
map-cache 43
map-cache extranet 44
prefix-list 45
route-import database 46
service 48
show lisp instance-id ipv4 database 49
show lisp instance-id ipv6 database 51
show lisp instance-id ipv4 map-cache 52
show lisp instance-id ipv6 map-cache 58
show lisp instance-id ipv4 server 60
show lisp instance-id ipv6 server 62
show lisp instance-id ipv4 statistics 63
show lisp instance-id ipv6 statistics 64
show lisp prefix-list 65
show lisp session 66
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
iv
Contents
use-petr 67
PART II Cisco TrustSec 69
CHAPTER 3 Cisco TrustSec Commands 71
address (CTS) 73
clear cts environment-data 74
clear cts policy-server statistics 75
content-type json 76
cts authorization list 77
cts change-password 78
cts credentials 79
cts environment-data enable 81
cts policy-server device-id 82
cts policy-server name 83
cts policy-server order random 84
cts policy-server username 85
cts refresh 86
cts rekey 88
cts role-based enforcement 89
cts role-based l2-vrf 90
cts role-based monitor 92
cts role-based permissions 93
cts role-based sgt-caching 95
cts role-based sgt-map 96
cts sxp connection peer 98
cts sxp default password 101
cts sxp default source-ip 103
cts sxp filter-enable 105
cts sxp filter-group 106
cts sxp filter-list 108
cts sxp log binding-changes 110
cts sxp reconciliation period 111
cts sxp retry period 112
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
v
Contents
debug cts environment-data 113
debug cts policy-server 115
port (CTS) 116
propagate sgt (cts manual) 117
retransmit (CTS) 119
sap mode-list (cts manual) 120
show cts credentials 122
show cts environment-data 123
show cts interface 124
show cts policy-server 126
show cts role-based counters 129
show cts role-based permissions 131
show cts server-list 133
show cts sxp 135
show platform hardware fed switch active fwd-asic resource tcam utilization 138
show platform hardware fed switch active sgacl resource usage 140
show platform software classification switch active F0 class-group-manager class-group client acl
all 141
show platform software cts forwarding-manager switch active F0 port 142
show platform software cts forwarding-manager switch active F0 146
show platform software cts forwarding-manager switch active F0 permissions 147
show platform software fed switch active acl counters hardware | inc SGACL 149
show platform software fed switch active acl usage 150
show platform software fed switch active ifm mappings 151
show platform software fed switch active ip route 153
show platform software fed switch active sgacl detail 155
show platform software fed switch active sgacl port 156
show platform software fed switch active sgacl vlan 158
show platform software status control-processor brief 159
show monitor capture <name> buffer 160
timeout (CTS) 161
tls server-trustpoint 162
PART III Interface and Hardware Components 163
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
vi
Contents
CHAPTER 4 Interface and Hardware Commands 165
bluetooth pin 168
clear macro auto configuration 169
device classifier 170
debug ilpower 171
debug interface 172
debug lldp packets 173
debug platform poe 174
debug platform software fed switch active punt packet-capture start 175
duplex 176
errdisable detect cause 178
errdisable recovery cause 180
errdisable recovery cause 182
hw-module beacon 184
hw-module switch upoe-plus 185
interface 186
interface range 189
ip mtu 192
ipv6 mtu 193
lldp (interface configuration) 194
logging event power-inline-status 196
macro 197
macro auto 200
macro auto apply (Cisco IOS shell scripting capability) 203
macro auto config (Cisco IOS shell scripting capability) 205
macro auto control 206
macro auto execute 208
macro auto global control 215
macro auto global processing 217
macro auto mac-address-group 218
macro auto processing 220
macro auto sticky 221
macro auto trigger 222
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
vii
Contents
macro description 223
macro global 224
macro global description 226
mdix auto 227
mode (power-stack configuration) 228
monitoring 230
network-policy 231
network-policy profile (global configuration) 232
platform usb disable 233
power-priority 234
power inline 236
power inline police 239
power supply 241
power supply autoLC shutdown 243
shell trigger 244
show beacon all 245
show device classifier attached 246
show device classifier clients 248
show device classifier profile type 249
show environment 252
show errdisable detect 254
show errdisable recovery 256
show ip interface 257
show interfaces 262
show interfaces counters 268
show interfaces switchport 270
show interfaces transceiver 272
show inventory 276
show macro auto 279
show memory platform 282
show module 285
show mgmt-infra trace messages ilpower 286
show mgmt-infra trace messages ilpower-ha 288
show mgmt-infra trace messages platform-mgr-poe 289
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
viii
Contents
show network-policy profile 290
show parser macro 291
show platform hardware bluetooth 294
show platform hardware fed switch forward 295
show platform hardware fed switch forward interface 298
show platform hardware fed switch forward last summary 301
show platform hardware fed switch fwd-asic counters tla 304
show platform hardware fed active fwd-asic resource tcam utilization 308
show platform resources 310
show platform software audit 311
show platform software fed switch punt cpuq rates 315
show platform software fed switch punt packet-capture display 317
show platform software fed switch punt packet-capture cpu-top-talker 319
show platform software fed switch punt rates interfaces 322
show platform software ilpower 325
show platform software memory 327
show platform software process list 332
show platform software process memory 336
show platform software process slot switch 339
show platform software status control-processor 341
show platform software thread list 344
show platform usb status 346
show processes cpu platform 347
show processes cpu platform history 350
show processes cpu platform monitor 353
show processes memory 355
show processes memory platform 358
show processes platform 362
show power inline 365
show stack-power 371
show shell 373
show system mtu 376
show tech-support 377
show tech-support bgp 379
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
ix
Contents
show tech-support diagnostic 382
show tech-support poe 387
speed 417
stack-power 419
switchport block 421
system mtu 422
tlv-type (device classifier condition) 423
voice-signaling vlan (network-policy configuration) 425
voice vlan (network-policy configuration) 427
PART IV IP Addressing Services 429
CHAPTER 5 IP Addressing Services Commands 431
clear ip nhrp 436
clear ipv6 access-list 437
clear ipv6 dhcp 438
clear ipv6 dhcp binding 439
clear ipv6 dhcp client 440
clear ipv6 dhcp conflict 441
clear ipv6 dhcp relay binding 442
clear ipv6 eigrp 443
clear ipv6 mfib counters 444
clear ipv6 mld counters 445
clear ipv6 mld traffic 446
clear ipv6 mtu 447
clear ipv6 multicast aaa authorization 448
clear ipv6 nd destination 449
clear ipv6 nd on-link prefix 450
clear ipv6 nd router 451
clear ipv6 neighbors 452
clear ipv6 nhrp 454
clear ipv6 ospf 455
clear ipv6 ospf counters 456
clear ipv6 ospf events 458
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
x
Contents
clear ipv6 pim reset 459
clear ipv6 pim topology 460
clear ipv6 pim traffic 461
clear ipv6 prefix-list 462
clear ipv6 rip 463
clear ipv6 route 464
clear ipv6 spd 465
debug nhrp 466
fhrp delay 468
fhrp version vrrp v3 469
ip address dhcp 470
ip address pool (DHCP) 473
ip address 474
ip nat inside source 476
ip nat outside source 481
ip nat pool 484
ip nat translation max-entries 486
ip nat translation (timeout) 487
ip nhrp map 489
ip nhrp map multicast 491
ip nhrp network-id 492
ip nhrp nhs 493
ip wccp 495
ipv6 access-list 500
ipv6 address-validate 503
ipv6 cef 504
ipv6 cef accounting 506
ipv6 cef distributed 508
ipv6 cef load-sharing algorithm 510
ipv6 cef optimize neighbor resolution 511
ipv6 destination-guard policy 512
ipv6 dhcp-relay bulk-lease 513
ipv6 dhcp-relay option vpn 514
ipv6 dhcp-relay source-interface 515
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xi
Contents
ipv6 dhcp binding track ppp 516
ipv6 dhcp database 517
ipv6 dhcp iana-route-add 519
ipv6 dhcp iapd-route-add 520
ipv6 dhcp-ldra 521
ipv6 dhcp ping packets 522
ipv6 dhcp pool 523
ipv6 dhcp server vrf enable 525
ipv6 flow monitor 526
ipv6 general-prefix 527
ipv6 local policy route-map 529
ipv6 local pool 531
ipv6 mld snooping (global) 533
ipv6 mld ssm-map enable 534
ipv6 mld state-limit 535
ipv6 multicast-routing 536
ipv6 multicast group-range 537
ipv6 multicast pim-passive-enable 539
ipv6 multicast rpf 540
ipv6 nd cache expire 541
ipv6 nd cache interface-limit (global) 542
ipv6 nd host mode strict 543
ipv6 nd na glean 544
ipv6 nd ns-interval 545
ipv6 nd nud retry 546
ipv6 nd reachable-time 548
ipv6 nd resolution data limit 549
ipv6 nd route-owner 550
ipv6 neighbor 551
ipv6 ospf name-lookup 553
ipv6 pim 554
ipv6 pim accept-register 555
ipv6 pim allow-rp 556
ipv6 pim neighbor-filter list 557
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xii
Contents
ipv6 pim rp-address 558
ipv6 pim rp embedded 561
ipv6 pim spt-threshold infinity 562
ipv6 prefix-list 563
ipv6 source-guard attach-policy 566
ipv6 source-route 567
ipv6 spd mode 568
ipv6 spd queue max-threshold 569
ipv6 traffic interface-statistics 570
ipv6 unicast-routing 571
key chain 572
key-string (authentication) 573
key 574
show ip nat translations 575
show ip nhrp nhs 578
show ip ports all 581
show ip wccp 583
show ipv6 access-list 597
show ipv6 destination-guard policy 600
show ipv6 dhcp 601
show ipv6 dhcp binding 602
show ipv6 dhcp conflict 605
show ipv6 dhcp database 606
show ipv6 dhcp guard policy 608
show ipv6 dhcp interface 610
show ipv6 dhcp relay binding 612
show ipv6 eigrp events 614
show ipv6 eigrp interfaces 616
show ipv6 eigrp topology 618
show ipv6 eigrp traffic 620
show ipv6 general-prefix 622
show ipv6 interface 623
show ipv6 mfib 631
show ipv6 mld groups 637
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xiii
Contents
show ipv6 mld interface 640
show ipv6 mld snooping 642
show ipv6 mld ssm-map 644
show ipv6 mld traffic 646
show ipv6 mrib client 648
show ipv6 mrib route 650
show ipv6 mroute 652
show ipv6 mtu 656
show ipv6 nd destination 658
show ipv6 nd on-link prefix 659
show ipv6 neighbors 660
show ipv6 nhrp 664
show ipv6 ospf 667
show ipv6 ospf border-routers 671
show ipv6 ospf event 673
show ipv6 ospf graceful-restart 676
show ipv6 ospf interface 678
show ipv6 ospf request-list 683
show ipv6 ospf retransmission-list 685
show ipv6 ospf statistics 687
show ipv6 ospf summary-prefix 689
show ipv6 ospf timers rate-limit 690
show ipv6 ospf traffic 691
show ipv6 ospf virtual-links 695
show ipv6 pim anycast-RP 697
show ipv6 pim bsr 698
show ipv6 pim df 700
show ipv6 pim group-map 702
show ipv6 pim interface 704
show ipv6 pim join-prune statistic 706
show ipv6 pim limit 707
show ipv6 pim neighbor 708
show ipv6 pim range-list 710
show ipv6 pim topology 712
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xiv
Contents
show ipv6 pim traffic 714
show ipv6 pim tunnel 716
show ipv6 policy 718
show ipv6 prefix-list 719
show ipv6 protocols 722
show ipv6 rip 725
show ipv6 route 730
show ipv6 routers 734
show ipv6 rpf 737
show ipv6 source-guard policy 739
show ipv6 spd 740
show ipv6 static 741
show ipv6 traffic 745
show key chain 748
show track 749
track 751
vrrp 753
vrrp description 754
vrrp preempt 755
vrrp priority 756
vrrp timers advertise 757
vrrs leader 759
PART V IP Multicast Routing 761
CHAPTER 6 IP Multicast Routing Commands 763
clear ip mfib counters 765
clear ip mroute 766
debug condition vrf 767
debug ip pim 768
debug ipv6 pim 770
ip igmp filter 772
ip igmp max-groups 773
ip igmp profile 775
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xv
Contents
ip igmp snooping 776
ip igmp snooping last-member-query-count 777
ip igmp snooping querier 779
ip igmp snooping report-suppression 781
ip igmp snooping vlan mrouter 782
ip igmp snooping vlan static 783
ip multicast auto-enable 784
ip multicast-routing 785
ip pim accept-register 786
ip pim bidir-enable 787
ip pim bsr-candidate 788
ip pim rp-address 790
ip pim rp-candidate 792
ip pim send-rp-announce 793
ip pim spt-threshold 795
match message-type 796
match service-type 797
match service-instance 798
mrinfo 799
service-policy-query 801
service-policy 802
show ip igmp filter 803
show ip igmp profile 804
show ip igmp snooping 805
show ip igmp snooping groups 807
show ip igmp snooping mrouter 809
show ip igmp snooping querier 810
show ip mroute 812
show ip pim autorp 820
show ip pim bsr-router 822
show ip pim bsr 823
show ip pim interface df 824
show ip pim rp 826
show ip pim tunnel 829
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xvi
Contents
show platform software fed switch ip multicast groups 831
show platform software fed switch ip multicast 832
show platform software fed switch ip multicast df 835
PART VI Layer 2/3 837
CHAPTER 7 Layer 2/3 Commands 839
avb 842
channel-group 844
channel-protocol 847
clear l2protocol-tunnel counters 848
clear lacp 849
clear pagp 850
clear spanning-tree counters 851
clear spanning-tree detected-protocols 852
debug etherchannel 853
debug lacp 854
debug pagp 855
debug platform pm 856
debug platform udld 857
debug spanning-tree 858
instance (VLAN) 860
interface port-channel 862
l2protocol-tunnel 864
lacp fast-switchover 867
lacp max-bundle 869
lacp port-priority 870
lacp rate 871
lacp system-priority 872
loopdetect 873
mvrp vlan creation 875
mvrp registration 876
mvrp timer 878
name (MST) 880
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xvii
Contents
no ptp enable 881
pagp learn-method 882
pagp port-priority 884
peer (PTP) 885
policy-map 886
port-channel 888
port-channel auto 889
port-channel load-balance 890
port-channel load-balance extended 892
port-channel min-links 894
ptp dot1as extend property 895
ptp ip dscp 896
ptp priority1 value 897
ptp priority2 value 898
ptp profile dot1as 899
ptp property 900
ptp role primary 901
rep admin vlan 902
rep block port 903
rep lsl-age-timer 905
rep lsl-retries 906
rep preempt delay 907
rep preempt segment 908
rep segment 909
rep stcn 911
revision 912
show avb domain 913
show avb streams 915
show dot1q-tunnel 916
show etherchannel 917
show interfaces rep detail 920
show l2protocol-tunnel 921
show lacp 923
show loopdetect 927
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xviii
Contents
show msrp port bandwidth 928
show msrp streams 930
show pagp 932
show platform etherchannel 934
show platform hardware fed active vlan ingress 935
show platform pm 936
show platform software fed active ptp interface loopback 937
show platform software fed switch ptp 938
show ptp brief 940
show ptp clock 941
show ptp parent 942
show ptp port 944
show ptp port loopback 945
show ptp transport properties 946
show rep topology 947
show spanning-tree 949
show spanning-tree mst 955
show udld 958
show vlan dot1q tag native 962
source ip interface 963
spanning-tree backbonefast 964
spanning-tree bpdufilter 965
spanning-tree bpduguard 967
spanning-tree bridge assurance 969
spanning-tree cost 970
spanning-tree etherchannel guard misconfig 972
spanning-tree extend system-id 974
spanning-tree guard 975
spanning-tree link-type 976
spanning-tree loopguard default 978
spanning-tree mode 979
spanning-tree mst 980
spanning-tree mst configuration 981
spanning-tree mst forward-time 983
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xix
Contents
spanning-tree mst hello-time 984
spanning-tree mst max-age 985
spanning-tree mst max-hops 986
spanning-tree mst pre-standard 987
spanning-tree mst priority 989
spanning-tree mst root 990
spanning-tree mst simulate pvst global 991
spanning-tree pathcost method 992
spanning-tree port-priority 993
spanning-tree portfast edge bpdufilter default 995
spanning-tree portfast edge bpduguard default 997
spanning-tree portfast default 998
spanning-tree transmit hold-count 1000
spanning-tree uplinkfast 1001
spanning-tree vlan 1002
switchport 1005
switchport access vlan 1006
switchport mode 1007
switchport nonegotiate 1009
switchport trunk 1010
switchport voice vlan 1013
transport unicast ipv4 local loopback 1016
udld 1017
udld port 1019
udld reset 1021
vlan dot1q tag native 1022
vtp mode 1023
PART VII Multiprotocol Label Switching 1025
CHAPTER 8 MPLS Commands 1027
autodiscovery 1029
backup peer 1031
encapsulation mpls 1032
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xx
Contents
ip multicast mrinfo-filter 1033
ip multicast-routing 1034
l2 vfi autodiscovery 1035
l2 vfi manual 1036
l2vpn vfi context 1038
l2vpn xconnect context 1039
label mode 1040
load-balance 1041
mdt log-reuse 1043
mdt default 1044
mdt data 1046
member (l2vpn vfi) 1048
member pseudowire 1049
mpls label range 1051
mpls label protocol (interface configuration) 1054
mpls label protocol (global configuration) 1055
mpls ldp logging neighbor-changes 1056
mpls ip (interface configuration) 1057
mpls ip (global configuration) 1058
mpls ip default-route 1059
neighbor (MPLS) 1060
show ip pim mdt send 1061
show ip pim mdt receive 1062
show ip pim mdt history 1064
show ip pim mdt bgp 1065
show mpls label range 1066
show mpls ldp bindings 1067
show mpls ldp discovery 1069
show mpls ldp neighbor 1071
show mpls forwarding-table 1072
show mpls static binding 1080
show mpls static crossconnect 1082
mpls static binding ipv4 1083
show platform hardware fed (TCAM utilization) 1085
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxi
Contents
show platform software fed switch l2vpn 1088
show platform software fed switch mpls 1090
show platform software l2vpn switch 1092
source template type pseudowire 1094
tunnel destination 1095
tunnel mpls-ip-only 1096
tunnel source 1097
xconnect 1099
PART VIII Network Management 1101
CHAPTER 9 Network Management Commands 1103
active-timeout 1107
cache 1108
clear flow exporter 1110
clear flow monitor 1111
clear platform software fed switch swc connection 1113
clear platform software fed switch swc statistics 1114
clear snmp stats hosts 1115
collect 1116
collect counter 1117
collect flow sampler 1118
collect interface 1119
collect ipv4 destination 1120
collect ipv6 destination 1121
collect ipv4 source 1122
collect ipv6 source 1124
collect timestamp absolute 1126
collect transport tcp flags 1127
collect routing next-hop address 1128
datalink flow monitor 1129
debug flow exporter 1130
debug flow monitor 1131
debug flow record 1132
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxii
Contents
debug sampler 1133
description 1134
description (ERSPAN) 1135
destination (ERSPAN) 1136
destination 1141
dscp 1142
et-analytics 1143
et-analytics enable 1144
event manager applet 1145
export-protocol netflow-v9 1148
export-protocol netflow-v5 1149
exporter 1150
fconfigure 1151
filter (ERSPAN) 1152
flow exporter 1154
flow monitor 1155
flow record 1156
header-type 1157
inactive time 1158
ip flow-export destination 1159
ip wccp 1160
ip flow monitor 1162
ipv6 flow monitor 1164
ipv6 deny echo reply 1166
match datalink ethertype 1167
match datalink mac 1168
match datalink vlan 1169
match device-type 1170
match flow cts 1171
match flow direction 1172
match interface 1173
match ipv4 1174
match ipv4 destination address 1175
match ipv4 source address 1176
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxiii
Contents
match ipv4 ttl 1177
match ipv6 1178
match ipv6 destination address 1179
match ipv6 hop-limit 1180
match ipv6 source address 1181
map platform-type 1182
match transport 1183
match transport icmp ipv4 1184
match transport icmp ipv6 1185
match platform-type 1186
mode random 1 out-of 1187
monitor capture (interface/control plane) 1188
monitor capture buffer 1190
monitor capture clear 1191
monitor capture export 1192
monitor capture file 1193
monitor capture limit 1195
monitor capture match 1196
monitor capture pktlen-range 1197
monitor capture start 1198
monitor capture stop 1199
monitor session 1200
monitor session destination 1202
monitor session filter 1206
monitor session source 1208
monitor session type 1210
option 1212
record 1214
sensor-name (stealthwatch-cloud-monitor) 1215
service-key (stealthwatch-cloud-monitor) 1216
show flow monitor etta-mon cache 1217
sampler 1218
show capability feature monitor 1219
show class-map type control subscriber 1220
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxiv
Contents
show flow exporter 1221
show flow interface 1223
show flow monitor 1225
show flow record 1227
show ip sla statistics 1228
show monitor 1230
show monitor capture 1232
show monitor session 1234
show parameter-map type subscriber attribute-to-service 1236
show platform software et-analytics 1237
show platform software fed switch active fnf et-analytics-flow-dump 1238
show platform software fed switch ip wccp 1239
show platform software fed switch swc connection 1241
show platform software fed switch swc statistics 1243
show platform software swspan 1245
show sampler 1247
show snmp stats 1249
show stealth-watch-cloud detail 1251
shutdown (monitor session) 1252
snmp ifmib ifindex persist 1253
snmp-server community 1254
snmp-server enable traps 1256
snmp-server enable traps bridge 1259
snmp-server enable traps bulkstat 1260
snmp-server enable traps call-home 1261
snmp-server enable traps cef 1262
snmp-server enable traps cpu 1263
snmp-server enable traps envmon 1264
snmp-server enable traps errdisable 1265
snmp-server enable traps flash 1266
snmp-server enable traps isis 1267
snmp-server enable traps license 1268
snmp-server enable traps mac-notification 1269
snmp-server enable traps ospf 1270
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxv
Contents
snmp-server enable traps pim 1271
snmp-server enable traps port-security 1272
snmp-server enable traps power-ethernet 1273
snmp-server enable traps snmp 1274
snmp-server enable traps stackwise 1275
snmp-server enable traps storm-control 1277
snmp-server enable traps stpx 1278
snmp-server enable traps transceiver 1279
snmp-server enable traps vrfmib 1280
snmp-server enable traps vstack 1281
snmp-server engineID 1282
snmp-server group 1283
snmp-server host 1287
snmp-server manager 1292
snmp-server user 1293
snmp-server view 1297
source 1299
source (ERSPAN) 1301
socket 1302
stealthwatch-cloud-monitor 1303
switchport mode access 1304
switchport voice vlan 1305
ttl 1306
transport 1307
template data timeout 1308
udp peek 1309
url (stealthwatch-cloud-monitor) 1310
PART IX QoS 1311
CHAPTER 10 QoS Commands 1313
auto qos classify 1314
auto qos trust 1316
auto qos video 1323
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxvi
Contents
auto qos voip 1333
class 1347
class-map 1349
debug auto qos 1351
match (class-map configuration) 1352
policy-map 1355
priority 1357
qos stack-buffer 1359
qos queue-softmax-multiplier 1360
queue-buffers ratio 1361
queue-limit 1362
random-detect cos 1364
random-detect cos-based 1365
random-detect dscp 1366
random-detect dscp-based 1368
random-detect precedence 1369
random-detect precedence-based 1371
service-policy (Wired) 1372
set 1374
show auto qos 1380
show class-map 1382
show platform hardware fed switch 1383
show platform software fed switch qos 1386
show platform software fed switch qos qsb 1387
show policy-map 1390
show tech-support qos 1392
trust device 1394
PART X Routing 1397
CHAPTER 11 IP Routing Commands 1399
accept-lifetime 1401
address-family ipv6 (OSPF) 1404
address-family l2vpn 1405
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxvii
Contents
aggregate-address 1408
area nssa 1411
area virtual-link 1413
auto-summary (BGP) 1416
authentication (BFD) 1419
bfd 1420
bfd all-interfaces 1422
bfd check-ctrl-plane-failure 1423
bfd echo 1424
bfd slow-timers 1426
bfd template 1428
bfd-template single-hop 1429
bgp graceful-restart 1430
clear proximity ip bgp 1432
default-information originate (OSPF) 1436
default-metric (BGP) 1438
distance (OSPF) 1440
eigrp log-neighbor-changes 1443
ip authentication key-chain eigrp 1445
ip authentication mode eigrp 1446
ip bandwidth-percent eigrp 1447
ip cef load-sharing algorithm 1448
ip community-list 1449
ip prefix-list 1454
ip hello-interval eigrp 1457
ip hold-time eigrp 1458
ip load-sharing 1459
ip network-broadcast 1460
ip ospf database-filter all out 1461
ip ospf name-lookup 1462
ip split-horizon eigrp 1463
ip summary-address eigrp 1464
ip route static bfd 1466
ipv6 route static bfd 1468
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxviii
Contents
metric weights (EIGRP) 1469
neighbor advertisement-interval 1471
neighbor default-originate 1473
neighbor description 1475
neighbor ebgp-multihop 1476
neighbor maximum-prefix (BGP) 1477
neighbor peer-group (assigning members) 1479
neighbor peer-group (creating) 1481
neighbor route-map 1484
neighbor update-source 1486
network (BGP and multiprotocol BGP) 1488
network (EIGRP) 1490
nsf (EIGRP) 1492
offset-list (EIGRP) 1494
redistribute (IP) 1496
redistribute (IPv6) 1504
redistribute maximum-prefix (OSPF) 1507
rewrite-evpn-rt-asn 1509
route-map 1510
router-id 1513
router bgp 1514
router eigrp 1517
router ospf 1518
router ospfv3 1520
send-lifetime 1521
set community 1524
set ip next-hop (BGP) 1526
show ip bgp 1528
show ip bgp neighbors 1540
show ip bgp ipv6 unicast 1555
show ip eigrp interfaces 1557
show ip eigrp neighbors 1560
show ip eigrp topology 1563
show ip eigrp traffic 1568
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxix
Contents
show ip ospf 1570
show ip ospf border-routers 1578
show ip ospf database 1579
show ip ospf interface 1588
show ip ospf neighbor 1591
show ip ospf virtual-links 1597
summary-address (OSPF) 1598
timers throttle spf 1600
PART XI Security 1603
CHAPTER 12 Security 1605
aaa accounting 1609
aaa accounting dot1x 1612
aaa accounting identity 1614
aaa authentication dot1x 1616
aaa authorization 1618
aaa new-model 1622
access-session mac-move deny 1624
access-session host-mode multi-host 1626
action 1628
api-key (Parameter Map) 1629
authentication host-mode 1630
authentication logging verbose 1632
authentication mac-move permit 1633
authentication priority 1635
authentication timer reauthenticate 1637
authentication violation 1639
cisp enable 1641
clear aaa cache group 1642
clear device-tracking database 1643
clear errdisable interface vlan 1647
clear fqdn 1648
clear mac address-table 1649
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxx
Contents
confidentiality-offset 1651
crypto pki trustpool import 1652
debug aaa cache group 1655
debug aaa dead-criteria transaction 1656
debug umbrella 1658
delay-protection 1659
deny (MAC access-list configuration) 1660
device-role (IPv6 snooping) 1663
device-role (IPv6 nd inspection) 1664
device-role (IPv6 nd inspection) 1665
device-tracking (interface config) 1666
device-tracking (VLAN config) 1669
device-tracking binding 1672
device-tracking logging 1692
device-tracking policy 1696
device-tracking tracking 1709
device-tracking upgrade-cli 1713
dnscrypt (Parameter Map) 1716
dot1x authenticator eap profile 1717
dot1x critical (global configuration) 1718
dot1x logging verbose 1719
dot1x max-start 1720
dot1x pae 1721
dot1x supplicant controlled transient 1722
dot1x supplicant force-multicast 1723
dot1x test eapol-capable 1724
dot1x test timeout 1725
dot1x timeout 1726
dscp 1728
dtls 1729
enable password 1731
enable secret 1733
epm access-control open 1736
fqdn ttl-timeout factor 1737
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxi
Contents
include-icv-indicator 1738
ip access-list 1739
ip access-list role-based 1742
ip admission 1743
ip admission name 1744
ip dhcp snooping database 1746
ip dhcp snooping information option format remote-id 1748
ip dhcp snooping verify no-relay-agent-address 1749
ip http access-class 1750
ip radius source-interface 1752
ip source binding 1754
ip ssh source-interface 1755
ip verify source 1756
ipv6 access-list 1757
ipv6 snooping policy 1759
key chain macsec 1760
key config-key password-encrypt 1761
key-server 1763
limit address-count 1764
local-domain (Parameter Map) 1765
mab logging verbose 1766
mab request format attribute 32 1767
macsec-cipher-suite 1769
macsec network-link 1771
match (access-map configuration) 1772
mka pre-shared-key 1774
mka suppress syslogs sak-rekey 1775
orgid (Parameter Map) 1776
parameter-map type regex 1777
parameter-map type umbrella global 1780
password encryption aes 1781
pattern (Parameter Map) 1783
permit (MAC access-list configuration) 1785
protocol (IPv6 snooping) 1788
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxii
Contents
radius server 1789
radius-server dscp 1791
radius-server dead-criteria 1792
radius-server deadtime 1794
radius-server directed-request 1796
radius-server domain-stripping 1798
sak-rekey 1802
secret (Parameter Map) 1803
security level (IPv6 snooping) 1804
security passthru 1805
send-secure-announcements 1806
server-private (RADIUS) 1807
server-private (TACACS+) 1809
show aaa cache group 1811
show aaa clients 1813
show aaa command handler 1814
show aaa dead-criteria 1815
show aaa local 1817
show aaa servers 1819
show aaa sessions 1820
show access-lists fqdn statistics 1821
show authentication brief 1822
show authentication history 1825
show authentication sessions 1826
show device-tracking capture-policy 1829
show device-tracking counters 1831
show device-tracking database 1833
show device-tracking events 1838
show device-tracking features 1840
show device-tracking messages 1841
show device-tracking policies 1842
show device-tracking policy 1843
show dot1x 1844
show cisp 1846
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxiii
Contents
show eap pac peer 1848
show fqdn 1849
show ip access-lists 1851
show ip dhcp snooping statistics 1854
show platform software dns-umbrella statistics 1857
show platform software umbrella switch F0 1858
show radius server-group 1860
show storm-control 1862
show tech-support acl 1864
show tech-support identity 1868
show umbrella 1877
show vlan access-map 1879
show vlan filter 1880
show vlan group 1881
ssci-based-on-sci 1882
storm-control 1883
switchport port-security aging 1886
switchport port-security mac-address 1888
switchport port-security maximum 1891
switchport port-security violation 1893
tacacs server 1895
tls 1896
token (Parameter Map) 1898
tracking (IPv6 snooping) 1899
trusted-port 1901
umbrella 1902
use-updated-eth-header 1903
username 1904
vlan access-map 1909
vlan dot1Q tag native 1911
vlan filter 1912
vlan group 1913
PART XII Stack Manager and High Availability 1915
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxiv
Contents
CHAPTER 13 Stack Manager and High Availability Commands 1917
debug platform stack-manager 1918
maintenance-template 1919
main-cpu 1920
mode sso 1921
policy config-sync prc reload 1922
redundancy 1923
redundancy config-sync mismatched-commands 1924
redundancy force-switchover 1926
redundancy reload 1927
reload 1928
router routing protocol shutdown l2 1930
session 1931
show redundancy 1932
show redundancy config-sync 1936
show switch 1938
show switch stack-mode 1941
show switch stack-bandwidth 1942
show switch stack-ring speed 1943
show tech-support stack 1944
stack-mac persistent timer 1950
stack-mac update force 1952
standby console enable 1953
start maintenance 1954
stop maintenance 1955
switch clear stack-mode 1956
switch priority 1957
switch provision 1958
switch renumber 1960
switch renumber 1961
switch stack port 1962
switch stack-speed 1963
switch switch-number role 1964
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxv
Contents
system mode maintenance 1965
PART XIII System Management 1967
CHAPTER 14 System Management Commands 1969
arp 1972
boot 1973
cat 1974
copy 1975
copy startup-config tftp: 1976
copy tftp: startup-config 1977
debug voice diagnostics mac-address 1978
debug platform condition feature multicast controlplane 1979
debug platform condition mac 1981
debug platform rep 1982
debug ilpower powerman 1983
delete 1986
dir 1987
emergency-install 1989
exit 1991
factory-reset 1992
flash_init 1995
help 1996
hostname 1997
install 1999
install add file activate reloadfast commit 2013
ip ssh bulk-mode 2015
l2 traceroute 2016
license air level 2017
license boot level 2019
license smart (global config) 2022
license smart (privileged EXEC) 2032
line auto-consolidation 2041
location 2043
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxvi
Contents
location plm calibrating 2046
mac address-table move update 2047
mgmt_init 2048
mkdir 2049
more 2050
no debug all 2051
reload fast 2052
rename 2054
request consent-token accept-response shell-access 2055
request consent-token generate-challenge shell-access 2056
request consent-token terminate-auth 2057
request platform software console attach switch 2058
reset 2060
rmdir 2061
sdm prefer 2062
service private-config-encryption 2063
set 2064
show avc client 2067
show bootflash: 2068
show cable-diagnostics tdr 2071
show consistency-checker mcast 2073
show consistency-checker mcast l3m 2075
show consistency-checker objects 2079
show consistency-checker run-id 2081
show debug 2083
show env 2084
show env xps 2086
show flow monitor 2090
show install 2092
show license all 2094
show license authorization 2102
show license data conversion 2107
show license eventlog 2108
show license history message 2110
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxvii
Contents
show license reservation 2111
show license rum 2112
show license status 2120
show license summary 2129
show license tech 2133
show license udi 2151
show license usage 2153
show location 2157
show logging onboard switch uptime 2159
show logging process ios module 2162
show mac address-table 2165
show mac address-table move update 2170
show parser encrypt file status 2171
show platform hardware fpga 2172
show platform integrity 2173
show platform software audit 2174
show platform software fed switch punt cause 2178
show platform software fed switch punt cpuq 2180
show platform software sl-infra 2183
show platform sudi certificate 2184
show romvar 2186
show running-config 2188
show sdm prefer 2194
show tech-support confidential 2196
show tech-support monitor 2197
show tech-support platform 2198
show tech-support platform evpn_vxlan 2202
show tech-support platform fabric 2204
show tech-support platform igmp_snooping 2208
show tech-support platform layer3 2211
show tech-support platform mld_snooping 2219
show tech-support port 2226
show tech-support pvlan 2229
show tech-support resource 2230
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxviii
Contents
show version 2235
system env temperature threshold yellow 2242
test cable-diagnostics tdr 2244
traceroute mac 2245
traceroute mac ip 2248
type 2250
unset 2251
upgrade rom-monitor capsule 2253
version 2255
CHAPTER 15 Tracing 2257
Information About Tracing 2258
Tracing Overview 2258
Location of Tracelogs 2258
Tracelog Naming Convention 2258
Rotation and Throttling Policy 2259
Tracing Levels 2259
set platform software trace 2260
show platform software trace filter-binary 2264
show platform software trace message 2265
show platform software trace level 2269
request platform software trace archive 2272
request platform software trace rotate all 2273
request platform software trace filter-binary 2274
PART XIV VLAN 2275
CHAPTER 16 VLAN Commands 2277
clear vtp counters 2278
debug sw-vlan 2279
debug sw-vlan ifs 2281
debug sw-vlan notification 2282
debug sw-vlan vtp 2283
dot1q vlan native 2285
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xxxix
Contents
interface (VLAN) 2286
private-vlan 2287
private-vlan mapping 2289
show interfaces private-vlan mapping 2291
show vlan 2292
show vtp 2296
switchport mode private-vlan 2301
switchport priority extend 2303
switchport trunk 2304
vlan 2307
vlan dot1q tag native 2313
vtp (global configuration) 2314
vtp (interface configuration) 2319
vtp primary 2320
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
xl
Using the Command-Line Interface
This chapter contains the following topics:
• Using the Command-Line Interface, on page 2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1
Using the Command-Line Interface
Using the Command-Line Interface
Using the Command-Line Interface
This chapter describes the Cisco IOS command-line interface (CLI) and how to use it to configure your switch.
Note The documentation set for this product strives to use bias-free language. For purposes of this documentation
set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial
identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be
present in the documentation due to language that is hardcoded in the user interfaces of the product software,
language used based on standards documentation, or language that is used by a referenced third-party product.
Understanding Command Modes
The Cisco IOS user interface is divided into many different modes. The commands available to you depend
on which mode you are currently in. Enter a question mark (?) at the system prompt to obtain a list of commands
available for each command mode.
When you start a session on the switch, you begin in user mode, often called user EXEC mode. Only a limited
subset of the commands are available in user EXEC mode. For example, most of the user EXEC commands
are one-time commands, such as show commands, which show the current configuration status, and clear
commands, which clear counters or interfaces. The user EXEC commands are not saved when the switch
reboots.
To have access to all commands, you must enter privileged EXEC mode. Normally, you must enter a password
to enter privileged EXEC mode. From this mode, you can enter any privileged EXEC command or enter
global configuration mode.
Using the configuration modes (global, interface, and line), you can make changes to the running configuration.
If you save the configuration, these commands are stored and used when the switch reboots. To access the
various configuration modes, you must start at global configuration mode. From global configuration mode,
you can enter interface configuration mode and line configuration mode.
This table describes the main command modes, how to access each one, the prompt you see in that mode, and
how to exit the mode. The examples in the table use the hostname Switch.
Table 1: Command Mode Summary
Mode Access Method Prompt Exit Method About This Mode
User EXEC Begin a session with Enter logout or quit. Use this mode to
Switch>
your switch.
• Change terminal
settings.
• Perform basic tests.
• Display system
information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
2
Using the Command-Line Interface
Understanding the Help System
Mode Access Method Prompt Exit Method About This Mode
Privileged While in user EXEC Enter disable to exit. Use this mode to verify
#
EXEC mode, enter the enable commands that you have
command. entered. Use a password to
protect access to this mode.
Global While in privileged To exit to privileged Use this mode to configure
(config)#
configuration EXEC mode, enter the EXEC mode, enter exit parameters that apply to the
configure command. or end, or press Ctrl-Z. entire switch.
VLAN While in global To exit to global Use this mode to configure
(config-vlan)#
configuration configuration mode, configuration mode, VLAN parameters. When
enter the vlan vlan-id enter the exit command. VTP mode is transparent,
command. you can create
To return to privileged
extended-range VLANs
EXEC mode, press
(VLAN IDs greater than
Ctrl-Z or enter end.
1005) and save
configurations in the switch
startup configuration file.
Interface While in global To exit to global Use this mode to configure
(config-if)#
configuration configuration mode, configuration mode, parameters for the Ethernet
enter the interface enter exit. ports.
command (with a
To return to privileged
specific interface).
EXEC mode, press
Ctrl-Z or enter end.
Line While in global To exit to global Use this mode to configure
(config-line)#
configuration configuration mode, configuration mode, parameters for the terminal
specify a line with the enter exit. line.
line vty or line
To return to privileged
console command.
EXEC mode, press
Ctrl-Z or enter end.
For more detailed information on the command modes, see the command reference guide for this release.
Understanding the Help System
You can enter a question mark (?) at the system prompt to display a list of commands available for each
command mode. You can also obtain a list of associated keywords and arguments for any command.
Table 2: Help Summary
Command Purpose
help Obtains a brief description of the help system in any
command mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
3
Using the Command-Line Interface
Understanding Abbreviated Commands
Command Purpose
abbreviated-command-entry ? Obtains a list of commands that begin with a particular
character string.
# di?
dir disable disconnect
abbreviated-command-entry <Tab> Completes a partial command name.
# sh conf<tab>
# show configuration
? Lists all commands available for a particular command
mode.
Switch> ?
command ? Lists the associated keywords for a command.
Switch> show ?
command keyword ? Lists the associated arguments for a keyword.
(config)# cdp holdtime ?
<10-255> Length of time (in sec) that
receiver must keep this packet
Understanding Abbreviated Commands
You need to enter only enough characters for the switch to recognize the command as unique.
This example shows how to enter the show configuration privileged EXEC command in an abbreviated form:
# show conf
Understanding no and default Forms of Commands
Almost every configuration command also has a no form. In general, use the no form to disable a feature or
function or reverse the action of a command. For example, the no shutdown interface configuration command
reverses the shutdown of an interface. Use the command without the keyword no to re-enable a disabled
feature or to enable a feature that is disabled by default.
Configuration commands can also have a default form. The default form of a command returns the command
setting to its default. Most commands are disabled by default, so the default form is the same as the no form.
However, some commands are enabled by default and have variables set to certain default values. In these
cases, the default command enables the command and sets variables to their default values.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
4
Using the Command-Line Interface
Understanding CLI Error Messages
Understanding CLI Error Messages
This table lists some error messages that you might encounter while using the CLI to configure your switch.
Table 3: Common CLI Error Messages
Error Message Meaning How to Get Help
% Ambiguous You did not enter enough Re-enter the command followed by a question mark
command: "show
characters for your switch to (?) with a space between the command and the
con"
recognize the command. question mark.
The possible keywords that you can enter with the
command appear.
% Incomplete You did not enter all the Re-enter the command followed by a question mark
command.
keywords or values required by (?) with a space between the command and the
this command. question mark.
The possible keywords that you can enter with the
command appear.
% Invalid input You entered the command Enter a question mark (?) to display all the
detected at ‘^’
incorrectly. The caret (^) marks commands that are available in this command mode.
marker.
the point of the error.
The possible keywords that you can enter with the
command appear.
Using Configuration Logging
You can log and view changes to the switch configuration. You can use the Configuration Change Logging
and Notification feature to track changes on a per-session and per-user basis. The logger tracks each
configuration command that is applied, the user who entered the command, the time that the command was
entered, and the parser return code for the command. This feature includes a mechanism for asynchronous
notification to registered applications whenever the configuration changes. You can choose to have the
notifications sent to the syslog.
Note Only CLI or HTTP changes are logged.
Using Command History
The software provides a history or record of commands that you have entered. The command history feature
is particularly useful for recalling long or complex commands or entries, including access lists. You can
customize this feature to suit your needs.
Changing the Command History Buffer Size
By default, the switch records ten command lines in its history buffer. You can alter this number for a current
terminal session or for all sessions on a particular line. These procedures are optional.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
5
Using the Command-Line Interface
Recalling Commands
Beginning in privileged EXEC mode, enter this command to change the number of command lines that the
switch records during the current terminal session:
# terminal history [size number-of-lines]
The range is from 0 to 256.
Beginning in line configuration mode, enter this command to configure the number of command lines the
switch records for all sessions on a particular line:
(config-line)# history [size number-of-lines]
The range is from 0 to 256.
Recalling Commands
To recall commands from the history buffer, perform one of the actions listed in this table. These actions are
optional.
Note The arrow keys function only on ANSI-compatible terminals such as VT100s.
Table 4: Recalling Commands
Action Result
Press Ctrl-P or the up arrow Recalls commands in the history buffer, beginning with the most recent
key. command. Repeat the key sequence to recall successively older commands.
Press Ctrl-N or the down arrow Returns to more recent commands in the history buffer after recalling
key. commands with Ctrl-P or the up arrow key. Repeat the key sequence to
recall successively more recent commands.
show history While in privileged EXEC mode, lists the last several commands that you
just entered. The number of commands that appear is controlled by the
(config)# help setting of the terminal history global configuration command and the
history line configuration command.
Disabling the Command History Feature
The command history feature is automatically enabled. You can disable it for the current terminal session or
for the command line. These procedures are optional.
To disable the feature during the current terminal session, enter the terminal no history privileged EXEC
command.
To disable command history for the line, enter the no history line configuration command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
6
Using the Command-Line Interface
Using Editing Features
Using Editing Features
This section describes the editing features that can help you manipulate the command line.
Enabling and Disabling Editing Features
Although enhanced editing mode is automatically enabled, you can disable it, re-enable it, or configure a
specific line to have enhanced editing. These procedures are optional.
To globally disable enhanced editing mode, enter this command in line configuration mode:
Switch (config-line)# no editing
To re-enable the enhanced editing mode for the current terminal session, enter this command in privileged
EXEC mode:
# terminal editing
To reconfigure a specific line to have enhanced editing mode, enter this command in line configuration mode:
(config-line)# editing
Editing Commands through Keystrokes
This table shows the keystrokes that you need to edit command lines. These keystrokes are optional.
Note The arrow keys function only on ANSI-compatible terminals such as VT100s.
Table 5: Editing Commands through Keystrokes
Capability Keystroke Purpose
Move around the command line to Press Ctrl-B, or press the Moves the cursor back one character.
make changes or corrections. left arrow key.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
7
Using the Command-Line Interface
Editing Commands through Keystrokes
Capability Keystroke Purpose
Press Ctrl-F, or press the Moves the cursor forward one character.
right arrow key.
Press Ctrl-A. Moves the cursor to the beginning of the
command line.
Press Ctrl-E. Moves the cursor to the end of the
command line.
Press Esc B. Moves the cursor back one word.
Press Esc F. Moves the cursor forward one word.
Press Ctrl-T. Transposes the character to the left of the
cursor with the character located at the
cursor.
Recall commands from the buffer Press Ctrl-Y. Recalls the most recent entry in the buffer.
and paste them in the command line.
The switch provides a buffer with
the last ten items that you deleted.
Press Esc Y. Recalls the next buffer entry.
The buffer contains only the last 10 items
that you have deleted or cut. If you press
Esc Y more than ten times, you cycle to
the first buffer entry.
Delete entries if you make a mistake Press the Delete or Erases the character to the left of the
or change your mind. Backspace key. cursor.
Press Ctrl-D. Deletes the character at the cursor.
Press Ctrl-K. Deletes all characters from the cursor to
the end of the command line.
Press Ctrl-U or Ctrl-X. Deletes all characters from the cursor to
the beginning of the command line.
Press Ctrl-W. Deletes the word to the left of the cursor.
Press Esc D. Deletes from the cursor to the end of the
word.
Capitalize or lowercase words or Press Esc C. Capitalizes at the cursor.
capitalize a set of letters.
Press Esc L. Changes the word at the cursor to
lowercase.
Press Esc U. Capitalizes letters from the cursor to the
end of the word.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
8
Using the Command-Line Interface
Editing Command Lines that Wrap
Capability Keystroke Purpose
Designate a particular keystroke as Press Ctrl-V or Esc Q.
an executable command, perhaps as
a shortcut.
Scroll down a line or screen on Press the Return key. Scrolls down one line.
displays that are longer than the
terminal screen can display.
Note The More prompt is
used for any output
that has more lines
than can be displayed
on the terminal screen,
including show
command output. You
can use the Return and
Space bar keystrokes
whenever you see the
More prompt.
Press the Space bar. Scrolls down one screen.
Redisplay the current command line Press Ctrl-L or Ctrl-R. Redisplays the current command line.
if the switch suddenly sends a
message to your screen.
Editing Command Lines that Wrap
You can use a wraparound feature for commands that extend beyond a single line on the screen. When the
cursor reaches the right margin, the command line shifts ten spaces to the left. You cannot see the first ten
characters of the line, but you can scroll back and check the syntax at the beginning of the command. The
keystroke actions are optional.
To scroll back to the beginning of the command entry, press Ctrl-B or the left arrow key repeatedly. You can
also press Ctrl-A to immediately move to the beginning of the line.
Note The arrow keys function only on ANSI-compatible terminals such as VT100s.
In this example, the access-list global configuration command entry extends beyond one line. When the cursor
first reaches the end of the line, the line is shifted ten spaces to the left and redisplayed. The dollar sign ($)
shows that the line has been scrolled to the left. Each time the cursor reaches the end of the line, the line is
again shifted ten spaces to the left.
(config)# access-list 101 permit tcp 131.108.2.5 255.255.255.0 131.108.1
(config)# $ 101 permit tcp 131.108.2.5 255.255.255.0 131.108.1.20 255.25
(config)# $t tcp 131.108.2.5 255.255.255.0 131.108.1.20 255.255.255.0 eq
(config)# $108.2.5 255.255.255.0 131.108.1.20 255.255.255.0 eq 45
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
9
Using the Command-Line Interface
Searching and Filtering Output of show and more Commands
After you complete the entry, press Ctrl-A to check the complete syntax before pressing the Return key to
execute the command. The dollar sign ($) appears at the end of the line to show that the line has been scrolled
to the right:
(config)# access-list 101 permit tcp 131.108.2.5 255.255.255.0 131.108.1$
The software assumes that you have a terminal screen that is 80 columns wide. If you have a width other than
that, use the terminal width privileged EXEC command to set the width of your terminal.
Use line wrapping with the command history feature to recall and modify previous complex command entries.
Searching and Filtering Output of show and more Commands
You can search and filter the output for show and more commands. This is useful when you need to sort
through large amounts of output or if you want to exclude output that you do not need to see. Using these
commands is optional.
To use this functionality, enter a show or more command followed by the pipe character (|), one of the
keywords begin, include, or exclude, and an expression that you want to search for or filter out:
command | {begin | include | exclude} regular-expression
Expressions are case sensitive. For example, if you enter | exclude output, the lines that contain output are
not displayed, but the lines that contain Output appear.
This example shows how to include in the output display only lines where the expression protocol appears:
# show interfaces | include protocol
Vlan1 is up, line protocol is up
Vlan10 is up, line protocol is down
GigabitEthernet1/0/1 is up, line protocol is down
GigabitEthernet1/0/2 is up, line protocol is up
Accessing the CLI
You can access the CLI through a console connection, through Telnet, or by using the browser.
You manage the switch stack and the switch member interfaces through the active switch. You cannot manage
switch stack members on an individual switch basis. You can connect to the active switch through the console
port or the Ethernet management port of one or more switch members. Be careful with using multiple CLI
sessions to the active switch. Commands you enter in one session are not displayed in the other sessions.
Therefore, it is possible to lose track of the session from which you entered commands.
Note We recommend using one CLI session when managing the switch stack.
If you want to configure a specific switch member port, you must include the switch member number in the
CLI command interface notation.
To debug a specific switch member, you can access it from the active switch by using the session
stack-member-number privileged EXEC command. The switch member number is appended to the system
prompt. For example, Switch-2# is the prompt in privileged EXEC mode for switch member 2, and where the
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
10
Using the Command-Line Interface
Accessing the CLI through a Console Connection or through Telnet
system prompt for the active switch is Switch. Only the show and debug commands are available in a CLI
session to a specific switch member.
Accessing the CLI through a Console Connection or through Telnet
Before you can access the CLI, you must connect a terminal or a PC to the switch console or connect a PC to
the Ethernet management port and then power on the switch, as described in the hardware installation guide
that shipped with your switch.
CLI access is available before switch setup. After your switch is configured, you can access the CLI through
a remote Telnet session or SSH client.
You can use one of these methods to establish a connection with the switch:
• Connect the switch console port to a management station or dial-up modem, or connect the Ethernet
management port to a PC. For information about connecting to the console or Ethernet management port,
see the switch hardware installation guide.
• Use any Telnet TCP/IP or encrypted Secure Shell (SSH) package from a remote management station.
The switch must have network connectivity with the Telnet or SSH client, and the switch must have an
enable secret password configured.
The switch supports up to 16 simultaneous Telnet sessions. Changes made by one Telnet user are reflected
in all other Telnet sessions.
The switch supports up to five simultaneous secure SSH sessions.
After you connect through the console port, through the Ethernet management port, through a Telnet session
or through an SSH session, the user EXEC prompt appears on the management station.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
11
Using the Command-Line Interface
Accessing the CLI through a Console Connection or through Telnet
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
12
PA R T I
Cisco SD-Access
• Cisco SD-Access Commands, on page 15
Cisco SD-Access Commands
• broadcast-underlay, on page 17
• database-mapping, on page 18
• dynamic-eid, on page 21
• eid-record-provider, on page 22
• eid-record-subscriber, on page 23
• eid-table, on page 24
• encapsulation, on page 26
• etr, on page 27
• etr map-server, on page 28
• extranet, on page 29
• first-packet-petr, on page 30
• instance-id, on page 32
• ip pim lisp core-group-range, on page 33
• ip pim lisp transport multicast, on page 34
• ip pim rp-address, on page 35
• ip pim sparse mode, on page 36
• ipv4 multicast multitopology, on page 37
• ip pim ssm, on page 38
• itr, on page 39
• itr map-resolver, on page 40
• locator default-set, on page 41
• locator-set, on page 42
• map-cache , on page 43
• map-cache extranet, on page 44
• prefix-list, on page 45
• route-import database, on page 46
• service, on page 48
• show lisp instance-id ipv4 database, on page 49
• show lisp instance-id ipv6 database, on page 51
• show lisp instance-id ipv4 map-cache, on page 52
• show lisp instance-id ipv6 map-cache, on page 58
• show lisp instance-id ipv4 server, on page 60
• show lisp instance-id ipv6 server, on page 62
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
15
Cisco SD-Access
• show lisp instance-id ipv4 statistics, on page 63
• show lisp instance-id ipv6 statistics, on page 64
• show lisp prefix-list, on page 65
• show lisp session, on page 66
• use-petr, on page 67
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
16
Cisco SD-Access
broadcast-underlay
broadcast-underlay
To configure the underlay in a LISP network to use a mutlicast group to send encapsulated broadcast packets
and link local multicast packets, use the broadcast-underlay command in the service submode.
[no] broadcast-underlay multicast-ip
Syntax Description multicast-ip The IP address of the multicast group used to send the encapsulated broadcast packets
Command Default None.
Command Modes LISP Service Ethernet (router-lisp-inst-serv-eth)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use this command to enable the broadcast functionality on the fabric edge node in a LISP network. Ensure
that this command is used in the router-lisp-service-ethernet mode or router-lisp-instance-service-ethernet
mode.
Use the no form of the command to remove the broadcast functionality.
The following example shows how to configure broadcast on a fabric edge node:
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ethernet
device(config-router-lisp-inst-serv-eth)#eid-table vlan 250
device(config-router-lisp-inst-serv-eth)#broadcast-underlay 225.1.1.1
device(config-router-lisp-inst-serv-eth)#database-mapping mac locator-set rloc2
device(config-router-lisp-inst-serv-eth)#exit-service-ethernet
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
17
Cisco SD-Access
database-mapping
database-mapping
To configure an IPv4 or IPv6 endpoint identifier-to-routing locator (EID-to-RLOC) mapping relationship and
an associated traffic policy for Locator/ID Separation Protocol (LISP), use the database-mapping command
in the LISP EID-table configuration mode. To remove the configured database mapping, use the no form of
the command.
[ no ] database-mapping eid-prefix / prefix-length { locator-set RLOC-name [ proxy | default-etr
| default-etr-route-map | route-tag ] | ipv6-interface interface-name | ipv4-interface interface-name
| auto-discover-rlocs | limit }
Syntax Description eid-prefix / prefix-length Specifies the IPv4 or IPv6 endpoint identifier prefix and length that is advertised
by the router.
locator-set RLOC-name Specifies the routing locator (RLOC) associated with the value specified for the
eid-prefix.
Use the following keyword options for database mapping:
• proxy : enables configuration of static proxy database mapping
• default-etr : enables configuration of default ETR database mapping
• route-tag route-tag: monitors the RIB entry for a match with the route-tag
specified
• default-etr-route-map route-map: specifies the route-map to look for
default-etr RIB route updates and dynamically changes the locator set for
this database mapping.
ipv4 interface Specifies the IPv4 address and name of the interface that is used as the RLOC
interface-name for the EID prefix.
ipv6 interface Specifies the IPv6 address and name of the interface that is used as the RLOC
interface-name for the EID prefix.
auto-discover-rlocs Configures the Egress Tunnel Router (ETR) to discover the locators of all routers
configured to function as both an ETR and an Ingress Tunnel Router (ITR)—such
routers are referred to as xTRs—in the ETR LISP site when the site uses multiple
xTRs and each xTR is configured to use DHCP-learned locators or configured
with only its own locators.
limit Specifies the maximum size of local EID prefixes database.
Command Default No LISP database entries are defined.
Command Modes LISP Instance Service (router-lisp-instance-service)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
18
Cisco SD-Access
database-mapping
Release Modification
Cisco IOS XE Fuji 16.9.1 Introduced support for the keyword proxy.
Cisco IOS XE Bengaluru 17.5.1 Introduced support for default-etr-route-map
Usage Guidelines In the LISP-instance-service configuration mode, the database-mapping command configures LISP database
parameters with a specified IPv4 or IPv6 EID-prefix block. The locator is the IPv4 or IPv6 address of any
interface used as the RLOC address for the eid-prefix assigned to the site but can also be the loopback address
of the interface.
When a LISP site has multiple locators associated with the same EID-prefix block, multiple database-mapping
commands are used to configure all of the locators for a given EID-prefix block.
In a MultiSite scenario, the LISP border node advertises the site EID that it’s attached to on the transit
map-server to attract site traffic. To advertise, the border node has to obtain the route from the internal border
and proxy register with the transit site map-server accordingly. The database-mapping eid-prefix locator-set
RLOC-name proxy command enables the configuration of a static proxy database mapping.
In Cisco IOS XE Bengaluru 17.5.1 and later releases, database-mapping eid-prefix locator-set RLOC-name
default-etr-route-map route-map command monitors the specified route-map for route updates corresponding
to the eid-prefix. If there is an update from the route map and if the route map has a defined LISP locator set,
the locator-set of this database mapping is changed to the one specified in the route-map.
By default, RIB metric (BGP MED attribute) information for the specified default-etr eid-prefix is obtained.
You can disable the default using the default-etr disable-metric command.
Enabling the default-etr-route-map option allows you to match other BGP attributes like AS_PATH,
COMMUNITIES, and so on, and modify the locator set of the database mapping accordingly.
Examples
The following example shows how to map the eid-prefix with the locator-set, RLOC, in the EID
configuration mode on an external border:
Note Ensure that the locator-set RLOC is already configured.
device(config)# router lisp
device(config-router-lisp)# instance-id 3
device(config-router-lisp-inst)# service ipv4
device(config-router-lisp-inst-serv-ipv4)#eid-table vrf red
device(config-router-lisp-inst-serv-ipv4-eid-table)# database-mapping 172.168.0.0/16
locator-set RLOC proxy
device(config-router-lisp-inst-serv-ipv4-eid-table)# database-mapping 173.168.0.0/16
locator-set RLOC proxy
device(config-router-lisp-inst-serv-ipv4-eid-table)# map-cache 0.0.0.0/0
map-requestdevice(config-router-lisp-inst-serv-ipv4-eid-table)#exit
device(config-router-lisp-inst-serv-ipv4)#
The following example shows how to dynamically change the eid-prefix/locator-set mapping, using
the default-etr-route-map keyword:
device(config)# router lisp
device(config-router-lisp)# instance-id 1
device(config-router-lisp-inst)# service ipv4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
19
Cisco SD-Access
database-mapping
device(config-router-lisp-inst-serv-ipv4)#eid-table default
device(config-router-lisp-inst-serv-ipv4-eid-table)# database-mapping 0.0.0.0/0 locator-set
RLOC default-etr-route-map abc
device(config-router-lisp-inst-serv-ipv4-eid-table)#exit
device(config-router-lisp-inst-serv-ipv4)#
Related Commands Command Description
eid-table vrf vrf-name Associates the instance-service instantiation with a virtual routing and forwarding
(VRF) table or default table through which the endpoint identifier address space is
reachable.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
20
Cisco SD-Access
dynamic-eid
dynamic-eid
To create a dynamic End Point Identifier (EID) policy and enter the dynamic-eid configuration mode on an
xTR, use the dynamic-eid command.
dynamic-eid eid-name
Syntax Description eid-name If eid-name exists, it enters eid-name configuration mode. Else, a new dynamic-eid policy with
name eid-name is created and it enters the dynamic-eid configuration mode.
Command Default No LISP dynamic-eid policies are configured.
Command Modes LISP EID-table (router-lisp-eid-table)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines To configure LISP mobility, create a dynamic-EID roaming policy that can be referenced by the lisp mobility
interface command. When the dynamic-eid command is entered, the referenced LISP dynamic-EID policy
is created and you enter the dynamic-EID configuration mode. In this mode, all attributes associated with the
referenced LISP dynamic-EID policy can be entered. When a dynamic-EID policy is configured, you must
specify the dynamic-EID-to-RLOC mapping relationship and its associated traffic policy.
Related Commands Command D Description
lisp mobility Configures an interface on an ITR to participate in LISP mobility (dynamic-EID roaming).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
21
Cisco SD-Access
eid-record-provider
eid-record-provider
To define the extranet policy table for the provider instance use the eid-record-provider command in the
lisp-extranet mode.
[no]eid-record-provider instance-id instance id {ipv4 address prefix|ipv6 address prefix} bidirectional
Syntax Description instance-id instance id The instance-id of the LISP instance for which the extranet provider policy applies.
ipv4 address prefix Defines the IPv4 EID prefixes to be leaked, specified in a.b.c.d/nn form.
ipv6 address prefix Defines the IPv6 EID prefixes to be leaked, prefix specified in X:X:X:X::X/<0-128>
form.
bidirectional Specifies that the extranet communication between the provider and subscriber EID
prefixes are bidirectional.
Command Default None.
Command Modes router-lisp-extranet
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the no form of the command to negate the eid-record-provider configuration.
device(config)#router lisp
device(config-router-lisp)#extranet ext1
device(config-router-lisp-extranet)#eid-record-provider instance-id 5000 10.0.0.0/8
bidirectional
device(config-router-lisp-extranet)#eid-record-subscriber instance-id 1000 3.0.0.0/24
bidirectional
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
22
Cisco SD-Access
eid-record-subscriber
eid-record-subscriber
To define the extranet policy table for the subscriber instance use the eid-record-subscriber command in the
lisp-extranet mode.
[no]eid-record-subscriber instance-id instance id {ipv4 address prefix|ipv6 address prefix} bidirectional
Syntax Description instance-id instance id The instance-id of the LISP instance for which the extranet provider policy applies.
ipv4 address prefix Defines the IPv4 EID prefixes to be leaked, specified in a.b.c.d/nn form.
ipv6 address prefix Defines the IPv6 EID prefixes to be leaked, prefix specified in X:X:X:X::X/<0-128>
form.
bidirectional Specifies that the extranet communication between the provider and subscriber EID
prefixes are bidirectional.
Command Default None.
Command Modes LISP Extranet (router-lisp-extranet)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the no form of the command to negate the eid-record-subscriber configuration.
device(config)#router lisp
device(config-router-lisp)#extranet ext1
device(config-router-lisp-extranet)#eid-record-provider instance-id 5000 10.0.0.0/8
bidirectional
device(config-router-lisp-extranet)#eid-record-subscriber instance-id 1000 3.0.0.0/24
bidirectional
device(config-router-lisp-extranet)#eid-record-subscriber instance-id 2000 20.20.0.0/8
bidirectional
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
23
Cisco SD-Access
eid-table
eid-table
The eid-table command associates the instance-service instantiation with a virtual routing and forwarding
(VRF) table or default table through which the endpoint identifier address space is reachable.
[no]eid-table {vrf-name | default | vrf vrf-name}
Syntax Description default Selects the default (global) routing table for association with the configured instance-service.
vrf Selects the named VRF table for association with the configured instance.
vrf-name
Command Default Default VRF is associated with instance-id 0.
Command Modes router-lisp-instance-service
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines This command is used only in the instance-service mode.
For Layer 3 (service ipv4 / service ipv6), a VRF table is associated with the instance-service. For Layer 2
(service ethernet), a VLAN is associated with the instance-service.
Note For Layer 2, ensure that you have defined a VLAN before configuring the eid-table.
For Layer 3, ensure that you have defined a VRF table before you configure the eid-table.
In the following example, an XTR is configured to segment traffic using VRF named vrf-table. The
EID prefix associated with vrf-table is connected to instance ID 3.
device(config)#vrf definition vrf-table
device(config-vrf)#address-family ipv4
device(config-vrf-af)#exit
device(config-vrf)#exit
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#eid-table vrf vrf-table
In the following example, the EID prefix associated with a VLAN, named Vlan10, is connected to
instance ID 101.
device(config)#interface Vlan10
device(config-if)#mac-address ba25.cdf4.ad38
device(config-if)#ip address 10.1.1.1 255.255.255.0
device(config-if)#end
device(config)#router lisp
device(config-router-lisp)#instance-id 101
device(config-router-lisp-inst)#service ethernet
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
24
Cisco SD-Access
eid-table
device(config-router-lisp-inst-serv-ethernet)#eid-table Vlan10
device(config-router-lisp-inst-serv-ethernet)#database-mapping mac locator-set set
device(config-router-lisp-inst-serv-ethernet)#exit-service-etherne
device(config-router-lisp-inst)#exit-instance-id
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
25
Cisco SD-Access
encapsulation
encapsulation
To configure the type of encapsulation of the data packets in the LISP network, use the encapsulation command
in the service mode.
[no] encapsulation {vxlan | lisp}
Syntax Description encapsulation vxlan Specifies VXLAN-based encapsulation.
encapsulation lisp Specifies LISP-based encapsulation
Command Default None.
Command Modes LISP Service IPv4 (router-lisp-serv-ipv4)
LISP Service IPv6 (router-lisp-serv-ipv6)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the encapsulation vxlan command in the service ethernet mode to encapuslate Layer 2 packets. Use the
encapsulation lisp command in the service ipv4 or service ipv6 mode to encapsulate the Layer 3 packets.
Use the no form of the command to remove encapsulation on the packets.
The following example shows how to configure an xTR for data encapsulation
device(config)#router lisp
device(config-router-lisp)#service ipv4
device(config-router-lisp-serv-ipv4)#encapuslation vxlan
device(config-router-lisp-serv-ipv4)#map-cache-limit 200
device(config-router-lisp-serv-ipv4)#exit-service-ipv4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
26
Cisco SD-Access
etr
etr
To configure a device as an Egress Tunnel Router (ETR) use the etr command in the instance-service mode
or service submode.
[ no ] etr
Command Default The device is not configured as ETR by default.
Command Modes router-lisp-instance-service
router-lisp-service
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use this command to enable a device to perform the ETR functionality.
Use the no form of the command to remove the ETR functionality.
A router configured as an ETR is also typically configured with database-mapping commands so that the ETR
knows what endpoint identifier (EID)-prefix blocks and corresponding locators are used for the LISP site. In
addition, the ETR should be configured to register with a map server with the etr map-server command, or
to use static LISP EID-to-routing locator (EID-to-RLOC) mappings with the map-cache command to participate
in LISP networking.
The following example shows how to configure a device as an ETR.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#etr
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
27
Cisco SD-Access
etr map-server
etr map-server
To configure a map server to be used by the Egress Tunnel Router (ETR) when configuring the EIDs, use the
etr map-server command in the instance mode or instance-service mode. To remove the configured locator
address of the map-server, use the no form of this command.
etr map-server map-server-address {key [0|6|7] authentication-key | proxy-reply }
Syntax Description map-server-address The locator address of the map server.
key Specifies the key type.
0 Indicates that password is entered as clear text.
6 Indicates that password is in the AES encrypted form.
7 Indicates that passowrd is a weak encrypted one.
authentication-key The password used for computing the SHA-1 HMAC hash that is included in the header
of the map-register message.
proxy-reply Specifies that the map server answer the map-requests on behalf the ETR.
Command Default None.
Command Modes LISP Instance Service (router-lisp-inst-serv)
LISP Service (router-lisp-serv)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the etr map-server command to configure the locator of the map server to which the ETR will register
for its EIDs. The authentication key argument in the command syntax is a password that is used for a SHA-1
HMAC hash (included in the header of the map-register message). The password used for the SHA-1 HMAC
may be entered in unencrypted (cleartext) form or encrypted form. To enter an unencrypted password, specify
0. To enter an AES encrypted password, specify 6.
Use the no form of the command to remove the map server functionality.
The following example shows how to configure a map server located at 2.1.1.6 to act as a proxy in order to
answer the map-requests on the ETR .
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#etr map-server 2.1.1.6 key foo
device(config-router-lisp-inst-serv-ipv4)#etr map-server 2.1.1.6 proxy-reply
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
28
Cisco SD-Access
extranet
extranet
To enable the inter-VRF communication in a LISP network, use the extranet command in the LISP
configuration mode on the MSMR.
extranet name-extranet
Syntax Description name-extranet Specifies the name of the extranet created.
Command Default None.
Command Modes LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
device(config)#router lisp
device(config-router-lisp)#extranet ext1
device(config-router-lisp-extranet)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
29
Cisco SD-Access
first-packet-petr
first-packet-petr
To prevent the loss of the first packet (and subsequent packets until map-cache is resolved), use the
first-packet-petr command on the Map Server, in the LISP-service or the LISP-instance-service configuration
mode. To disable the configuration of this command, use its no form.
Configuring this command ensures that even the first packet that is sent out from the fabric edge device reaches
its destination through a first-packet-handler border that is available.
[no] first-packet-petr remote-locator-set fpetr-RLOC
Syntax Description remote-locator-set Specifies a remote locator-set, which is a set of IP addresses of remote
fpetr-RLOC devices, that connect to an external network or to networks across sites or
to Data Center through remote or local sites.
Command Default None.
Command Modes LISP-instance-service
LISP-service
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 The command was
introduced.
Usage Guidelines The ITR or the fabric edge device drops the initial packets sent to it until it learns the destination EID
reachability from the local MSMR. To prevent the drop of the first packet, configure the first-packet-petr
command on the local MSMR.
Configure the first-packet-petr command on the local map server to ensure that when the fabric edges boots
up and resolves the 0/0 map-cache entry, it gets the first packet forwarding RLOCs.
When an MSMR receives a request to connect to an external network (like internet), it first checks for the
availability of an external border. If the map server does not find the default-ETR border or the internet service
providing border, it responds with the remote RLOCs that are configured with the first-packet-petr command.
Note You can configure the first-packet-petr command only on a control plane that is within a fabric site. You
cannot configure this command on the control plane of a transit site.
Example
The following example first defines a remote locator set and associates the remote RLOCs with the
first-packet-petr command:
Device(config)#router lisp
Device(config-router-lisp)#remote-locator-set fpetr
Device(config-router-lisp-remote-locator-set)#23.23.23.23 priority 1 weight 1
Device(config-router-lisp-remote-locator-set)#24.24.24.24 priority 1 weight 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
30
Cisco SD-Access
first-packet-petr
Device(config-router-lisp-remote-locator-set)#exit-remote-locator-set
Device(config-router-lisp)#service ipv4
Device(config-lisp-srv-ipv4)#first-packet-petr remote-locator-set fpetr
Device(config-lisp-srv-ipv4)#map-server
Device(config-lisp-srv-ipv4)#map-resolver
Device(config-lisp-srv-ipv4)#exit-service-ipv4
Device(config-router-lisp)#
The configured behavior is inherited by all instances under service ipv4.
To override the behavior for a particular instance, configure the first-packet-petr command for that
instance. In the following example, instance 101 disables the first-packet-petr command.
Device(config-router-lisp)#instance-id 101
Device(config-router-lisp-inst)#service ipv4
Device(config-router-lisp-inst-service-ipv4)#no first-packet-petr remote-locator-set
Device(config-router-lisp-inst-service-ipv4)#exit-service-ipv4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
31
Cisco SD-Access
instance-id
instance-id
To creae a LISP EID instance under the router-lisp configuration mode and enter the instance-id submode,
use the instance-id command.
instance-id iid
Command Default None.
Command Modes LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the instance-id command to create a LISP eid instance to group multiple services.
Configuration under this instance-id will apply to all services underneath it.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
32
Cisco SD-Access
ip pim lisp core-group-range
ip pim lisp core-group-range
To configure the core range of address of a Protocol Independent Multicast (PIM) Source Specific Multicast
(SSM) on a LISP sub-interface, use the ip pim lisp core-group-range command in interface configuration
mode. To remove SSM address range, use the no form of this command
[no]ip pim lisp core-group-range start-SSM-address range-size
Syntax Description start-SSM-address Specifies the start of the SSM IP address range.
number-of-groups Specifies the size of group range.
Command Default By default the group range 232.100.100.1 to 232.100.100.255 is assigned if a core range of addresses is not
configured.
Command Modes LISP Interface Configuration (config-if)
Command History Release Modification
Cisco IOS XE 16.9.1 This command was introduced.
Usage Guidelines Native multicast transport supports only PIM SSM in the underlay or the core. Multicast transport uses a
grouping mechanism to map the end-point identifiers (EID) entries to the RLOC space SSM group entries.
By default, the group range 232.100.100.1 to 232.100.100.255 is used as the SSM range of addresses on a
LISP interface to transport multicast traffic. Use the ip pim lisp core-group-range command to manually
change this SSM core group range of IP addresses on the LISP interfaces.
The following example defines a group of 1000 IP addresses starting from 232.0.0.1 as the SSM range of
addresses on the core for multicast traffic.
Device(config)#interface LISP0.201
Device(config-if)#ip pim lisp core-group-range 232.0.0.1 1000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
33
Cisco SD-Access
ip pim lisp transport multicast
ip pim lisp transport multicast
To enable multicast as the transport mechanism on LISP interface and sub-interface, use the ip pim lisp
transport multicast command in the LISP Interface Configuration mode. To disable multicast as the transport
mechanism on the LISP interface, use the no form of this command
[no]ip pim lisp transport multicast
Syntax Description
This command has no keywords or arguments.
Command Default If this command is not configured, head-end replication is used for multicast.
Command Modes LISP Interface Configuration (config-if)
Command History Release Modification
Cisco IOS XE 16.9.1 This command was introduced.
Example
The following example configures multicast as the transport mechanism on a LISP Interface:
Device(config)#interface LISP0
Device(config-if)#ip pim lisp transport multicast
Related Commands Command Description
ip multicast routing Enables ip multicast routing or multicast distributed
switching.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
34
Cisco SD-Access
ip pim rp-address
ip pim rp-address
To configure the address of a Protocol Independent Multicast (PIM) rendezvous point (RP) for a particular
group, use the ip pim rp-address command in global configuration mode. To remove an RP address, use
the no form of this command
[no]ip pim [vrfvrf-name] rp-address rp-address[access-list]
Syntax Description vrf Optional) Specifies the multicast Virtual Private Network (VPN) routing and forwarding (VRF)
instance.
vrf-name (Optional) Name assigned to the VRF.
rp-address IP address of a router to be a PIM RP. This is a unicast IP address in four-part dotted-decimal
notation.
access-list (Optional) Number or name of an access list that defines the multicast groups for which the RP
should be used.
Command Default None.
Command Modes Global Configuration (config)
Command History Release Modification
Cisco IOS XE 16.8.1s This command was introduced.
Usage Guidelines Use the ip pim rp-address command to statically define the RP address for multicast groups that are to operate
in sparse mode or bidirectional mode.
You can configure the Cisco IOS software to use a single RP for more than one group. The conditions specified
by the access list determine for which groups the RP can be used. If no access list is configured, the RP is
used for all groups. A PIM router can use multiple RPs, but only one per group.
The following example sets the PIM RP address to 185.1.1.1 for all multicast groups:
Device(config)#ip pim rp-address 185.1.1.1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
35
Cisco SD-Access
ip pim sparse mode
ip pim sparse mode
To enable sparse mode of operation of Protocol Independent Multicast (PIM) on an interface, use the ip pim
sparse-mode command in the Interface Configuration mode. To disable the sparse mode of operation use the
no form of this command
[no]ip pim sparse mode{
Syntax Description
This command has no keywords or arguments.
Command Default None.
Command Modes Interface Configuration (config-if)
Command History Release Modification
Cisco IOS XE 16.8.1s This command was introduced.
Usage Guidelines The NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable
capturing the values in the fields for the flow created with the record. The values in nonkey fields are added
to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey
field does not create a new flow.
The following example configures pim sparse mode of operation:
Device(config)#interface Loopback0
Device(config-if)#ip address 170.1.1.1 255.255.255.0
Device(config-if)#ip pim sparse-mode
Related Commands Command Description
ip multicast routing Enables ip multicast routing or multicast distributed
switching..
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
36
Cisco SD-Access
ipv4 multicast multitopology
ipv4 multicast multitopology
To enable Multicast-Specific RPF topology support for IP Multicast routing, use the ipv4 multicast
multitopology command in the VRF configuration mode. To disable the Multicast-Specific RPF Topology
support, use the no form of this command.
[no]ipv4 multicast multitopology
Syntax Description
This command has no arguments or keywords.
Command Default None.
Command Modes VRF Configuration (config-vrf)
Command History Release Modification
Cisco IOS XE 16.8.1s This command was introduced.
Cisco IOS XE Fuji 16.8.1a
The following example shows how to configure Multicast-Specific RPF Topology:
Device(config)#vrf definition VRF1
Device(config-vrf)#ipv4 multicast multitopology
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
37
Cisco SD-Access
ip pim ssm
ip pim ssm
To define the Source Specific Multicast (SSM) range of IP multicast addresses, use the ip pim ssm command
in global configuration mode. To disable the SSM range, use the no form of this command.
[no]ip pim[vrfvrf-name]ssm{default | range access-list}
Syntax Description vrf Optional) Specifies the multicast Virtual Private Network (VPN) routing and forwarding
(VRF) instance.
vrf-name (Optional) Name assigned to the VRF.
range Specifies the standard IP access list number or name defining the SSM range.
access-list
default2 Defines the SSM range access list to 232/8.
Command Default None.
Command Modes Global Configuration (config)
Command History Release Modification
Cisco IOS XE 16.8.1s This command was introduced.
Usage Guidelines When an SSM range of IP multicast addresses is defined by the ip pim ssm command, no Multicast Source
Discovery Protocol (MSDP) Source-Active (SA) messages will be accepted or originated in the SSM range.
The following example sets the SSM range of IP multicast address to default
Device(config)#ip pim ssm default
Related Commands Command Description
ip multicast routing Enables ip multicast routing or multicast distributed
switching..
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
38
Cisco SD-Access
itr
itr
To configure a device as an Ingress Tunnel Router (ITR) use the itr command in the service submode or
instance-service mode.
[ no ] itr
Command Default The device is not configured as ITR by default.
Command Modes LISP Instance Service (router-lisp-instance-service)
LISP Service (router-lisp-service)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use this command to enable a device to perform the ITR functionality.
Use the no form of the command to remove theITR functionality.
A device configured as an ITR helps find the EID-to-RLOC mapping for all traffic destined to LISP-capable
sites.
The following example shows how to configure a device as an ITR.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#itr
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
39
Cisco SD-Access
itr map-resolver
itr map-resolver
To configure a device as a map resolver to be used by an Ingress Tunnel Router (ITR) when sending
map-requests, use the itr map-resolver command in the service submode or instance-service mode.
[no]itr [map-resolver map-address]prefix-list prefix-list-name
Syntax Description map-resolver map-address Configures map-resolver address for sending map requests, on the ITR.
prefix-list prefix-list-name Specifies the prefix list to be used.
Command Default None.
Command Modes router-lisp-instance-service
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Cisco IOS XE Fuji 16.9.1 Introduced prefix-list as part of the command.
Usage Guidelines Use this command to enable a device to perform the ITR map-resolver functionality.
Use the no form of the command to remove the map-resolver functionality.
A device configured as a Map Resolver accepts encapsulated Map-Request messages from ITRs, decapsulates
those messages, and then forwards the messages to the Map Server responsible for the egress tunnel routers
(ETRs) that are authoritative for the requested EIDs. In a multi-site environment, the site border relies on Map
Resolver prefix-list to determine whether to query the transit site MSMR or site MSMR.
The following example shows how to configure an ITR to use the map-resolver located at 2.1.1.6 when sending
map request messages.
device(config)#router lisp
device(config-router-lisp)#prefix-list wired
device(config-router-lisp-prefix-list)#2001:193:168:1::/64
device(config-router-lisp-prefix-list)#192.168.0.0/16
device(config-router-lisp-prefix-list)#exit-prefix-list
device(config-router-lisp)#service ipv4
device(config-router-lisp-serv-ipv4)#encapsulation vxlan
device(config-router-lisp-serv-ipv4)#itr map-resolver 2.1.1.6 prefix-list wired
device(config-router-lisp-serv-ipv4)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
40
Cisco SD-Access
locator default-set
locator default-set
To mark a locator-set as default, use the locator default-set command at the router-lisp level.
[no] locator default-set rloc-set-name
Syntax Description rloc-set-name The name of locator-set that is set as default.
Command Default None
Command Modes LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The locator-set configured as default with the locator default-set command applies to all services and
instances.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
41
Cisco SD-Access
locator-set
locator-set
To specify a locator-set and enter the locator-set configuration mode, use the locator-set command at the
router-lisp level.
[no] locator-set loc-set-name
Syntax Description loc-set-name The name of
locator-set.
Command Default Name
Command Modes LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines You must first define the locator-set before referring to it.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
42
Cisco SD-Access
map-cache
map-cache
To configure a static endpoint identifier (EID) to routing locator (RLOC) (EID-to-RLOC) mapping relationship,
use the map-cache command in the instance-service ipv4 or instance-service ipv6 mode.
[no ]map-cache destination-eid-prefix/prefix-len {ipv4-address { priority priority weight weight }
| ipv6-address | map-request | native-forward}
Syntax Description destination-eid-prefix/prefix-len Destination IPv4 or IPv6 EID-prefix/prefix-length. The slash is required
in the syntax.
ipv4-address priority priority IPv4 Address of loopback interface. Associated with this locator address
weight weight is a priority and weight that are used to define traffic policies when
multiple RLOCs are defined for the same EID-prefix block.
Note Lower priority locator takes preference.
ipv6-address IPv6 Address of loopback interface.
map-request Send map-request for LISP destination EID
native-forward Natively forward packets that match this map-request.
Command Default None.
Command Modes LISP Instance Service (router-lisp-instance-service)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The first use of this command is to configure an Ingress Tunnel Router (ITR) with a static IPv4 or IPv6
EID-to-RLOC mapping relationship and its associated traffic policy. For each entry, a destination EID-prefix
block and its associated locator, priority, and weight are entered. The value in the EID-prefix/prefix-length
argument is the LISP EID-prefix block at the destination site. The locator is an IPv4 or IPv6 address of the
remote site where the IPv4 or IPv6 EID-prefix can be reached. Associated with the locator address is a priority
and weight that are used to define traffic policies when multiple RLOCs are defined for the same EID-prefix
block.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#map-cache 1.1.1.1/24 map-request
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
43
Cisco SD-Access
map-cache extranet
map-cache extranet
To install all configured extranet prefixes into map-cache, use the map-cache extranet command in the
instance-service ipv4 or instance-service ipv6 mode.
map-cache extranet-registration
Command Default None.
Command Modes LISP Instance Service (router-lisp-instance-service)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines To support inter-VRF communication, use the map-cache extranet command on the Map Server Map
Resolver (MSMR). This command generates map requests for all fabric destinations. Use this command in
the service ipv4 or service ipv6 mode under the extranet instance.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#map-cache extranet-registration
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
44
Cisco SD-Access
prefix-list
prefix-list
To define a named LISP prefix set and to enter the LISP prefix-list configuration mode, use the prefix-list
command in the Router LISP configuration mode. Use the no form of the command to remove the prefix list.
[no]prefix-list prefix-list-name
Syntax Description prefix-list prefix-list-name Specifies the prefix list to be used and enters the prefix-list configuration mode.
Specifies IPv4 EID-prefixes or IPv6 EID-prefixes in the prefix-list mode.
Command Default No prefix list is defined.
Command Modes LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Fuji This command was
16.9.1 introduced.
Usage Guidelines Use the prefix-list command to configure an IPV4 or IPv6 prefix list. This command places the router in
prefix-list configuration mode, in which you can define IPv4 prefix list, or IPv6 prefix list. Use the
exit-prefix-list command to exit the prefix-list-configuration mode.
device(config)#router lisp
device(config-router-lisp)#prefix-list wired
device(config-router-prefix-list)#2001:193:168:1::/64
device(config-router-lisp-prefix-list)#192.168.0.0/16
device(config-router-lisp-prefix-list)#exit-prefix-list
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
45
Cisco SD-Access
route-import database
route-import database
To configure the import of Routing Information Base (RIB) routes to define local endpoint identifier (EID)
prefixes for database entries and associate them with a locator set, use the route-import database command
in the instance service submode. To remove this configuration, use the no form of this command.
[no] route-import database
{bgp|connected|eigrp|isis|maximum-prefix|ospf|ospfv3|rip|static}{[route-map]locator-set
locator-set-name proxy}
Syntax Description bgp Border Gateway Protocol. Imports RIB routes into LISP using BGP protocol.
connected Connected routing protocol
eigrp Enhanced Interior Gateway Routing Protocol. Imports RIB routes into LISP
using EIGRP protocol.
isis ISO IS-IS. Imports RIB routes into LISP using IS-IS protocol.
ospf Open Shortest Path First
ospfv3 Open Shortest Path First version 3
maximum-prefix Configures the maximum number of prefixes to pick up from the RIB.
rip Routing Information Protocol
static Defines static routes.
locator-set Specifies the Locator Set to be used with created database mapping entries.
locator-set-name
proxy Enables the dynamic import of RIB route as proxy database mapping.
Command Default None.
Command Modes LISP Instance Service (router-lisp-instance-service)
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines Use the route-import database command with the proxy option to enable the dynamic import of RIB route
as proxy database mapping. When RIB import is in use, the corresponding RIB map-cache import, using
route-import map-cache command must also be configured, else the inbound site traffic will not pass the
LISP eligibility check due to the presence of RIB route.
The following example shows how to configure the dynamic import of RIB route as proxy database:
device(config)#router lisp
device(config-router-lisp)#instance-id 3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
46
Cisco SD-Access
route-import database
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#eid-table default
device(config-router-lisp-inst-serv-ipv4)#database-mapping 193.168.0.0/16 locator-set RLOC
proxy
device(config-router-lisp-inst-serv-ipv4)#route-import map-cache bgp 65002 route-map
map-cache-database
device(config-router-lisp-inst-serv-ipv4)#route-import database bgp 65002 locator-set RLOC
proxy
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
47
Cisco SD-Access
service
service
The service command creates a configuration template for all instance-service instantiations of that particular
service.
[no]service{ipv4 | ipv6 |ethernet}
Syntax Description service ipv4 Enables Layer 3 network services for the IPv4 Address family.
service ipv6 Enables Layer 3 network services for the IPv6 Address family.
service ethernet Enables Layer 2 network services.
Command Default None.
Command Modes LISP Instance (router-lisp-instance)
LISP (router-lisp)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The service command creates a service instance under the instance-id and enters the instance-service mode.
You cannot confgure service ethernet for the same instance where service ipv4 or service ipv6 is configured.
Use the no form of the command to exit the service submode.
device(config)#router lisp
device(config-router-lisp)#instance-id 3
device(config-router-lisp-inst)#service ipv4
device(config-router-lisp-inst-serv-ipv4)#
device(config)#router lisp
device(config-router-lisp)#instance-id 5
device(config-router-lisp-inst)#service ethernet
device(config-router-lisp-inst-serv-ethernet)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
48
Cisco SD-Access
show lisp instance-id ipv4 database
show lisp instance-id ipv4 database
To display the operational status of the IPv4 address family and the database mappings on the device, use the
show lisp instance-id ipv4 database command in the privileged EXEC mode.
show lisp instance-id instance-id ipv4 database
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Fuji 16.9.1 Support for display of proxy database size.
Usage Guidelines Use the command show lisp instance-id id ipv4 database to display the EID prefixes configured for a site.
The following is a sample output:
device#show lisp instance-id 101 ipv4 database
LISP ETR IPv4 Mapping Database for EID-table vrf red (IID 101), LSBs: 0x1
Entries total 1, no-route 0, inactive 0
172.168.0.0/16, locator-set RLOC, proxy
Locator Pri/Wgt Source State
100.110.110.110 1/100 cfg-intf site-self, reachable
device#
device#show lisp instance-id 101 ipv4
Instance ID: 101
Router-lisp ID: 0
Locator table: default
EID table: vrf red
Ingress Tunnel Router (ITR): disabled
Egress Tunnel Router (ETR): enabled
Proxy-ITR Router (PITR): enabled RLOCs: 100.110.110.110
Proxy-ETR Router (PETR): disabled
NAT-traversal Router (NAT-RTR): disabled
Mobility First-Hop Router: disabled
Map Server (MS): enabled
Map Resolver (MR): enabled
Mr-use-petr: enabled
Mr-use-petr locator set name: site2
Delegated Database Tree (DDT): disabled
Site Registration Limit: 0
Map-Request source: derived from EID destination
ITR Map-Resolver(s): 100.77.77.77
100.78.78.78
100.110.110.110 prefix-list site2
ETR Map-Server(s): 100.77.77.77 (11:25:01)
100.78.78.78 (11:25:01)
xTR-ID: 0xB843200A-0x4566BFC9-0xDAA75B2D-0x8FBE69B0
site-ID: unspecified
ITR local RLOC (last resort): 100.110.110.110
ITR Solicit Map Request (SMR): accept and process
Max SMRs per map-cache entry: 8 more specifics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
49
Cisco SD-Access
show lisp instance-id ipv4 database
Multiple SMR suppression time: 20 secs
ETR accept mapping data: disabled, verify disabled
ETR map-cache TTL: 1d00h
Locator Status Algorithms:
RLOC-probe algorithm: disabled
RLOC-probe on route change: N/A (periodic probing disabled)
RLOC-probe on member change: disabled
LSB reports: process
IPv4 RLOC minimum mask length: /0
IPv6 RLOC minimum mask length: /0
Map-cache:
Static mappings configured: 1
Map-cache size/limit: 1/32768
Imported route count/limit: 0/5000
Map-cache activity check period: 60 secs
Map-cache FIB updates: established
Persistent map-cache: disabled
Database:
Total database mapping size: 1
static database size/limit: 1/65535
dynamic database size/limit: 0/65535
route-import database size/limit: 0/5000
import-site-reg database size/limit0/65535
proxy database size: 1
Inactive (deconfig/away) size: 0
Encapsulation type: vxlan
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
50
Cisco SD-Access
show lisp instance-id ipv6 database
show lisp instance-id ipv6 database
To display the operational status of the IPv6 address family and the database mappings on the device, use the
show lisp instance-id ipv6 database command in the privileged EXEC mode.
show lisp instance-id instance-id ipv6 database
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Fuji 16.9.1 Support for display of proxy database size.
Usage Guidelines Use the command show lisp instance-id id ipv6 database to display the EID prefixes configured for a site.
The following is a sample output:
device#show lisp instance-id 101 ipv6 database
LISP ETR IPv6 Mapping Database, LSBs: 0x1
EID-prefix: 2610:D0:1209::/48
172.16.156.222, priority: 1, weight: 100, state: up, local
device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
51
Cisco SD-Access
show lisp instance-id ipv4 map-cache
show lisp instance-id ipv4 map-cache
To display the IPv4 end point identifier (EID) to the Resource Locator (RLOC) cache mapping on an ITR,
use the show lisp instance-id ipv4 map-cache command in the privileged Exec mode.
show lisp instance-id instance-id ipv4 map-cache[destination-EID|destination-EID-prefix |detail]
Syntax Description destination-EID (Optional) Specifies the IPv4 destination end point identifier (EID) for which the
EID-to-RLOC mapping is displayed.
destination-EID-prefix (Optional) Specifies the IPv4 destinationEID prefix (in the form of a.b.c.d/nn) for
which to display the mapping.
detail (Optional) Displays detailed EID-to-RLOC cache mapping information.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.5.1a Introduced this
command.
Usage Guidelines This command is used to display the current dynamic and static IPv4 EID-to-RLOC map-cache entries. When
no IPv4 EID or IPv4 EID prefix is specified, summary information is listed for all current dynamic and static
IPv4 EID-to-RLOC map-cache entries. When an IPv4 EID or IPv4 EID prefix is included, information is
listed for the longest-match lookup in the cache. When the detail option is used, detailed (rather than summary)
information related to all current dynamic and static IPv4 EID-to-RLOC map-cache entries is displayed.
The following are sample outputs from the show lisp instance-id ipv4 map-cache commands:
device# show lisp instance-id 102 ipv4 map-cache
LISP IPv4 Mapping Cache for EID-table vrf blue (IID 102), 4008 entries
0.0.0.0/0, uptime: 2d14h, expires: never, via static-send-map-request
Negative cache entry, action: send-map-request
128.0.0.0/3, uptime: 00:01:44, expires: 00:13:15, via map-reply, unknown-eid-forward
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:32:40 up 1/100 103
55.55.55.2 13:32:40 up 1/100 103
55.55.55.3 13:32:40 up 1/100 103
55.55.55.4 13:32:40 up 1/100 103
55.55.55.5 13:32:40 up 5/100 103
55.55.55.6 13:32:40 up 6/100 103
55.55.55.7 13:32:40 up 7/100 103
55.55.55.8 13:32:40 up 8/100 103
150.150.2.0/23, uptime: 11:47:25, expires: 00:06:30, via map-reply, unknown-eid-forward
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:32:40 up 1/100 103
55.55.55.2 13:32:40 up 1/100 103
55.55.55.3 13:32:40 up 1/100 103
55.55.55.4 13:32:40 up 1/100 103
55.55.55.5 13:32:40 up 5/100 103
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
52
Cisco SD-Access
show lisp instance-id ipv4 map-cache
55.55.55.6 13:32:40 up 6/100 103
55.55.55.7 13:32:43 up 7/100 103
55.55.55.8 13:32:43 up 8/100 103
150.150.4.0/22, uptime: 13:32:43, expires: 00:05:19, via map-reply, unknown-eid-forward
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:32:43 up 1/100 103
55.55.55.2 13:32:43 up 1/100 103
55.55.55.3 13:32:43 up 1/100 103
55.55.55.4 13:32:43 up 1/100 103
55.55.55.5 13:32:43 up 5/100 103
55.55.55.6 13:32:43 up 6/100 103
55.55.55.7 13:32:43 up 7/100 103
55.55.55.8 13:32:43 up 8/100 103
150.150.8.0/21, uptime: 13:32:35, expires: 00:05:27, via map-reply, unknown-eid-forward
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:32:43 up 1/100 103
55.55.55.2 13:32:43 up 1/100 103
55.55.55.3 13:32:43 up 1/100 103
55.55.55.4 13:32:43 up 1/100 103
55.55.55.5 13:32:43 up 5/100 103
55.55.55.6 13:32:43 up 6/100 103
55.55.55.7 13:32:43 up 7/100 103
55.55.55.8 13:32:45 up 8/100 103
171.171.0.0/16, uptime: 2d14h, expires: never, via dynamic-EID, send-map-request
Negative cache entry, action: send-map-request
172.172.0.0/16, uptime: 2d14h, expires: never, via dynamic-EID, send-map-request
Negative cache entry, action: send-map-request
178.168.2.1/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
178.168.2.2/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
178.168.2.3/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
178.168.2.4/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
178.168.2.5/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
178.168.2.6/32, uptime: 2d14h, expires: 09:27:13, via map-reply, complete
Locator Uptime State Pri/Wgt Encap-IID
device#show lisp instance-id 102 ipv4 map-cache detail
LISP IPv4 Mapping Cache for EID-table vrf blue (IID 102), 4008 entries
0.0.0.0/0, uptime: 2d15h, expires: never, via static-send-map-request
Sources: static-send-map-request
State: send-map-request, last modified: 2d15h, map-source: local
Exempt, Packets out: 30531(17585856 bytes) (~ 00:01:36 ago)
Configured as EID address space
Negative cache entry, action: send-map-request
128.0.0.0/3, uptime: 00:02:02, expires: 00:12:57, via map-reply, unknown-eid-forward
Sources: map-reply
State: unknown-eid-forward, last modified: 00:02:02, map-source: local
Active, Packets out: 9(5184 bytes) (~ 00:00:36 ago)
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:32:58 up 1/100 103
55.55.55.2 13:32:58 up 1/100 103
55.55.55.3 13:32:58 up 1/100 103
55.55.55.4 13:32:58 up 1/100 103
55.55.55.5 13:32:58 up 5/100 103
55.55.55.6 13:32:58 up 6/100 103
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
53
Cisco SD-Access
show lisp instance-id ipv4 map-cache
55.55.55.7 13:32:58 up 7/100 103
55.55.55.8 13:32:58 up 8/100 103
150.150.2.0/23, uptime: 11:47:43, expires: 00:06:12, via map-reply, unknown-eid-forward
Sources: map-reply
State: unknown-eid-forward, last modified: 11:47:44, map-source: local
Active, Packets out: 4243(2443968 bytes) (~ 00:00:38 ago)
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:33:00 up 1/100 103
55.55.55.2 13:33:00 up 1/100 103
55.55.55.3 13:33:00 up 1/100 103
55.55.55.4 13:33:00 up 1/100 103
55.55.55.5 13:33:00 up 5/100 103
55.55.55.6 13:33:00 up 6/100 103
55.55.55.7 13:33:00 up 7/100 103
55.55.55.8 13:33:00 up 8/100 103
150.150.4.0/22, uptime: 13:33:00, expires: 00:05:02, via map-reply, unknown-eid-forward
Sources: map-reply
State: unknown-eid-forward, last modified: 13:33:00, map-source: local
Active, Packets out: 4874(2807424 bytes) (~ 00:00:38 ago)
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:33:00 up 1/100 103
55.55.55.2 13:33:00 up 1/100 103
55.55.55.3 13:33:00 up 1/100 103
55.55.55.4 13:33:00 up 1/100 103
55.55.55.5 13:33:00 up 5/100 103
55.55.55.6 13:33:00 up 6/100 103
55.55.55.7 13:33:01 up 7/100 103
55.55.55.8 13:33:01 up 8/100 103
150.150.8.0/21, uptime: 13:32:53, expires: 00:05:09, via map-reply, unknown-eid-forward
Sources: map-reply
State: unknown-eid-forward, last modified: 13:32:53, map-source: local
Active, Packets out: 4874(2807424 bytes) (~ 00:00:39 ago)
PETR Uptime State Pri/Wgt Encap-IID
55.55.55.1 13:33:01 up 1/100 103
55.55.55.2 13:33:01 up 1/100 103
55.55.55.3 13:33:01 up 1/100 103
55.55.55.4 13:33:01 up 1/100 103
55.55.55.5 13:33:01 up 5/100 103
55.55.55.6 13:33:01 up 6/100 103
55.55.55.7 13:33:01 up 7/100 103
55.55.55.8 13:33:01 up 8/100 103
171.171.0.0/16, uptime: 2d15h, expires: never, via dynamic-EID, send-map-request
Sources: NONE
State: send-map-request, last modified: 2d15h, map-source: local
Exempt, Packets out: 2(1152 bytes) (~ 2d14h ago)
Configured as EID address space
Configured as dynamic-EID address space
Encapsulating dynamic-EID traffic
Negative cache entry, action: send-map-request
172.172.0.0/16, uptime: 2d15h, expires: never, via dynamic-EID, send-map-request
Sources: NONE
State: send-map-request, last modified: 2d15h, map-source: local
Exempt, Packets out: 2(1152 bytes) (~ 2d14h ago)
Configured as EID address space
Configured as dynamic-EID address space
Encapsulating dynamic-EID traffic
Negative cache entry, action: send-map-request
178.168.2.1/32, uptime: 2d14h, expires: 09:26:55, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
Active, Packets out: 22513(12967488 bytes) (~ 00:00:41 ago)
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
Last up-down state change: 2d14h, state change count: 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
54
Cisco SD-Access
show lisp instance-id ipv4 map-cache
Last route reachability change: 2d14h, state change count: 1
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: 2d14h (rtt 92ms)
178.168.2.2/32, uptime: 2d14h, expires: 09:26:55, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
Active, Packets out: 22513(12967488 bytes) (~ 00:00:45 ago)
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
Last up-down state change: 2d14h, state change count: 1
Last route reachability change: 2d14h, state change count: 1
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: 2d14h (rtt 91ms)
178.168.2.3/32, uptime: 2d14h, expires: 09:26:51, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
Active, Packets out: 22513(12967488 bytes) (~ 00:00:45 ago)
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
Last up-down state change: 2d14h, state change count: 1
Last route reachability change: 2d14h, state change count: 1
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: 2d14h (rtt 91ms)
178.168.2.4/32, uptime: 2d14h, expires: 09:26:51, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
device#show lisp instance-id 102 ipv4 map-cache 178.168.2.3/32
LISP IPv4 Mapping Cache for EID-table vrf blue (IID 102), 4008 entries
178.168.2.3/32, uptime: 2d14h, expires: 09:26:25, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
Active, Packets out: 22519(12970944 bytes) (~ 00:00:11 ago)
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
Last up-down state change: 2d14h, state change count: 1
Last route reachability change: 2d14h, state change count: 1
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: 2d14h (rtt 91ms)
device#show lisp instance-id 102 ipv4 map-cache 178.168.2.3
LISP IPv4 Mapping Cache for EID-table vrf blue (IID 102), 4008 entries
178.168.2.3/32, uptime: 2d14h, expires: 09:26:14, via map-reply, complete
Sources: map-reply
State: complete, last modified: 2d14h, map-source: 48.1.1.4
Active, Packets out: 22519(12970944 bytes) (~ 00:00:22 ago)
Locator Uptime State Pri/Wgt Encap-IID
11.11.11.1 2d14h up 1/100 -
Last up-down state change: 2d14h, state change count: 1
Last route reachability change: 2d14h, state change count: 1
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: 2d14h (rtt 91ms)
OTT-LISP-C3K-4-xTR2#show lisp instance-id 102 sta
OTT-LISP-C3K-4-xTR2#show lisp instance-id 102 stat
OTT-LISP-C3K-4-xTR2#show lisp instance-id 102 ipv4 stat
OTT-LISP-C3K-4-xTR2#show lisp instance-id 102 ipv4 statistics
LISP EID Statistics for instance ID 102 - last cleared: never
Control Packets:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
55
Cisco SD-Access
show lisp instance-id ipv4 map-cache
Map-Requests in/out: 5911/66032
Map-Request receive rate (5 sec/1 min/5 min): 0.00/ 0.00/ 0.00
Encapsulated Map-Requests in/out: 0/60600
RLOC-probe Map-Requests in/out: 5911/5432
SMR-based Map-Requests in/out: 0/0
Extranet SMR cross-IID Map-Requests in: 0
Map-Requests expired on-queue/no-reply 0/0
Map-Resolver Map-Requests forwarded: 0
Map-Server Map-Requests forwarded: 0
Map-Reply records in/out: 64815/5911
Authoritative records in/out: 12696/5911
Non-authoritative records in/out: 52119/0
Negative records in/out: 8000/0
RLOC-probe records in/out: 4696/5911
Map-Server Proxy-Reply records out: 0
WLC Map-Subscribe records in/out: 0/4
Map-Subscribe failures in/out: 0/0
WLC Map-Unsubscribe records in/out: 0/0
Map-Unsubscribe failures in/out: 0/0
Map-Register records in/out: 0/8310
Map-Register receive rate (5 sec/1 min/5 min): 0.00/ 0.00/ 0.00
Map-Server AF disabled: 0
Authentication failures: 0
WLC Map-Register records in/out: 0/0
WLC AP Map-Register in/out: 0/0
WLC Client Map-Register in/out: 0/0
WLC Map-Register failures in/out: 0/0
Map-Notify records in/out: 20554/0
Authentication failures: 0
WLC Map-Notify records in/out: 0/0
WLC AP Map-Notify in/out: 0/0
WLC Client Map-Notify in/out: 0/0
WLC Map-Notify failures in/out: 0/0
Publish-Subscribe in/out:
Subscription Request records in/out: 0/6
Subscription Request failures in/out: 0/0
Subscription Status records in/out: 4/0
End of Publication records in/out: 4/0
Subscription rejected records in/out: 0/0
Subscription removed records in/out: 0/0
Subscription Status failures in/out: 0/0
Solicit Subscription records in/out: 0/0
Solicit Subscription failures in/out: 0/0
Publication records in/out: 0/0
Publication failures in/out: 0/0
Errors:
Mapping record TTL alerts: 0
Map-Request invalid source rloc drops: 0
Map-Register invalid source rloc drops: 0
DDT Requests failed: 0
DDT ITR Map-Requests dropped: 0 (nonce-collision: 0, bad-xTR-nonce:
0)
Cache Related:
Cache entries created/deleted: 200103/196095
NSF CEF replay entry count 0
Number of EID-prefixes in map-cache: 4008
Number of rejected EID-prefixes due to limit : 0
Number of negative entries in map-cache: 8
Total number of RLOCs in map-cache: 4000
Average RLOCs per EID-prefix: 1
Forwarding:
Number of data signals processed: 199173 (+ dropped 5474)
Number of reachability reports: 0 (+ dropped 0)
Number of SMR signals dropped: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
56
Cisco SD-Access
show lisp instance-id ipv4 map-cache
ITR Map-Resolvers:
Map-Resolver LastReply Metric ReqsSent Positive Negative No-Reply AvgRTT(5
sec/1 min/5 min)
44.44.44.44 00:03:11 6 62253 19675 8000 0 0.00/
0.00/10.00
66.66.66.66 never Unreach 0 0 0 0 0.00/ 0.00/
0.00
ETR Map-Servers:
Map-Server AvgRTT(5 sec/1 min/5 min)
44.44.44.44 0.00/ 0.00/ 0.00
66.66.66.66 0.00/ 0.00/ 0.00
LISP RLOC Statistics - last cleared: never
Control Packets:
RTR Map-Requests forwarded: 0
RTR Map-Notifies forwarded: 0
DDT-Map-Requests in/out: 0/0
DDT-Map-Referrals in/out: 0/0
Errors:
Map-Request format errors: 0
Map-Reply format errors: 0
Map-Referral format errors: 0
LISP Miscellaneous Statistics - last cleared: never
Errors:
Invalid IP version drops: 0
Invalid IP header drops: 0
Invalid IP proto field drops: 0
Invalid packet size drops: 0
Invalid LISP control port drops: 0
Invalid LISP checksum drops: 0
Unsupported LISP packet type drops: 0
Unknown packet drops: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
57
Cisco SD-Access
show lisp instance-id ipv6 map-cache
show lisp instance-id ipv6 map-cache
To display the IPv6 end point identifier (EID) to the Resource Locator (RLOC) cache mapping on an ITR,
use the show lisp instance-id ipv6 map-cache command in the privileged EXEC mode.
show lisp instance-id instance-id ipv6 map-cache[destination-EID|destination-EID-prefix |detail]
Syntax Description destination-EID (Optional) Specifies the IPv4 destination end point identifier (EID) for which the
EID-to-RLOC mapping is displayed.
destination-EID-prefix (Optional) Specifies the IPv4 destination EID prefix (in the form of a.b.c.d/nn) for
which to display the mapping.
detail (Optional) Displays detailed EID-to-RLOC cache mapping information.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.5.1a Introduced this
command.
Usage Guidelines This command is used to display the current dynamic and static IPv6 EID-to-RLOC map-cache entries. When
no IPv6 EID or IPv6 EID prefix is specified, summary information is listed for all current dynamic and static
IPv4 EID-to-RLOC map-cache entries. When an IPv6 EID or IPv6 EID prefix is included, information is
listed for the longest-match lookup in the cache. When the detail option is used, detailed (rather than summary)
information related to all current dynamic and static IPv6 EID-to-RLOC map-cache entries is displayed.
The following is a sample output from the show lisp instance-id ipv6 map-cache command:
device# show lisp instance-id 101 ipv6 map-cache
LISP IPv6 Mapping Cache, 2 entries
::/0, uptime: 00:00:26, expires: never, via static
Negative cache entry, action: send-map-request
2001:DB8:AB::/48, uptime: 00:00:04, expires: 23:59:53, via map-reply, complete
Locator Uptime State Pri/Wgt
10.0.0.6 00:00:04 up 1/100
The following sample output from the show lisp instance-id x ipv6 map-cache detail command displays a
detailed list of current dynamic and static IPv6 EID-to-RLOC map-cache entries:
device#show lisp instance-id 101 ipv6 map-cache detail
LISP IPv6 Mapping Cache, 2 entries
::/0, uptime: 00:00:52, expires: never, via static
State: send-map-request, last modified: 00:00:52, map-source: local
Idle, Packets out: 0
Negative cache entry, action: send-map-request
2001:DB8:AB::/48, uptime: 00:00:30, expires: 23:59:27, via map-reply, complete
State: complete, last modified: 00:00:30, map-source: 10.0.0.6
Active, Packets out: 0
Locator Uptime State Pri/Wgt
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
58
Cisco SD-Access
show lisp instance-id ipv6 map-cache
10.0.0.6 00:00:30 up 1/100
Last up-down state change: never, state change count: 0
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: never
The following sample output from the show ipv6 lisp map-cache command with a specific IPv6 EID prefix
displays detailed information associated with that IPv6 EID prefix entry.
device#show lisp instance-id 101 ipv6 map-cache 2001:DB8:AB::/48
LISP IPv6 Mapping Cache, 2 entries
2001:DB8:AB::/48, uptime: 00:01:02, expires: 23:58:54, via map-reply, complete
State: complete, last modified: 00:01:02, map-source: 10.0.0.6
Active, Packets out: 0
Locator Uptime State Pri/Wgt
10.0.0.6 00:01:02 up 1/100
Last up-down state change: never, state change count: 0
Last priority / weight change: never/never
RLOC-probing loc-status algorithm:
Last RLOC-probe sent: never
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
59
Cisco SD-Access
show lisp instance-id ipv4 server
show lisp instance-id ipv4 server
To display the LISP site registration information, use the show lisp instance-id ipv4 server command in the
privileged EXEC mode.
show lisp instance-id instance-idipv4 server[EID-address|EID-prefix|detail|name|rloc|summary]
Syntax Description EID-address (Optional) Displays site registration information for this end point.
EID-prefix (Optional) Displays site registration information for this IPv4 EID prefix.
detail (Optional) Displays a detailed site information.
name (Optional) Displays the site registration information for the named site.
rloc (Optional) Displays the RLOC-EID instance membership details.
summary (Optional) Displays summary information for each site.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines When a host is detected by the tunnel router (xTR), it registers the host with the map server (MS). Use the
show lisp instance-id x ipv4 server command to see the site registration details. TCP registrations display
the port number, whereas UDP registration do not display port number. The port number is 4342 by default
fir UDP registration.
The following are sample outputs of the command :
device# show lisp instance-id 100 ipv4 server
LISP Site Registration Information
* = Some locators are down or unreachable
# = Some registrations are sourced by reliable transport
Site Name Last Up Who Last Inst EID Prefix
Register Registered ID
XTR 00:03:22 yes*# 172.16.1.4:64200 100 101.1.0.0/16
00:03:16 yes# 172.16.1.3:19881 100 101.1.1.1/32
device# show lisp instance-id 100 ipv4 server 101.1.0.0/16
LISP Site Registration Information
Site name: XTR
Allowed configured locators: any
Requested EID-prefix:
EID-prefix: 101.1.0.0/16 instance-id 100
First registered: 00:04:24
Last registered: 00:04:20
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
60
Cisco SD-Access
show lisp instance-id ipv4 server
Routing table tag: 0
Origin: Configuration, accepting more specifics
Merge active: No
Proxy reply: No
TTL: 1d00h
State: complete
Registration errors:
Authentication failures: 0
Allowed locators mismatch: 0
ETR 172.16.1.4:64200, last registered 00:04:20, no proxy-reply, map-notify
TTL 1d00h, no merge, hash-function sha1, nonce 0xC1ED8EE1-0x553D05D4
state complete, no security-capability
xTR-ID 0x46B2F3A5-0x19B0A3C5-0x67055A44-0xF5BF3FBB
site-ID unspecified
sourced by reliable transport
Locator Local State Pri/Wgt Scope
172.16.1.4 yes admin-down 255/100 IPv4 none
The following is an ouput that shows an UDP registration (without port number):
device# show lisp instance-id 100 ipv4 server 101.1.1.1/32
LISP Site Registration Information
Site name: XTR
Allowed configured locators: any
Requested EID-prefix:
EID-prefix: 101.1.1.1/32 instance-id 100
First registered: 00:00:08
Last registered: 00:00:04
Routing table tag: 0
Origin: Dynamic, more specific of 101.1.0.0/16
Merge active: No
Proxy reply: No
TTL: 1d00h
State: complete
Registration errors:
Authentication failures: 0
Allowed locators mismatch: 0
ETR 172.16.1.3:46245, last registered 00:00:04, no proxy-reply, map-notify
TTL 1d00h, no merge, hash-function sha1, nonce 0x1769BD91-0x06E10A06
state complete, no security-capability
xTR-ID 0x4F5F0056-0xAE270416-0x360B42D6-0x6FCD3F5B
site-ID unspecified
sourced by reliable transport
Locator Local State Pri/Wgt Scope
172.16.1.3 yes up 100/100 IPv4 none
ETR 172.16.1.3, last registered 00:00:08, no proxy-reply, map-notify
TTL 1d00h, no merge, hash-function sha1, nonce 0x1769BD91-0x06E10A06
state complete, no security-capability
xTR-ID 0x4F5F0056-0xAE270416-0x360B42D6-0x6FCD3F5B
site-ID unspecified
Locator Local State Pri/Wgt Scope
172.16.1.3 yes up 100/100 IPv4 none
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
61
Cisco SD-Access
show lisp instance-id ipv6 server
show lisp instance-id ipv6 server
To display the LISP site registration information, use the show lisp instance-id ipv6 server command in the
privileged EXEC mode.
show lisp instance-id instance-idipv6 server[EID-address|EID-prefix|detail|name|rloc|summary]
Syntax Description EID-address (Optional) Displays site registration information for this end point.
EID-prefix (Optional) Displays site registration information for this IPv6 EID prefix.
detail (Optional) Displays a detailed site information.
name (Optional) Displays the site registration information for the named site.
rloc (Optional) Displays the RLOC-EID instance membership details.
summary (Optional) Displays summary information for each site.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines When a host is detected by the tunnel router (xTR), it registers the host with the map server (MS). Use the
show lisp instance-id ipv6 server command to see the site registration details.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
62
Cisco SD-Access
show lisp instance-id ipv4 statistics
show lisp instance-id ipv4 statistics
To display Locator/ID Separation Protocol (LISP) IPv4 address-family packet count statistics, use the show
lisp instance-id ipv4 statistics command in the privileged EXEC mode.
show lisp instance-id instance-id ipv4 statistics
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines This command is used to display IPv4 LISP statistics related to packet encapsulations, de-encapsulations,
map requests, map replies, map registers, and other LISP-related packets.
The following are sample outputs of the command :
device# show lisp instance-id 100 ipv4 statistics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
63
Cisco SD-Access
show lisp instance-id ipv6 statistics
show lisp instance-id ipv6 statistics
To display Locator/ID Separation Protocol (LISP) IPv6 address-family packet count statistics, use the show
lisp instance-id ipv6 statistics command in the privileged EXEC mode.
show lisp instance-id instance-id ipv6 statistics
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines This command is used to display IPv4 LISP statistics related to packet encapsulations, de-encapsulations,
map requests, map replies, map registers, and other LISP-related packets.
The following are sample outputs of the command :
device# show lisp instance-id 100 ipv6 statistics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
64
Cisco SD-Access
show lisp prefix-list
show lisp prefix-list
To display the LISP prefix-list information, use the show lisp prefix-list command in the privileged EXEC
mode.
show lisp prefix-list [name-prefix-list]
Syntax Description name-prefix-list (Optional) Specifies the prefix-list whose information is displayed.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Fuji This command was
16.9.1 introduced.
Usage Guidelines The following is a sample output from the show lisp prefix-list command:
device# show lisp prefix-list
Lisp Prefix List information for router lisp 0
Prefix List: set
Number of entries: 1
Entries:
1.2.3.4/16
Sources: static
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
65
Cisco SD-Access
show lisp session
show lisp session
To display the current list of reliable transport sessions in the fabric, use the show lisp session command in
the privileged EXEC mode.
show lisp session [all|established]
Syntax Description all (Optional) Displays transport session inforamtion for all the sessions.
established (Optional) Displays transport session information for established connections.
Command Default None.
Command Modes Privileged Exec
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines The show lisp session command displays only those sessions that are in Up or Down state. Use the show lisp
session all command to see all sessions in any state.
The following is a sample output of the command show lisp session on an MSMR:
device# show lisp session
Sessions for VRF default, total: 4, established: 2
Peer State Up/Down In/Out Users
172.16.1.3:22667 Up 00:00:52 4/8 2
172.16.1.4:18904 Up 00:22:15 5/13 1
device# show lisp session all
Sessions for VRF default, total: 4, established: 2
Peer State Up/Down In/Out Users
172.16.1.3 Listening never 0/0 0
172.16.1.3:22667 Up 00:01:13 4/8 2
172.16.1.4 Listening never 0/0 0
172.16.1.4:18904 Up 00:22:36 5/13 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
66
Cisco SD-Access
use-petr
use-petr
To configure a router to use an IPv4 or IPv6 Locator/ID Separation Protocol (LISP) Proxy Egress Tunnel
Router (PETR), use the use-petr command in LISP Instance configuration mode or LISP Instance Service
configuration mode. To remove the use of a LISP PETR, use the no form of this command.
[no]use-petr locator-address[priority priority weight weight]
Syntax Description locator-address The name of locator-set that is set as default.
priority priority (Optional) Specifies the priority (value between 0 and 255) assigned to this PETR. A
lower value indicates a higher priority.
weight weight (Optional) Specifies the percentage of traffic to be load-shared (value between 0 and 100).
Command Default The router does not use PETR services.
Command Modes LISP Service (router-lisp-service)
LISP Instance-Service (router-lisp-instance-service)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the use-petr command to enable an Ingress Tunnel Router (ITR) or Proxy Ingress Tunnel Router (PITR)
to use IPv4 Proxy Egress Tunnel Router (PETR) services. When the use of PETR services is enabled, instead
of natively forwarding LISP endpoint identifier (EID) (source) packets destined to non-LISP sites, these
packets are LISP-encapsulated and forwarded to the PETR. Upon receiving these packets, the PETR
decapsulates them and then forwards them natively toward the non-LISP destination.
Do not use use-petr command in Service-Ethernet configuration mode.
PETR services may be necessary in several cases:
1. By default when a LISP site forwards packets to a non-LISP site natively (not LISP encapsulated), the
source IP address of the packet is that of an EID. When the provider side of the access network is configured
with strict unicast reverse path forwarding (uRPF) or an anti-spoofing access list, it may consider these
packets to be spoofed and drop them since EIDs are not advertised in the provider core network. In this
case, instead of natively forwarding packets destined to non-LISP sites, the ITR encapsulates these packets
using its site locator(s) as the source address and the PETR as the destination address.
Note The use of the use-petr command does not change LISP-to-LISP or non-LISP-to-non-LISP forwarding
behavior. LISP EID packets destined for LISP sites will follow normal LISP forwarding processes and be
sent directly to the destination ETR as normal. Non-LISP-to-non-LISP packets are never candidates for LISP
encapsulation and are always forwarded natively according to normal processes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
67
Cisco SD-Access
use-petr
2. When a LISP IPv6 (EID) site needs to connect to a non-LISP IPv6 site and the ITR locators or some
portion of the intermediate network does not support IPv6 (it is IPv4 only), the PETR can be used to
traverse (hop over) the address family incompatibility, assuming that the PETR has both IPv4 and IPv6
connectivity. The ITR in this case can LISP-encapsulate the IPv6 EIDs with IPv4 locators destined for
the PETR, which de-encapsulates the packets and forwards them natively to the non-LISP IPv6 site over
its IPv6 connection. In this case, the use of the PETR effectively allows the LISP site packets to traverse
the IPv4 portion of network using the LISP mixed protocol encapsulation support.
Examples The following example shows how to configure an ITR to use the PETR with the IPv4 locator of
10.1.1.1. In this case, LISP site IPv4 EIDs destined to non-LISP IPv4 sites are encapsulated in an
IPv4 LISP header destined to the PETR located at 10.1.1.1:
device(config)# router lisp
device(config-router-lisp)#service ipv4
device(config-router-lisp-serv-ipv4)# use-petr 10.1.1.1
The following example configures an ITR to use two PETRs: one has an IPv4 locator of 10.1.1.1
and is configured as the primary PETR (priority 1 weight 100), and the other has an IPv4 locator of
10.1.2.1 and is configured as the secondary PETR (priority 2 weight 100). In this case, LISP site
IPv4 EIDs destined to non-LISP IPv4 sites will be encapsulated in an IPv4 LISP header to the primary
PETR located at 10.1.1.1 unless it fails, in which case the secondary will be used.
Router(config-router-lisp-serv-ipv4)# use-petr 10.1.1.1 priority 1 weight 100
Router(config-router-lisp-serv-ipv4)# use-petr 10.1.2.1 priority 2 weight 100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
68
PA R T II
Cisco TrustSec
• Cisco TrustSec Commands, on page 71
Cisco TrustSec Commands
• address (CTS), on page 73
• clear cts environment-data, on page 74
• clear cts policy-server statistics, on page 75
• content-type json, on page 76
• cts authorization list, on page 77
• cts change-password, on page 78
• cts credentials, on page 79
• cts environment-data enable, on page 81
• cts policy-server device-id, on page 82
• cts policy-server name, on page 83
• cts policy-server order random, on page 84
• cts policy-server username, on page 85
• cts refresh, on page 86
• cts rekey, on page 88
• cts role-based enforcement, on page 89
• cts role-based l2-vrf, on page 90
• cts role-based monitor, on page 92
• cts role-based permissions, on page 93
• cts role-based sgt-caching, on page 95
• cts role-based sgt-map, on page 96
• cts sxp connection peer, on page 98
• cts sxp default password, on page 101
• cts sxp default source-ip, on page 103
• cts sxp filter-enable, on page 105
• cts sxp filter-group, on page 106
• cts sxp filter-list, on page 108
• cts sxp log binding-changes, on page 110
• cts sxp reconciliation period, on page 111
• cts sxp retry period, on page 112
• debug cts environment-data, on page 113
• debug cts policy-server, on page 115
• port (CTS), on page 116
• propagate sgt (cts manual), on page 117
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
71
Cisco TrustSec
• retransmit (CTS), on page 119
• sap mode-list (cts manual), on page 120
• show cts credentials, on page 122
• show cts environment-data, on page 123
• show cts interface, on page 124
• show cts policy-server, on page 126
• show cts role-based counters, on page 129
• show cts role-based permissions, on page 131
• show cts server-list, on page 133
• show cts sxp, on page 135
• show platform hardware fed switch active fwd-asic resource tcam utilization , on page 138
• show platform hardware fed switch active sgacl resource usage, on page 140
• show platform software classification switch active F0 class-group-manager class-group client acl all,
on page 141
• show platform software cts forwarding-manager switch active F0 port, on page 142
• show platform software cts forwarding-manager switch active F0, on page 146
• show platform software cts forwarding-manager switch active F0 permissions, on page 147
• show platform software fed switch active acl counters hardware | inc SGACL , on page 149
• show platform software fed switch active acl usage , on page 150
• show platform software fed switch active ifm mappings , on page 151
• show platform software fed switch active ip route , on page 153
• show platform software fed switch active sgacl detail , on page 155
• show platform software fed switch active sgacl port , on page 156
• show platform software fed switch active sgacl vlan , on page 158
• show platform software status control-processor brief, on page 159
• show monitor capture <name> buffer, on page 160
• timeout (CTS), on page 161
• tls server-trustpoint, on page 162
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
72
Cisco TrustSec
address (CTS)
address (CTS)
To configure the Cisco TrustSec policy-server address, use the address command in policy-server configuration
mode. To remove the address of the policy server, use the no form of this command.
address {domain-name name | ipv4 policy-server-address | ipv6 policy-server-address}
no address {domain-name | ipv4 | ipv6}
Syntax Description domain-name name Specifies the domain name of the
policy server.
ipv4 policy-server-address Specifies the IP address of the policy
server.
ipv6 Specifies the IPv6 address of the
policy server.
Command Default Policy server address is not configured.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines Configure the policy server name to enter the policy-server configuration mode.
Examples The following example shows how configure the domain name of the policy-server:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# address domain-name ISE_domain
The following example shows how configure the IP address of the policy-server:
Device# enable
Device# configure terminal
Device(config)# cts policy-server name ise_server_2
Device(config-policy-server)# address ipv4 10.1.1.1
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
73
Cisco TrustSec
clear cts environment-data
clear cts environment-data
To clear Cisco TrustSec environment data, use the clear cts environment-data command in privileged EXEC
mode.
clear cts environment-data
This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to clear environment data:
Device# enable
Device# clear cts environment-data
Related Commands Command Description
cts environment-data enable Enables the download of environment data.
debug cts environment-data Enables the debugging of Cisco TrustSec
environment data operations.
show cts environment-data Displays Cisco TrustSec environment data
information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
74
Cisco TrustSec
clear cts policy-server statistics
clear cts policy-server statistics
To clear Cisco TrustSec policy-server statistics, use the clear cts policy-server statistics command in privileged
EXEC mode.
clear cts policy-server statistics {active | all}
Syntax Description active Clears statistics of all active policy
servers.
all Clears all policy server statistics.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to clear all policy-server statistics:
Device# enable
Device# clear cts policy-server statistics all
Related Commands Command Description
cts policy-server name Configures a Cisco TrustSec policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
75
Cisco TrustSec
content-type json
content-type json
To enable the JavaScript Object Notation (JSON) as the content type, use the content-type json command
in policy-server configuration mode. To remove the content-type, use the no form of this command.
content-type json
no content-type json
This command has no arguments or keywords.
Command Default JSON content-type is enabled.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines JSON is used as the content-type to download Security Group access control lists (SGACLs) and environment
data from the Cisco Identity Services Engine (ISE).
Examples The following example shows how to enable the JSON content-type:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# content-type json
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
76
Cisco TrustSec
cts authorization list
cts authorization list
To specify a list of authentication, authorization, and accounting (AAA) servers to be used by the TrustSec
seed device, use the cts authorization list command on the Cisco TrustSec seed device in global configuration
mode. Use the no form of the command to stop using the list during authentication.
cts authorization list server_list
no cts authorization list server_list
Syntax Description server_list Cisco TrustSec AAA server group.
Command Default None
Command Modes Global configuration (config)
Supported User Roles
Administrator
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines This command is only for the seed device. Non-seed devices obtain the TrustSec AAA server list from their
TrustSec authenticator peer as a component of their TrustSec environment data.
The following example displays an AAA configuration of a TrustSec seed device:
Device# cts credentials id Device1 password Cisco123
Device# configure terminal
Device(config)# aaa new-model
Device(config)# aaa authentication dot1x default group radius
Device(config)# aaa authorization network MLIST group radius
Device(config)# cts authorization list MLIST
Device(config)# aaa accounting dot1x default start-stop group radius
Device(config)# radius-server host 10.20.3.1 auth-port 1812 acct-port 1813 pac key
AbCe1234
Device(config)# radius-server vsa send authentication
Device(config)# dot1x system-auth-control
Device(config)# exit
Related Commands Command Description
show cts Displays RADIUS server configurations.
server-list
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
77
Cisco TrustSec
cts change-password
cts change-password
To change the password between the local device and the authentication server, use the cts change-password
privileged EXEC command.
cts change-password server ipv4_address udp_port {a-id hex_string | key radius_key }[{source
interface_list}]
Syntax Description server Specifies the authentication server.
ipv4_address IP address of the authentication server.
udp_port UPD port of the authentication server.
a-id hex_string Specifies the identification string of the ACS server.
key Specifies the RADIUS key to be used for provisioning.
source interface_list (Optional) Specifies the interface type and its identifying parameters as per the displayed
list for source address in request packets.
Command Default None.
Command Modes Privileged EXEC (#)
Supported User Roles
Administrator
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines The cts change-password command allows an administrator to change the password used between the local
device and the Cisco Secure ACS authentication server, without having to reconfigure the authentication
server.
The following example shows how to change the Cisco TrustSec password between a switch and a
Cisco Secure ACS:
Device# cts change-password server 192.168.2.2 88 a-id ffef
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
78
Cisco TrustSec
cts credentials
cts credentials
Use the cts credentials command in privileged EXEC mode to specify the TrustSec ID and password of the
network device. Use the clear cts credentials command to delete the credentials.
cts credentials id cts_id password cts_pwd
Syntax Description credentials id cts_id Specifies the Cisco TrustSec device ID for this device to use when authenticating
with other Cisco TrustSec devices with EAP-FAST. The cts-id variable has a maximum
length of 32 characters and is case sensitive.
password cts_pwd Specifies the password for this device to use when authenticating with other Cisco
TrustSec devices with EAP-FAST.
Command Default None
Command Modes Privileged EXEC (#)
Supported User Roles
Administrator
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines The cts credentials command specifies the Cisco TrustSec device ID and password for this device to use
when authenticating with other Cisco TrustSec devices with EAP-FAST. The Cisco TrustSec credentials state
retrieval is not performed by the nonvolatile generation process (NVGEN) because the Cisco TrustSec credential
information is saved in the keystore, and not in the startup configuration. The device can be assigned a Cisco
TrustSec identity by the Cisco Secure Access Control Server (ACS), or a new password auto-generated when
prompted to do so by the ACS. These credentials are stored in the keystore, eliminating the need to save the
running configuration. To display the Cisco TrustSec device ID, use the show cts credentials command. The
stored password is never displayed.
To change the device ID or the password, reenter the command. To clear the keystore, use the clear cts
credentials command.
Note When the Cisco TrustSec device ID is changed, all Protected Access Credentials (PACs) are flushed from the
keystore because PACs are associated with the old device ID and are not valid for a new identity.
The following example shows how to configure the Cisco TrustSec device ID and password:
Device# cts credentials id cts1 password password1
CTS device ID and password have been inserted in the local keystore. Please make sure that
the same ID and password are configured in the server database.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
79
Cisco TrustSec
cts credentials
The following example show how to change the Cisco TrustSec device ID and password to cts_new
and password123, respectively:
Device# cts credentials id cts_new pacssword password123
A different device ID is being configured.
This may disrupt connectivity on your CTS links.
Are you sure you want to change the Device ID? [confirm] y
TS device ID and password have been inserted in the local keystore. Please make sure that
the same ID and password are configured in the server database.
The following sample output displays the Cisco TrustSec device ID and password state:
Device# show cts credentials
CTS password is defined in keystore, device-id = cts_new
Related Commands Command Description
clear cts Clears the Cisco TrustSec device ID and password.
credentials
show cts Displays the state of the current Cisco TrustSec device ID and password.
credentials
show cts keystore Displays contents of the hardware and software keystores.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
80
Cisco TrustSec
cts environment-data enable
cts environment-data enable
To enable the download of environment data through REST application programming interfaces (APIs), use
the cts environment-data enable command in global configuration mode. To disable the download of
environment data, use the no form of this command.
cts environment-data enable
no cts environment-data enable
This command has no arguments or keywords.
Command Default Environment data download is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines The cts environment-data enable command cannot co-exist with the cts authorization list command. The
cts authorization list command enables the download of environment data through RADIUS.
If you try to configure RADIUS-based configuration by using the cts authorization list command, when the
cts environment-data enable command is already configured, the following error message is displayed on
the console:
Error: 'cts policy-server or cts environment-data' related configs are enabled.
Disable http-based configs, to enable 'cts authorization'
Examples The following example shows how to enable environment data download:
Device# enable
Device# configure terminal
Device(config)# cts environment-data enable
Related Commands Command Description
clear cts environment-data Clears environment data.
debug cts environment-data Enables the debugging of Cisco TrustSec
environment data operations.
show cts environment-data Displays Cisco TrustSec environment data
information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
81
Cisco TrustSec
cts policy-server device-id
cts policy-server device-id
To configure the policy-server device ID, use the cts policy-server device-id command in global configuration
mode. To remove the policy-server device ID, use the no form of this command.
cts policy-server device-id device-ID
no cts policy-server device-id device-ID
Syntax Description device-ID Device ID of the Cisco TrustSec
device.
Command Default Device ID is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines The device ID must be the same one that was used to add the network access device (NAD) on Cisco Identity
Services Engine (ISE). This ID is used to send environment data requests to Cisco ISE.
Examples The following example shows how to configure the policy-server device ID:
Device# enable
Device# configure terminal
Device(config)# cts policy-server device-id server1
Related Commands Command Description
cts policy-server name Configures a Cisco TrustSec policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
82
Cisco TrustSec
cts policy-server name
cts policy-server name
To configure a Cisco TrustSec policy server and enter policy-server configuration mode, use the cts
policy-server name command in global configuration mode. To remove the policy server, use the no form
of this command.
cts policy-server name server-name
no cts policy-server name server-name
Syntax Description server-name Policy-server name.
Command Default Policy server is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines The policy server name will accept all characters. Once the policy-server name is configured, the configuration
mode changes to policy-server configuration. You can configure other details of the policy-server in this
mode.
Examples The following example shows how to configure policy server name:
Device# enable
Device# configure terminal
Device(config)# cts policy-server name ISE1
Device(config-policy-server)#
Related Commands Command Description
show cts policy-server Displays policy server information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
83
Cisco TrustSec
cts policy-server order random
cts policy-server order random
To change the server-selection logic to random, use the cts policy-server order random command in global
configuration mode. To go back to the default, use the no form of this command.
cts policy-server order random
no cts policy-server order random
This command has no arguments or keywords.
Command Default In-order selection is the default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines When multiple HTTP policy servers are configured on a device, a single Cisco Identity Services Engine (ISE)
instance may get overloaded if the device always selects the first configured server. To avoid this situation,
each device randomly selects a server. A random number is generated by the device and based on this number
a server is selected. For different devices to generate random numbers, the unique board ID and the Cisco
TrustSec process ID of the device is used to initialize the random number generator.
To change the server selection logic to random, use the cts policy-server order random command. If this
command is not selected, the default in-order selection is retained.
In-order selection is when servers are picked in the order in which they are configured (from the public server
list) or downloaded (from the private server list). Once a server is selected, the server is used till it is marked
as dead, and then the next server in the list is selected.
Examples The following example shows how to change the server selection logic:
Device# enable
Device# configure terminal
Device(config)# cts policy-server order random
Related Commands Command Description
cts policy-server name Configures a Cisco TrustSec policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
84
Cisco TrustSec
cts policy-server username
cts policy-server username
To configure a policy-server username, use the cts policy-server username command in global configuration
mode. To remove the policy server username, use the no form of this command.
cts policy-server username username password {0 | 6 | 7 password} password
no cts policy-server username
Syntax Description username Username to access REST
application programming interfaces
(APIs).
password Specifies the password to
authenticate the user.
0 Specifies an unencrypted password.
6 Specifies an encrypted password.
7 Specifies a hidden password.
password Encrypted or unencrypted password.
Command Default User credentials are not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines You must configure the username and password in Cisco Identity Services Engine (ISE) as the REST API
access credentials, before configuring it on the device. See the Cisco TrustSec HTTP Servers section of the
"Cisco TrustSec Policies Configuration" chapter for more information.
Examples The following example shows how to configure the policy server credentials:
Device# enable
Device# configure terminal
Device(config)# policy-server username user1 password 0 ise-password
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
85
Cisco TrustSec
cts refresh
cts refresh
To refresh the TrustSec peer authorization policy of all or specific Cisco TrustSec peers, or to refresh the
SGACL policies downloaded to the device by the authentication server, use the cts refresh command in
privileged EXEC mode.
cts refresh {peer [peer_id] | sgt [{sgt_number | default | unknown}]}
Syntax Description environment-data Refreshes environment data.
peer Peer-ID (Optional) If a peer-id is specified, only policies related to the specified peer connection
are refreshed.
sgt sgt_number (Optional) Performs an immediate refresh of the SGACL policies from the authentication
server.
If an SGT number is specified, only policies related to that SGT are refreshed.
default (Optional) Refreshes the default SGACL policy.
unknown (Optional) Refreshes the unknown SGACL policy.
Command Default None
Command Modes Privileged EXEC (#)
Supported User Roles
Administrator
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines To refresh the Peer Authorization Policy on all TrustSec peers, enter cts policy refresh without specifying a
peer ID.
The peer authorization policy is initially downloaded from the Cisco ACS at the end of the EAP-FAST NDAC
authentication success. The Cisco ACS is configured to refresh the peer authorization policy, but the cts policy
refresh command can force immediate refresh of the policy before the Cisco ACS timer expires. This command
is relevant only to TrustSec devices that can impose Security Group Tags (SGTs) and enforce Security Group
Access Control Lists (SGACLs).
The following example shows how to refresh the TrustSec peer authorization policy of all peers:
Device# cts policy refresh
Policy refresh in progress
The following sample output displays the TrustSec peer authorization policy of all peers:
VSS-1# show cts policy peer
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
86
Cisco TrustSec
cts refresh
CTS Peer Policy
===============
device-id of the peer that this local device is connected to
Peer name: VSS-2T-1
Peer SGT: 1-02
Trusted Peer: TRUE
Peer Policy Lifetime = 120 secs
Peer Last update time = 12:19:09 UTC Wed Nov 18 2009
Policy expires in 0:00:01:51 (dd:hr:mm:sec)
Policy refreshes in 0:00:01:51 (dd:hr:mm:sec)
Cache data applied = NONE
Related Commands Command Description
clear cts policy Clears all Cisco TrustSec policies, or by the peer ID or SGT.
show cts policy Displays peer authorization policy for all or specific TrustSec peers.
peer
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
87
Cisco TrustSec
cts rekey
cts rekey
To regenerate the Pairwise Master Key used by the Security Association Protocol (SAP), use the cts rekey
privileged EXEC command.
cts rekey interface type slot/port
Syntax Description interface type slot/port Specifies the Cisco TrustSec interface on which to regenerate the SAP key.
Command Default None.
Command Modes Privileged EXEC (#)
Supported User Roles
Administrator
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines SAP Pair-wise Master Key key (PMK) refresh ordinarily occurs automatically, triggered by combinations of
network events and non-configurable internal timers related to dot1X authentication. The ability to manually
refresh encryption keys is often part of network administration security requirements. To manually force a
PMK refresh, use the cts rekey command.
TrustSec supports a manual configuration mode where dot1X authentication is not required to create link-to-link
encryption between switches. In this case, the PMK is manually configured on devices on both ends of the
link with the sap pmk Cisco TrustSec manual interface configuration command.
The following example shows how to regenerate the PMK on a specified interface:
Device# cts rekey interface gigabitEthernet 2/1
Related Commands Command Description
sap mode-list (cts manual) Configures Cisco TrustSec SAP for manual mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
88
Cisco TrustSec
cts role-based enforcement
cts role-based enforcement
To enable role-based access control globally and on specific Layer 3 interfaces using Cisco TrustSec, use the
cts role-based enforcement command in global configuration mode and interface configuration mode
respectively. To disable the enforcement of role-based access control at an interface level, use the no form of
this command.
cts role-based enforcement
no cts role-based enforcement
Syntax Description This command has no keywords or arguments.
Command Default Enforcement of role-based access control at an interface level is disabled globally.
Command Modes Global configuration (config)
Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines The cts role-based enforcement command in global configuration mode enables role-based access control
globally. Once role-based access control is enabled globally, it is automatically enabled on every Layer 3
interface on the device. To disable role-based access control on specific Layer 3 interfaces, use the no form
of the command in interface configuration mode. The cts role-based enforcement command in interface
configuration mode enables enforcement of role-based access control on specific Layer 3 interfaces.
The attribute-based access control list organizes and manages the Cisco TrustSec access control on a network
device. The security group access control list (SGACL) is a Layer 3-4 access control list to filter access based
on the value of the security group tag (SGT). The filtering usually occurs at an egress port of the Cisco TrustSec
domain. The terms role-based access control list (RBACL) and SGACL can be used interchangeably, and
they refer to a topology-independent ACL used in an attribute-based access control (ABAC) policy model.
The following example shows how to enable role-based access control on a Gigabit Ethernet interface:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/3
Device(config-if)# cts role-based enforcement
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
89
Cisco TrustSec
cts role-based l2-vrf
cts role-based l2-vrf
To select a virtual routing and forwarding (VRF) instance for Layer 2 VLANs, use the cts role-based l2-vrf
command in global configuration mode. To remove the configuration, use the no form of this command.
cts role-based l2-vrf vrf-name vlan-list {all vlan-ID} [{,}] [{-}]
no cts role-based l2-vrf vrf-name vlan-list {all vlan-ID} [{,}] [{-}]
Syntax Description vrf-name Name of the VRF instance.
vlan-list Specifies the list of VLANs to be assigned to a VRF instance.
all Specifies all VLANs.
vlan-ID VLAN ID. Valid values are from 1 to 4094.
, (Optional) Specifies another VLAN separated by a comma.
- (Optional) Specifies a range of VLANs separated by a hyphen.
Command Default VRF instances are not selected.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines The vlan-list argument can be a single VLAN ID, a list of comma-separated VLAN IDs, or hyphen-separated
VLAN ID ranges.
The all keyword is equivalent to the full range of VLANs supported by the network device. The all keyword
is not preserved in the nonvolatile generation (NVGEN) process.
If the cts role-based l2-vrf command is issued more than once for the same VRF, each successive command
entered adds the VLAN IDs to the specified VRF.
The VRF assignments configured by the cts role-based l2-vrf command are active as long as a VLAN
remains a Layer 2 VLAN. The IP–SGT bindings learned while a VRF assignment is active are also added to
the Forwarding Information Base (FIB) table associated with the VRF and the IP protocol version. If an
Switched Virtual Interface (SVI) becomes active for a VLAN, the VRF-to-VLAN assignment becomes inactive
and all bindings learned on the VLAN are moved to the FIB table associated with the VRF of the SVI.
Use the interface vlan command to configure an SVI interface, and the vrf forwarding command to associate
a VRF instance to the interface.
The VRF-to-VLAN assignment is retained even when the assignment becomes inactive. It is reactivated when
the SVI is removed or when the SVI IP address is changed. When reactivated, the IP–SGT bindings are moved
back from the FIB table associated with the VRF of the SVI to the FIB table associated with the VRF assigned
by the cts role-based l2-vrf command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
90
Cisco TrustSec
cts role-based l2-vrf
The following example shows how to select a list of VLANS to be assigned to a VRF instance:
Device(config)# cts role-based l2-vrf vrf1 vlan-list 20
The following example shows how to configure an SVI interface and associate a VRF instance:
Device(config)# interface vlan 101
Device(config-if)# vrf forwarding vrf1
Related Commands Command Description
interface vlan Configures a VLAN interface.
vrf forwarding Associates a VRF instance or a virtual network with an interface or
subinterface.
show cts role-based permissions Displays the SGACL permission list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
91
Cisco TrustSec
cts role-based monitor
cts role-based monitor
To enable role-based (security-group) access list monitoring, use the cts role-based monitor command in
global configuration mode. To remove role-based access list monitoring, use the no form of this command.
cts role-based monitor {all | permissions {default [{ipv4 | ipv6}] | from {sgt | unknown} to {sgt
| unknown} [{ipv4 | ipv6}]}}
no cts role-based monitor {all | permissions {default [{ipv4 | ipv6}] | from {sgt | unknown} to {sgt
| unknown} [{ipv4 | ipv6}]}}
Syntax Description all Monitors permissions for all source tags to all destination tags.
permissions Monitors permissions from a source tags to a destination tags.
default Monitors the default permission list.
ipv4 (Optional) Specifies the IPv4 protocol.
ipv6 (Optional) Specifies the IPv6 protocol.
from Specifies the source group tag for filtered traffic.
sgt Security Group Tag (SGT). Valid values are from 2 to 65519.
unknown Specifies an unknown source or destination group tag (DST).
Command Default Role-based access control monitoring is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Use the cts role-based monitor all command to enable the global monitor mode. If the cts role-based monitor
all command is configured, the output of the show cts role-based permissions command displays monitor
mode for all configured policies as true.
The following examples shows how to configure SGACL monitor from a source tag to a destination
tag:
Device(config)# cts role-based monitor permissions from 10 to 11
Related Commands Command Description
show cts role-based permissions Displays the SGACL permission list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
92
Cisco TrustSec
cts role-based permissions
cts role-based permissions
To enable permissions from a source group to a destination group, use the cts role-based permissions command
in global configuration mode. To remove the permissions, use the no form of this command.
cts role-based permissions {default | from {sgt | unknown}to {sgt | unknown}}{rbacl-name | ipv4
| ipv6}
no cts role-based permissions {default | from {sgt | unknown}to {sgt | unknown}}{rbacl-name |
ipv4 | ipv6}
Syntax Description default Specifies the default permissions list. Every cell (an SGT pair) for which, security group access
control list (SGACL) permission is not configured statically or dynamically falls under the
default category.
from Specifies the source group tag of the filtered traffic.
sgt Security Group Tag (SGT). Valid values are from 2 to 65519.
unknown Specifies an unknown source or destination group tag.
rbacl-name Role-based access control list (RBACL) or SGACL name. Up to 16 SGACLs can be specified
in the configuration.
ipv4 Specifies the IPv4 protocol.
ipv6 Specifies the IPv6 protocol.
Command Default Permissions from a source group to a destination group is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Use the cts role-based permissions command to define, replace, or delete the list of SGACLs for a given
source group tag (SGT), destination group tag (DGT) pair. This policy is in effect as long as there is no
dynamic policy for the same DGT or SGT.
The cts role-based permissions default command defines, replaces, or deletes the list of SGACLs of the
default policy as long as there is no dynamic policy for the same DGT.
The following example shows how to enable permissions for a destination group:
Device(config)# cts role-based permissions from 6 to 6 mon_2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
93
Cisco TrustSec
cts role-based permissions
Related Commands Command Description
show cts role-based permissions Displays the SGACL permission list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
94
Cisco TrustSec
cts role-based sgt-caching
cts role-based sgt-caching
To enable Security Group Tag (SGT) caching globally, use the cts role-based sgt-caching command in global
configuration mode. To remove SGT caching, use the no form of this command.
cts role-based sgt-caching [vlan-list {vlan-id | all}]
no cts role-based sgt-caching [vlan-list {vlan-id | all}]
Syntax Description vlan-list vlan-id (Optional) Specifies VLAN IDs.
Individual VLAN IDs are separated
by commas, and a range of IDs
specified with a hyphen. Valid
values are from 1 to 4094.
all (Optional) Selects all VLANs.
Command Default SGT caching is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines To enable SGT caching on a VLAN, both cts role-based sgt-caching and cts role-based sgt-caching vlan-list
commands must be configured.
Example
The following example shows how to enable SGT caching on a VLAN:
Device# configure terminal
Device(config)# cts role-based sgt-caching
Device(config)# cts role-based sgt-caching vlan-list 4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
95
Cisco TrustSec
cts role-based sgt-map
cts role-based sgt-map
To manually map a source IP address to a Security Group Tag (SGT) on either a host or a VRF, use the cts
role-based sgt-map command in global configuration mode. Use the no form of the command to remove the
mapping.
cts role-based sgt-map {ipv4_netaddress|ipv6_netaddress|ipv4_netaddress/prefix|ipv6_netaddress/prefix}
sgt sgt-number
cts role-based sgt-map host {ipv4_hostaddress|ipv6_hostaddress} sgt sgt-number
cts role-based sgt-map vlan-list [{vlan_ids|all}] sgt sgt-number
cts role-based sgt-map vrf instance_name
{ipv4_netaddress|ipv6_netaddress|ipv4_netaddress/prefix|ipv6_netaddress/prefix|host
{ipv4_hostaddress|ipv6_hostaddress}} sgt sgt-number
no cts role-based sgt-map
Syntax Description ipv4_netaddress | Specifies the network to be associated with an SGT. Enter IPv4 address
ipv6_netaddress in dot decimal notation; IPv6 in colon hexadecimal notation.
ipv4_netaddress/prefix | Maps the SGT to all hosts of the specified subnet address (IPv4 or
ipv6_netaddress/prefix IPv6). IPv4 is specified in dot decimal CIDR notation, IPv6 in colon
hexadecimal notation
host {ipv4_hostaddress | Binds the specified host IP address with the SGT. Enter the IPv4
ipv6_hostaddress} address in dot decimal notation; IPv6 in colon hexadecimal notation.
vlan-list {vlan_ids | all} Specifies VLAN IDs.
• (Optional) vlan_ids: Individual VLAN IDs are separated by
commas, a range of IDs specified with a hyphen.
• (Optional) all: Specifies all VLAN IDs.
vrf instance_name Specifies a VRF instance, previously created on the device.
sgt sgt-number Specifies the SGT number from 0 to 65,535.
Command Default None
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines If you do not have a Cisco Identity Services Engine, Cisco Secure ACS, dynamic Address Resolution Protocol
(ARP) inspection, Dynamic Host Control Protocol (DHCP) snooping, or Host Tracking available on your
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
96
Cisco TrustSec
cts role-based sgt-map
device to automatically map SGTs to source IP addresses, you can manually map an SGT to the following
with the cts role-based sgt-map command:
• A single host IPv4 or IPv6 address
• All hosts of an IPv4 or IPv6 network or subnetwork
• VRFs
• Single or multiple VLANs
The cts role-based sgt-map command binds the specified SGT with packets that fall within the specified
network address.
SXP exports an exhaustive expansion of all possible individual IP–SGT bindings within the specified network
or subnetwork. IPv6 bindings and subnet bindings are exported only to SXP listener peers of SXP version 2
or later. The expansion does not include host bindings which are known individually or are configured or
learnt from SXP for any nested subnet bindings.
The cts role-based sgt-map host command binds the specified SGT with incoming packets when the IP
source address is matched by the specified host address. This IP-SGT binding has the lowest priority and is
ignored in the presence of any other dynamically discovered bindings from other sources (such as, SXP or
locally authenticated hosts). The binding is used locally on the device for SGT imposition and SGACL
enforcement. It is exported to SXP peers if it is the only binding known for the specified host IP address.
The vrf keyword specifies a virtual routing and forwarding table previously defined with the vrf definition
global configuration command. The IP-SGT binding specified with the cts role-based sgt-map vrf global
configuration command is entered into the IP-SGT table associated with the specified VRF and the IP protocol
version which is implied by the type of IP address entered.
The cts role-based sgt-map vlan-list command binds an SGT with a specified VLAN or a set of VLANs.
The keyword all is equivalent to the full range of VLANs supported by the device and is not preserved in the
nonvolatile generation (NVGEN) process. The specified SGT is bound to incoming packets received in any
of the specified VLANs. The system uses discovery methods such as DHCP and/or ARP snooping (a.k.a. IP
device tracking) to discover active hosts in any of the VLANs mapped by this command. Alternatively, the
system could map the subnet associated with the SVI of each VLAN to the specified SGT. SXP exports the
resulting bindings as appropriate for the type of binding.
Examples The following example shows how to manually map a source IP address to an SGT:
Device(config)# cts role-based sgt-map 10.10.1.1 sgt 77
In the following example, a device binds host IP address 10.1.2.1 to SGT 3 and 10.1.2.2 to SGT 4.
These bindings are forwarded by SXP to an SGACL enforcement device.
Device(config)# cts role-based sgt-map host 10.1.2.1 sgt 3
Device(config)# cts role-based sgt-map host 10.1.2.2 sgt 4
Related Commands Command Description
show cts role-based sgt-map Displays role-based access control information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
97
Cisco TrustSec
cts sxp connection peer
cts sxp connection peer
To enter the Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) peer IP address, to
specify if a password is used for the peer connection, to specify the global hold-time period for a listener or
speaker device, and to specify if the connection is bidirectional, use the cts sxp connection peer command
in global configuration mode. To remove these configurations for a peer connection, use the no form of this
command.
cts sxp connection peer ipv4-address {source | password} {default | none} mode {local | peer}
[{[[{listener | speaker}] [{hold-time minimum-time maximum-time | vrf vrf-name}]] | both [vrf
vrf-name]}]
cts sxp connection peer ipv4-address {source | password} {default | none} mode {local | peer}
[{[[{listener | speaker}] [{hold-time minimum-time maximum-time | vrf vrf-name}]] | both [vrf
vrf-name]}]
Syntax Description ipv4-address SXP peer IPv4 address.
source Specifies the source IPv4 address.
password Specifies that an SXP password is used for the peer connection.
default Specifies that the default SXP password is used.
none Specifies no password is used.
mode Specifies either the local or peer SXP connection mode.
local Specifies that the SXP connection mode refers to the local device.
peer Specifies that the SXP connection mode refers to the peer device.
listener (Optional) Specifies that the device is the listener in the connection.
speaker (Optional) Specifies that the device is the speaker in the connection.
hold-time minimum-time (Optional) Specifies the hold-time period, in seconds, for the device. The range
maximum-time for minimum and maximum time is from 0 to 65535.
A maximum-time value is required only when you use the following keywords:
peer speaker and local listener. In other instances, only a minimum-time value
is required.
Note If both minimum and maximum times are required, the
maximum-time value must be greater than or equal to the
minimum-time value.
vrf vrf-name (Optional) Specifies the virtual routing and forwarding (VRF) instance name
to the peer.
both (Optional) Specifies that the device is both the speaker and the listener in the
bidirectional SXP connection.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
98
Cisco TrustSec
cts sxp connection peer
Command Default The CTS-SXP peer IP address is not configured and no CTS-SXP peer password is used for the peer connection.
The default setting for a CTS-SXP connection password is none.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines When a CTS-SXP connection to a peer is configured with the cts sxp connection peer command, only the
connection mode can be changed. The vrf keyword is optional. If a VRF name is not provided or a VRF name
is provided with the default keyword, then the connection is set up in the default routing or forwarding domain.
A hold-time maximum-period value is required only when you use the following keywords: peer speaker
and local listener. In other instances, only a hold-time minimum-period value is required.
Note The maximum-period value must be greater than or equal to the minimum-period value.
Use the both keyword to configure a bidirectional SXP connection. With the support for bidirectional SXP
configuration, a peer can act as both a speaker and a listener and propagate SXP bindings in both directions
using a single connection.
Examples The following example shows how to enable CTS-SXP and configure the CTS-SXP peer connection
on Device_A, a speaker, for connection to Device_B, a listener:
Device_A> enable
Device_A# configure terminal
Device_A#(config)# cts sxp enable
Device_A#(config)# cts sxp default password Cisco123
Device_A#(config)# cts sxp default source-ip 10.10.1.1
Device_A#(config)# cts sxp connection peer 10.20.2.2 password default mode local speaker
The following example shows how to configure the CTS-SXP peer connection on Device_B, a
listener, for connection to Device_A, a speaker:
Device_B> enable
Device_B# configure terminal
Device_B(config)# cts sxp enable
Device_B(config)# cts sxp default password Cisco123
Device_B(config)# cts sxp default source-ip 10.20.2.2
Device_B(config)# cts sxp connection peer 10.10.1.1 password default mode local listener
You can also configure both peer and source IP addresses for an SXP connection. The source IP
address specified in the cts sxp connection command overwrites the default value.
Device_A(config)# cts sxp connection peer 51.51.51.1 source 51.51.51.2 password none mode
local speaker
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
99
Cisco TrustSec
cts sxp connection peer
Device_B(config)# cts sxp connection peer 51.51.51.2 source 51.51.51.1 password none mode
local listener
The following example shows how to enable bidirectional CTS-SXP and configure the SXP peer
connection on Device_A to connect to Device_B:
Device_A> enable
Device_A# configure terminal
Device_A#(config)# cts sxp enable
Device_A#(config)# cts sxp default password Cisco123
Device_A#(config)# cts sxp default source-ip 10.10.1.1
Device_A#(config)# cts sxp connection peer 10.20.2.2 password default mode local both
Related Commands Command Description
cts sxp default password Configures the Cisco TrustSec SXP default password.
cts sxp default source-ip Configures the Cisco TrustSec SXP source IPv4 address.
cts sxp enable Enables Cisco TrustSec SXP on a device.
cts sxp log Enables logging for IP-to-SGT binding changes.
cts sxp reconciliation Changes the Cisco TrustSec SXP reconciliation period.
cts sxp retry Changes the Cisco TrustSec SXP retry period timer.
cts sxp speaker hold-time Configures the global hold-time period of a speaker device in a Cisco TrustSec
SGT SXPv4 network.
cts sxp listener hold-time Configures the global hold-time period of a listener device in a Cisco TrustSec
SGT SXPv4 network.
show cts sxp Displays the status of all Cisco TrustSec SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
100
Cisco TrustSec
cts sxp default password
cts sxp default password
To specify the Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) default password,
use the cts sxp default password command in global configuration mode. To remove the CTS-SXP default
password, use the no form of this command.
cts sxp default password {0 unencrypted-pwd | 6 encrypted-key | 7 encrypted-keycleartext-pwd}
no cts sxp default password {0 unencrypted-pwd | 6 encrypted-key | 7 encrypted-keycleartext-pwd}
Syntax Description 0 unencrypted-pwd Specifies that an unencrypted CTS-SXP default password follows. The maximum
password length is 32 characters.
6 encrypted-key Specifies that a 6 encryption type password is used as the CTS-SXP default password.
The maximum password length is 32 characters.
7 encrypted-key Specifies that a 7 encryption type password is used as the CTS-SXP default password.
The maximum password length is 32 characters.
cleartext-pwd Specifies a cleartext CTS-SXP default password. The maximum password length is 32
characters.
Command Default Type 0 (cleartext)
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines The cts sxp default password command sets the CTS-SXP default password to be optionally used for all
CTS-SXP connections configured on the device. The CTS-SXP password can be cleartext, or encrypted with
the 0, 7, 6 encryption type keywords. If the encryption type is 0, then an unencrypted cleartext password
follows.
Examples The following example shows how to enable CTS-SXP and configure the CTS-SXP peer connection
on Device_A, a speaker, for connection to Device_B, a listener:
Device_A# configure terminal
Device_A#(config)# cts sxp enable
Device_A#(config)# cts sxp default password Cisco123
Device_A#(config)# cts sxp default source-ip 10.10.1.1
Device_A#(config)# cts sxp connection peer 10.20.2.2 password default mode local speaker
The following example shows how to configure the CTS-SXP peer connection on Device_B, a
listener, for connection to Device_A, a speaker:
Device_B# configure terminal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
101
Cisco TrustSec
cts sxp default password
Device_B(config)# cts sxp enable
Device_B(config)# cts sxp default password Cisco123
Device_B(config)# cts sxp default source-ip 10.20.2.2
Device_B(config)# cts sxp connection peer 10.10.1.1 password default mode local listener
Related Commands Command Description
cts sxp connection peer Enters the CTS-SXP peer IP address and specifies if a password is used for the
peer connection.
cts sxp default source-ip Configures the CTS-SXP source IPv4 address.
cts sxp enable Enables CTS-SXP on a device.
cts sxp log Enables logging for IP-to-SGT binding changes.
cts sxp reconciliation Changes the CTS-SXP reconciliation period.
cts sxp retry Changes the CTS-SXP retry period timer.
show cts sxp Displays the status of all SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
102
Cisco TrustSec
cts sxp default source-ip
cts sxp default source-ip
To configure the Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) source IPv4
address, use the cts sxp default source-ip command in global configuration mode. To remove the CTS-SXP
default source IP address, use the no form of this command.
cts sxp default source-ip ipv4-address
no cts sxp default source-ip ipv4-address
Syntax Description ip-address Default source CTS-SXP IPv4 address.
Command Default The CTS-SXP source IP address is not configured.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines The cts sxp default source-ip command sets the default source IP address that CTS-SXP uses for all new
TCP connections where a source IP address is not specified. Preexisting TCP connections are not affected
when this command is entered. CTS-SXP connections are governed by three timers:
• Retry timer
• Delete Hold Down timer
• Reconciliation timer
Examples The following example shows how to enable CTS-SXP and configure the CTS-SXP peer connection
on Device_A, a speaker, for connection to Device_B, a listener:
Device_A# configure terminal
Device_A#(config)# cts sxp enable
Device_A#(config)# cts sxp default password Cisco123
Device_A#(config)# cts sxp default source-ip 10.10.1.1
Device_A#(config)# cts sxp connection peer 10.20.2.2 password default mode local speaker
The following example shows how to configure the CTS-SXP peer connection on Device_B, a
listener, for connection to Device_A, a speaker:
Device_B# configure terminal
Device_B(config)# cts sxp enable
Device_B(config)# cts sxp default password Cisco123
Device_B(config)# cts sxp default source-ip 10.20.2.2
Device_B(config)# cts sxp connection peer 10.10.1.1 password default mode local listener
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
103
Cisco TrustSec
cts sxp default source-ip
Related Commands Command Description
cts sxp connectionpeer Enters the CTS-SXP peer IP address and specifies if a password is used for the
peer connection.
cts sxp default password Configures the CTS-SXP default password.
cts sxp enable Enables CTS-SXP on a device.
cts sxp log Enables logging for IP-to-SGT binding changes.
cts sxp reconciliation Changes the CTS-SXP reconciliation period.
cts sxp retry Changes the CTS-SXP retry period timer.
show cts sxp Displays the status of all SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
104
Cisco TrustSec
cts sxp filter-enable
cts sxp filter-enable
To enable filtering after creating filter lists and filter groups, use the cts sxp filter-enable command in global
configuration mode. To disable filtering, use the no form of the command.
cts sxp filter-enable
no cts sxp filter-enable
Syntax Description This command has no keywords or arguments.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines This command can be used at any time to enable or disable filtering. Configured filter lists and filter groups
can be used to implement filtering only after filtering is enabled. The filter action will only filter bindings that
are exchanged after filtering is enabled; there won’t be any effect on the bindings that were exchanged before
filtering was enabled.
Examples Device(config)# cts sxp filter-enable
Related Commands Command Description
cts sxp filter-list Creates a SXP filter list to filter IP-SGT bindings based on IP prefixes, SGT or
a combination of both.
cts sxp filter-group Creates a filter group for grouping a set of peers and applying a filter list to them.
show cts sxp filter-group Displays information about the configured filter groups..
show cts sxp filter-list Displays information about the configured filter lists.
debug cts sxp filter Logs events related to the creation, deletion and update of filter-lists and
events filter-groups
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
105
Cisco TrustSec
cts sxp filter-group
cts sxp filter-group
To create a filter group for grouping a set of peers and applying a filter list to them, use the cts sxp filter-group
command in global configuration mode. To delete a filter group, use the no form of this command.
cts sxp filter-group {listener | speaker}{filter-group-name | global filter-list-name}
no cts sxp filter-group {listener | speaker}{filter-group-name | global filter-list-name}
Syntax Description listener Creates a filter group for a set of listeners.
speaker Creates a filter group for a set of speakers.
global Groups all speakers or listeners on the device.
filter-group-name Name of the filter group.
filter-list-name Name of the filter list.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Issuing this command, places the device in the filter group configuration mode. From this mode, you can
specify the devices to be grouped and apply a filter list to the filter group.
The command format to add devices or peers to the group is a follows:
peer ipv4 peer-IP
In a single command, you can add one peer. To add more peers, repeat the command as many times as required.
The command format to apply a filter list to the group is as follows:
filter filter-list-name
You cannot specify a peer list for the global listener and global speaker filter-group options because in this
case the filter is applied to all SXP connections.
When both the global filter group and peer-based filter groups are applied, the global filter takes priority. If
only a global listener or global speaker filter group is configured, then the global filtering takes precendence
only in that specific direction. For the other direction, the peer-based filter group is implemented.
Examples The following example shows how to create a listener group called group_1, and assign peers and
a filter list to this group:
Device# configure terminal
Device(config)# cts sxp filter-group listener group_1
Device(config-filter-group)# filter filter_1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
106
Cisco TrustSec
cts sxp filter-group
Device(config-filter-group)# peer ipv4 10.0.0.1
Device(config-filter-group)# peer ipv4 10.10.10.1
The following example shows how to create a global listener group called group_2:
Device# configure terminal
Device(config)# cts sxp filter-group listener global group_2
Related Commands Command Description
cts sxp filter-list Creates a SXP filter list to filter IP-SGT bindings based on IP prefixes, SGT or
a combination of both.
cts sxp filter-enable Enables filtering.
show cts sxp filter-group Displays information about the configured filter groups.
show cts sxp filter-list Displays information about the configured filter lists.
debug cts sxp filter Logs events related to the creation, deletion and update of filter-lists and
events filter-groups
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
107
Cisco TrustSec
cts sxp filter-list
cts sxp filter-list
To create a SXP filter list to hold a set of filter rules for filtering IP-SGT bindings, use the cts sxp filter-list
command in global configuration mode. To delete a filter list, use the no form of the command.
cts sxp filter-list filter-list-name
no cts sxp filter-list filter-list-name
Syntax Description filter-list-name Name of the filter-list.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Issuing this command, places the device in the filter list configuration mode. From this mode, you can specify
rules for the filter lists.
A filter rule can be based on SGT or IP Prefixes or a combination of both SGT and IP Prefixes.
The command format to add rules to the group is a follows:
sequence-number action(permit/deny) filter-type(ipv4/ipv6/sgt) value/values
For example, to permit SGT-IP bindings whose SGT value is 20, the rule is as follows:
30 permit sgt 20
Note that the sequence number is optional. If you do not specify a sequence number, it is generated by the
system. Sequence numbers are automatically incremented by a value of 10 from the last used/configured
sequence number. A new rule can be inserted by specifying a sequence number in between two existing rules.
The range of valid SGT values is between 2 and 65519. To provide multiple SGT values in a rule, seperate
the values using a space. A maximum of 8 SGT values are allowed in a rule.
In a SGT and IP prefix combination rule, if there is a match for the binding in both the parts of the rule, then
the action specified in the second part of the rule takes precedence. For example, in the following rule, if the
SGT value of the IP prefix 10.0.0.1 is 20, the corresponding binding will be denied even if the first part of
the rule permits the binding.
Device(config-filter-list)# 10 permit sgt 30 20 deny 10.0.0.1/24
Similarly, in the rule below the binding with the sgt value 20 will be permitted even if the sgt of the IP prefix
10.0.0.1 is 20, and the first action does not permit the binding.
Device(config-filter-list)# 10 deny 10.0.0.1/24 permit sgt 30 20
Examples The following example shows how to create a filter list and add some rules to the list:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
108
Cisco TrustSec
cts sxp filter-list
Device# configure terminal
Device(config)# cts sxp filter-list filter_1
Device (config-filter-list)# 10 deny ipv4 10.0.0.1/24 permit sgt 100
Device(config-filter-list)# 20 permit sgt 60 61 62 63
Related Commands Command Description
cts sxp filter-enable Enable SXP IP-prefix and SGT-based filtering.
cts sxp filter-group Creates a filter group for grouping a set of peers and applying a filter list to them.
show cts sxp filter-group Displays information about the configured filter groups.
show cts sxp filter-list Displays information about the configured filter lists.
debug cts sxp filter Logs events related to the creation, deletion and update of filter-lists and
events filter-groups.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
109
Cisco TrustSec
cts sxp log binding-changes
cts sxp log binding-changes
To enable logging for IP-to-Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) binding
changes, use the cts sxp log binding-changes command in global configuration mode. To disable logging,
use the no form of this command.
cts sxp log binding-changes
no cts sxp log binding-changes
Command Default Logging is disabled.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines The cts sxp log binding-changes command enables logging for IP-to-SGT binding changes. SXP syslogs
(sev 5 syslogs) are generated whenever IP address-to-SGT binding occurs (add, delete, change). These changes
are learned and propagated on the SXP connection.
Related Commands Command Description
cts sxp connectionpeer Enters the CTS-SXP peer IP address and specifies if a password is used for the
peer connection
cts sxp default password Configures the CTS-SXP default password.
cts sxp default source-ip Configures the CTS-SXP source IPv4 address.
cts sxp enable Enables CTS-SXP on a device.
cts sxp reconciliation Changes the CTS-SXP reconciliation period.
cts sxp retry Changes the CTS-SXP retry period timer.
show cts sxp Displays status of all SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
110
Cisco TrustSec
cts sxp reconciliation period
cts sxp reconciliation period
To change the Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) reconciliation period,
use the cts sxp reconciliation period command in global configuration mode. To return the CTS-SXP
reconciliation period to its default value, use the no form of this command.
cts sxp reconciliation period seconds
no cts sxp reconciliation period seconds
Syntax Description seconds CTS-SXP reconciliation timer in seconds. The range is from 0 to 64000. The default is 120.
Command Default 120 seconds (2 minutes)
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines After a peer terminates a CTS-SXP connection, an internal delete hold-down timer starts. If the peer reconnects
before the delete hold-down timer expires, then the CTS-SXP reconciliation timer starts. While the CTS-SXP
reconciliation period timer is active, the CTS-SXP software retains the SGT mapping entries learned from
the previous connection and removes invalid entries. Setting the SXP reconciliation period to 0 seconds
disables the timer and causes all entries from the previous connection to be removed.
Related Commands Command Description
cts sxp connection peer Enters the CTS-SXP peer IP address and specifies if a password is used for the
peer connection.
cts sxp default password Configures the CTS-SXP default password.
cts sxp default source-ip Configures the CTS-SXP source IPv4 address.
cts sxp enable Enables CTS-SXP on a device.
cts sxp log Turns on logging for IP to SGT binding changes.
cts sxp retry Changes the CTS-SXP retry period timer.
show cts sxp Displays status of all CTS-SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
111
Cisco TrustSec
cts sxp retry period
cts sxp retry period
To change the Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) retry period timer,
use the cts sxp retry period command in global configuration mode. To return the CTS-SXP retry period
timer to its default value, use the no form of this command.
cts sxpretry period seconds
no cts sxpretry period seconds
Syntax Description seconds CTS-SXP retry timer in seconds. The range is from 0 to 64000. The default is 120.
Command Default 120 seconds (2 minutes)
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was
16.9.1 introduced.
Usage Guidelines The retry timer is triggered if there is at least one CTS-SXP connection that is not up. A new CTS-SXP
connection is attempted when this timer expires. A zero value results in no retry being attempted.
Related Commands Command Description
cts sxp connectionpeer Enters the CTS-SXP peer IP address and specifies if a password is used for the
peer connection.
cts sxp default password Configures the CTS-SXP default password.
cts sxp default source-ip Configures the CTS-SXP source IPv4 address.
cts sxp enable Enables CTS-SXP on a device.
cts sxp log Enables logging for IP-to-SGT binding changes.
cts sxp reconciliation Changes the CTS-SXP reconciliation period.
show cts sxp Displays the status of all CTS-SXP configurations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
112
Cisco TrustSec
debug cts environment-data
debug cts environment-data
To enable the debugging of Cisco TrustSec environment data operations, use the debug cts environment-data
command in privileged EXEC mode. To stop the debugging of environment data operations, use the no form
of this command.
debug cts environment-data [{aaa | all | default-epg | default-sg | events | platform | sg-epg}]
no debug cts environment-data [{aaa | all | default-epg | default-sg | events | platform | sg-epg}]
Syntax Description aaa (Optional) Specifies the debugging
of authentication, authorization, and
accounting (AAA) messages.
all (Optional) Specifies the debugging
of all environment-data messages.
default-epg (Optional) Specifies the debugging
of default end-point group (EPG)
messages.
default-sg (Optional) Specifies the debugging
of default server group messages.
events (Optional) Specifies the debugging
of environment data events.
platform (Optional) Specifies the debugging
of Security Group Tag (SGT)-EPG
platform messages.
sg-epg (Optional) Specifies the debugging
of SP-EPG mapping.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to enable the debugging of environment data events:
Device# enable
Device# debug cts environment-data events
Related Commands Command Description
cts environment-data enable Enables the download of environment data.
clear cts environment-data Clears environment data.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
113
Cisco TrustSec
debug cts environment-data
Command Description
show cts environment-data Displays Cisco TrustSec environment data
information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
114
Cisco TrustSec
debug cts policy-server
debug cts policy-server
To enable Cisco TrustSec policy-server debugging, use the debug cts policy-server command in privileged
EXEC mode.
debug cts policy-server {all | {http | json}{all | error | events}}
Syntax Description all Enables all policy-server debugs.
http Enables HTTP client debugs.
json Enables JSON parser debugs.
error Enables HTTP error debugs.
events Enables HTTP event debugs.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to enable HTTP client error debugs:
Device# enable
Device# debug cts policy-server http error
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
show cts policy-server Displays Cisco TrustSec policy-server
information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
115
Cisco TrustSec
port (CTS)
port (CTS)
To configure the policy server port, use the port command in policy-server configuration mode. To remove
the policy server port, use the no form of this command.
port port-number
no port
Syntax Description port-number Policy server port number. Valid
values are from 1025 to 65535.
Command Default Default port is 9063.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines Only 9063 is supported as the External RESTful Services (ERS) port.
Examples The following example shows how to configure the policy-server port:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# port 9063
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
116
Cisco TrustSec
propagate sgt (cts manual)
propagate sgt (cts manual)
To enable Security Group Tag (SGT) propagation at Layer 2 on Cisco TrustSec Security (CTS) interfaces,
use the propagate sgt command in interface configuration mode. To disable SGT propagation, use the no
form of this command.
propagate sgt
Syntax Description This command has no arguments or keywords.
Command Default SGT processing propagation is enabled.
Command Modes CTS manual interface configuration mode (config-if-cts-manual)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines SGT processing propagation allows a CTS-capable interface to accept and transmit a CTS Meta Data (CMD)
based L2 SGT tag. The no propagate sgt command can be used to disable SGT propagation on an interface
in situations where a peer device is not capable of receiving an SGT, and as a result, the SGT tag cannot be
put in the L2 header.
Examples The following example shows how to disable SGT propagation on a manually-configured
TrustSec-capable interface:
Device# configure terminal
Device(config)# interface gigabitethernet 0
Device(config-if)# cts manual
Device(config-if-cts-manual)# no propagate sgt
The following example shows that SGT propagation is disabled on Gigabit Ethernet interface 0:
Device#show cts interface brief
Global Dot1x feature is Disabled
Interface GigabitEthernet0:
CTS is enabled, mode: MANUAL
IFC state: OPEN
Authentication Status: NOT APPLICABLE
Peer identity: "unknown"
Peer's advertised capabilities: ""
Authorization Status: NOT APPLICABLE
SAP Status: NOT APPLICABLE
Propagate SGT: Disabled
Cache Info:
Cache applied to link : NONE
Related Commands Command Description
cts manual Enables an interface for CTS.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
117
Cisco TrustSec
propagate sgt (cts manual)
Command Description
show cts interface Displays Cisco TrustSec states and statistics per interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
118
Cisco TrustSec
retransmit (CTS)
retransmit (CTS)
To configure the maximum number of retries from the server, use the retransmit command in policy-server
configuration mode. To go back to the default, use the no form of this command.
retransmit number-of-retries
no retransmit
Syntax Description number-of-retries Maximum number of retries. Valid
values are from 0 to 5.
Command Default The default is 4.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to change the maximum number of retries:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# retransmit 3
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
119
Cisco TrustSec
sap mode-list (cts manual)
sap mode-list (cts manual)
To select the Security Association Protocol (SAP) authentication and encryption modes (prioritized from
highest to lowest) used to negotiate link encryption between two interfaces, use the sap mode-list command
in CTS dot1x interface configuration mode. To remove a mode-list and revert to the default, use the no form
of this command.
Use the sap mode-list command to manually specify the Pairwise Master Key (PMK) and the Security
Association Protocol (SAP) authentication and encryption modes to negotiate MACsec link encryption between
two interfaces. Use the no form of the command to disable the configuration.
sap pmk mode-list {gcm-encrypt | gmac | no-encap | null} [gcm-encrypt | gmac | no-encap |
null]
no sap pmk mode-list {gcm-encrypt | gmac | no-encap | null} [gcm-encrypt | gmac | no-encap
| null]
Syntax Description pmk hex_value Specifies the Hex-data PMK
(without leading 0x; enter even
number of hex characters, or else
the last character is prefixed with
0.).
mode-list Specifies the list of advertised
modes (prioritized from highest to
lowest).
gcm-encrypt Specifies GMAC authentication,
GCM encryption.
gmac Specifies GMAC authentication
only, no encryption.
no-encap Specifies no encapsulation.
null Specifies encapsulation present, no
authentication, no encryption.
Command Default The default encryption is sap pmk mode-list gcm-encrypt null. When the peer interface does not support
802.1AE MACsec or 802.REV layer-2 link encryption, the default encryption is null.
Command Modes CTS manual interface configuration (config-if-cts-manual)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Use the sap pmk mode-list command to specify the authentication and encryption method.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
120
Cisco TrustSec
sap mode-list (cts manual)
The Security Association Protocol (SAP) is an encryption key derivation and exchange protocol based on a
draft version of the 802.11i IEEE protocol. SAP is used to establish and maintain the 802.1AE link-to-link
encryption (MACsec) between interfaces that support MACsec.
SAP and the Pairwise Master Key (PMK) can be manually configured between two interfaces with the sap
pmk mode-list command. When using 802.1X authentication, both sides (supplicant and authenticator) receive
the PMK and the MAC address of the peer's port from the Cisco Secure Access Control Server.
If a device is running CTS-aware software but the hardware is not CTS-capable, disallow encapsulation with
the sap mode-list no-encap command.
Examples The following example shows how to configure SAP on a Gigabit Ethernet interface:
Device# configure terminal
Device(config)# interface gigabitethernet 2/1
DeviceD(config-if)# cts manual
Device(config-if-cts-manual)# sap pmk FFFEE mode-list gcm-encrypt
Related Commands Command Description
cts manual Enables an interface for CTS.
propagate sgt (cts manual) Enables Security Group Tag (SGT) propagation at Layer 2 on Cisco TrustSec
Security (CTS) interfaces.
show cts interface Displays Cisco TrustSec interface configuration statistics.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
121
Cisco TrustSec
show cts credentials
show cts credentials
To display the Cisco TrustSec (CTS) device ID, use the show cts credentials command in EXEC or privileged
EXEC mode.
show cts credentials
Syntax Description This command has no commands or keywords.
Command Modes
Privileged EXEC (#) User EXEC (>)
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Examples The following example displays output:
Device# show cts credentials
CTS password is defined in keystore, device-id = r4
Related Commands Command Description
cts credentials Specifies the TrustSec ID and password.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
122
Cisco TrustSec
show cts environment-data
show cts environment-data
To display Cisco TrustSec environment data information, use the show cts environment-data command in
privileged EXEC mode.
show cts environment-data
This command has no arguments and keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following is sample output from the show cts environment-data command:
Device# enable
Device# show cts environment-data
TS Environment Data
====================
Current state = START
Last status = Failed
Environment data is empty
State Machine is running
Retry_timer (60 secs) is running
Output fields are self-explanatory.
Related Commands Command Description
cts environment-data enable Enables the download of environment data.
clear cts environment-data Clears environment data.
debug cts environment-data Enables the debugging of Cisco TrustSec
environment data operations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
123
Cisco TrustSec
show cts interface
show cts interface
To display Cisco TrustSec (CTS) configuration statistics for an interface(s), use the show cts interface
command in EXEC or privileged EXEC mode.
show cts interface [{GigabitEthernet port | Vlan number | brief | summary}]
Syntax Description port (Optional) Gigabit Ethernet interface number. A verbose status output for this interface is
returned.
number (Optional) VLAN interface number from 1 to 4095.
brief (Optional) Displays abbreviated status for all CTS interfaces.
summary (Optional) Displays a tabular summary of all CTS interfaces with 4 or 5 key status fields for
each interface.
Command Default None
Command Modes
EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Use the show cts interface command without keywords to display verbose status for all CTS interfaces.
Examples The following example displays output without using a keyword (verbose status for all CTS interfaces):
Device# show cts interface
Global Dot1x feature is Disabled
Interface GigabitEthernet0/1/0:
CTS is enabled, mode: MANUAL
IFC state: OPEN
Interface Active for 00:00:18.232
Authentication Status: NOT APPLICABLE
Peer identity: "unknown"
Peer's advertised capabilities: ""
Authorization Status: NOT APPLICABLE
SAP Status: NOT APPLICABLE
Configured pairwise ciphers:
gcm-encrypt
null
Replay protection: enabled
Replay protection mode: STRICT
Selected cipher:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
124
Cisco TrustSec
show cts interface
Propagate SGT: Enabled
Cache Info:
Cache applied to link : NONE
Statistics:
authc success: 0
authc reject: 0
authc failure: 0
authc no response: 0
authc logoff: 0
sap success: 0
sap fail: 0
authz success: 0
authz fail: 0
port auth fail: 0
Ingress:
control frame bypassed: 0
sap frame bypassed: 0
esp packets: 0
unknown sa: 0
invalid sa: 0
inverse binding failed: 0
auth failed: 0
replay error: 0
Egress:
control frame bypassed: 0
esp packets: 0
sgt filtered: 0
sap frame bypassed: 0
unknown sa dropped: 0
unknown sa bypassed: 0
The following example displays output using the brief keyword:
Device# show cts interface brief
Global Dot1x feature is Disabled
Interface GigabitEthernet0/1/0:
CTS is enabled, mode: MANUAL
IFC state: OPEN
Interface Active for 00:00:40.386
Authentication Status: NOT APPLICABLE
Peer identity: "unknown"
Peer's advertised capabilities: ""
Authorization Status: NOT APPLICABLE
SAP Status: NOT APPLICABLE
Propagate SGT: Enabled
Cache Info:
Cache applied to link : NONE
Related Commands Command Description
cts manual Enables an interface for CTS.
cts sxp enable Configures SXP on a network device.
propagate sgt Enables Security Group Tag (SGT) propagation at Layer 2 on Cisco TrustSec Security
(CTS) interfaces.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
125
Cisco TrustSec
show cts policy-server
show cts policy-server
To display Cisco TrustSec policy-server information, use the show cts policy-server command in privileged
EXEC mode.
show cts policy-server {details | statistics }{active | all name}
Syntax Description details Displays policy-server details.
statistics Displays policy-server statistics.
active Displays information about active
policy servers.
all Displays statistics information about
all servers.
name Policy-server name.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following is sample output from the show cts policy-server details all command:
Device# enable
Device# show cts policy-server details all
Server Name : ise_151
Server Status : Inactive
IPv4 Address : 10.1.1.1
IPv4 Address : 10.2.2.2
IPv4 Address : 10.2.2.3
IPv6 Address : 2001:db8::1
IPv6 Address : 2001:db8::3
Domain-name : www.cisco.ise.com
Trustpoint : trust_ise_151
Port-num : 9063
Retransmit count : 3
Timeout : 15
App Content type : JSON
Server Name : ise_150
Server Status : Inactive
IPv4 Address : 10.64.69.151
Trustpoint : trust_ise_151
Port-num : 9063
Retransmit count : 3
Timeout : 15
App Content type : JSON
The following is sample output from the show cts policy-server statistics all command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
126
Cisco TrustSec
show cts policy-server
Device# show cts policy-server statistics all
Server Name : ise_server_1
Server State : ALIVE
Number of Request sent : 7
Number of Request sent fail : 0
Number of Response received : 4
Number of Response recv fail : 3
HTTP 200 OK : 4
HTTP 400 BadReq : 0
HTTP 401 UnAuthorized Req : 0
HTTP 403 Req Forbidden : 0
HTTP 404 NotFound : 0
HTTP 408 ReqTimeout : 0
HTTP 415 UnSupported Media : 0
HTTP 500 ServerErr : 0
HTTP 501 Req NoSupport : 0
HTTP 503 Service Unavailable: 0
TCP or TLS handshake error : 3
HTTP Other Error : 0
The following is sample output from the show cts policy-server statistics name command:
Device# show cts policy-server statistics name ise_server_1
Server Name : ise_server_1
Server State : ALIVE
Number of Request sent : 7
Number of Request sent fail : 0
Number of Response received : 4
Number of Response recv fail : 3
HTTP 200 OK : 4
HTTP 400 BadReq : 0
HTTP 401 UnAuthorized Req : 0
HTTP 403 Req Forbidden : 0
HTTP 404 NotFound : 0
HTTP 408 ReqTimeout : 0
HTTP 415 UnSupported Media : 0
HTTP 500 ServerErr : 0
HTTP 501 Req NoSupport : 0
HTTP 503 Service Unavailable: 0
TCP or TLS handshake error : 3
HTTP Other Error : 0
The following table explains the significant fields shown in the display:
Table 6: show cts policy-server statistics Field Descriptions
Field Description
HTTP 200 OK Client request was accepted successfully.
HTTP 400 BadReq Malformed request, or the request had invalid
parameters.
HTTP 401 UnAuthorized Req Proper credentials (username and password) to access
a resource was not provided.
HTTP 403 Req Forbidden Server refused to honor the client request.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
127
Cisco TrustSec
show cts policy-server
Field Description
HTTP 404 NotFound Invalid URL.
HTTP 408 ReqTimeout Request timed out.
HTTP 415 UnSupported Media Server unable to process the requested content-type.
HTTP 500 ServerErr Internal server error or exception.
TCP or TLS handshake error IP unreachable or the Transport Layer Security (TLS)
handshake failed due to invalid trust-point.
Related Commands Command Description
cts policy-server name Configures a Cisco TrustSec policy server and
enters policy-server configuration mode.
debug cts policy-server Enables Cisco TrustSec policy-server
debugging.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
128
Cisco TrustSec
show cts role-based counters
show cts role-based counters
To display Security Group access control list (ACL) enforcement statistics, use the show cts role-based
counters command in user EXEC or privileged EXEC mode.
show cts role-based counters [{default [{ipv4 | ipv6}]}] [{from {sgt-number | unknown}[{ipv4 | ipv6
| to | {sgt-number | unknown} | [{ipv4 | ipv6}]}]} ][{to {sgt-number | unknown} [{ipv4 | ipv6}]}]
[{ipv4 | ipv6}]
Syntax Description default (Optional) Displays information
about the default policy counters.
from (Optional) Displays information
about the source security group.
ipv4 (Optional) Displays information
about security groups on IPv4
networks.
ipv6 (Optional) Displays information
about security groups on IPv6
networks.
to (Optional) Displays information
about the destination security group.
sgt-number (Optional) Security Group Tag
number. Valid values are from 0 to
65533.
unknown (Optional) Displays information
about all source groups.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Usage Guidelines Use the clear cts role-based counterscommand to reset all or a range of statistics.
Specify the source SGT with the from keyword and the destination SGT with the to keyword. All statistics
are displayed when both the from and to keywords are omitted.
The default keyword displays the statistics of the default unicast policy. When neither ipv4 nor ipv6 keywords
are specified, this command displays only IPv4 counters.
In Cisco TrustSec monitor mode, permitted traffic counters are displayed under the SW-Permitt label and the
denied traffic counters are displayed under SW-Monitor label.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
129
Cisco TrustSec
show cts role-based counters
Example
The following is sample output from the show cts role-based counters
Device# show cts role-based counters
Role-based IPv4 counters
From To SW-Denied HW-Denied SW-Permitt HW-Permitt SW-Monitor HW-Monitor
12 24 0 0 0 0 0 0
12 77 0 0 5 0 0 0
The table below lists the significant fields shown in the display.
Table 7: show cts role-based counters Field Descriptions
Field Description
From Source security group.
To Destination security group.
SW-Permitt Permitted traffic counters.
SW-Monitor Denied traffic counters.
Related Commands Command Description
clear role-basedcounters Resets SGACL statistic counters.
cts role-based Maps IP addresses, Layer 3 interfaces, and VRFs to
SGTs. Enables Cisco TrustSec caching and SGACL
enforcement.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
130
Cisco TrustSec
show cts role-based permissions
show cts role-based permissions
To display the role-based (security group) access control permission list, use the show cts role-based
permissions command in privileged EXEC mode.
show cts role-based permissions [{default [{details | ipv4 [details] | ipv6 [details]}] | from {{sgt
| unknown }[{ipv4 | ipv6 | to {{sgt | unknown}[{details | ipv4 [details] | ipv6 [details]}]}}}] |
ipv4 | ipv6 | platform | to {sgt | unknown}[{ipv4 | ipv6}]}]
Syntax Description default (Optional) Displays information about the default permission list.
details (Optional) Displays attached access control list (ACL) details.
ipv4 (Optional) Displays information about the IPv4 protocol.
ipv6 (Optional) Displays information about the IPv6 protocol.
from (Optional) Displays information about the source group.
sgt (Optional) Security Group Tag. Valid values are from 2 to 65519.
to (Optional) Displays information about the destination group.
unknown (Optional) Displays information about unknown source and destination groups.
platform (Optional) Displays information about the platform.
Command Modes Privileged EXE (#)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines This command displays the content of the SGACL permission matrix. You can specify the source security
group tag (SGT) by using the from keyword and the destination SGT by using the to keyword. When both
these keywords are specified RBACLs of a single cell are displayed. An entire column is displayed when only
the to keyword is used. An entire row is displayed when the from keyword is used. The entire permission
matrix is displayed when both the from and to keywords are omitted.
The command output is sorted by destination SGT as a primary key and the source SGT as a secondary key.
SGACLs for each cell is displayed in the same order they are defined in the configuration or acquired from
Cisco Identity Services Engine (ISE).
The details keyword is provided when a single cell is selected by specifying both from and to keywords.
When the details keyword is specified the access control entries of SGACLs of a single cell are displayed.
The following is sample output from the show role-based permissions command:
Device# show cts role-based permissions
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
131
Cisco TrustSec
show cts role-based permissions
IPv4 Role-based permissions default (monitored):
default_sgacl-02
Permit IP-00
IPv4 Role-based permissions from group 305:sgt to group 306:dgt (monitored):
test_reg_tcp_permit-02
RBACL Monitor All for Dynamic Policies : TRUE
RBACL Monitor All for Configured Policies : FALSE
IPv4 Role-based permissions from group 6:SGT_6 to group 6:SGT_6 (configured):
mon_1
IPv4 Role-based permissions from group 10 to group 11 (configured):
mon_2
RBACL Monitor All for Dynamic Policies : FALSE
RBACL Monitor All for Configured Policies : FALSE
Related Commands Command Description
cts role-based permissions Enables permissions from a source group to a destination group.
cts role-based monitor Enables role-based access list monitoring.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
132
Cisco TrustSec
show cts server-list
show cts server-list
To display the list of HTTP and RADIUS servers available to Cisco TrustSec seed and nonseed devices, use
the show cts server-list command in user EXEC or privileged EXEC mode.
show cts server-list
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Cisco IOS XE Amsterdam 17.1.1 The output of this command was modified to display the HTTP server
address and status information.
Usage Guidelines This command is useful for gathering Cisco TrustSec RADIUS server address and status information.
In Cisco IOS XE Gibraltar 17.1.1 and later releases, the output of this command displays HTTP server address
and their status information.
Examples Cisco IOS XE Amsterdam 17.1.1
The following sample output from the show cts server-list command displays HTTP servers and
their status information:
Device> show cts server-list
HTTP Server-list:
Server Name: Http_Server_1
Server Status: DEAD
IPv4 Address: 10.78.105.148
IPv6 Address: Not Supported
Domain-name: http_server_1.ise.com
Port: 9063
Server Name: Http_Server_2
Server Status: ALIVE
IPv4 Address: 10.78.105.149
IPv6 Address: Not Supported
Domain-name: http_server_2.ise.com
Status = ALIVE
Prior to Cisco IOS XE Amsterdam 17.1.1
The following example displays the Cisco TrustSec RADIUS server list:
Device> show cts server-list
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
133
Cisco TrustSec
show cts server-list
CTS Server Radius Load Balance = DISABLED
Server Group Deadtime = 20 secs (default)
Global Server Liveness Automated Test Deadtime = 20 secs
Global Server Liveness Automated Test Idle Time = 60 mins
Global Server Liveness Automated Test = ENABLED (default)
Preferred list, 1 server(s):
*Server: 10.0.1.6, port 1812, A-ID 1100E046659D4275B644BF946EFA49CD
Status = ALIVE
auto-test = TRUE, idle-time = 60 mins, deadtime = 20 secs
Installed list: ACSServerList1-0001, 1 server(s):
*Server: 101.0.2.61, port 1812, A-ID 1100E046659D4275B644BF946EFA49CD
Status = ALIVE
auto-test = TRUE, idle-time = 60 mins, deadtime = 20 secs
Related Commands Command Description
address ipv4 (config-radius-server) Configures the RADIUS server accounting and authentication
parameters for PAC provisioning.
pac key Specifies the PAC encryption key.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
134
Cisco TrustSec
show cts sxp
show cts sxp
To display Cisco TrustSec Security Group Tag (SGT) Exchange Protocol (CTS-SXP) connection or source
IP-to-SGT mapping information, use the show cts sxp command in user EXEC or privileged EXEC mode.
show cts sxp {connections [{brief | vrf instance-name}] | filter-group [{detailed | global | listener
| speaker }] | filter-list filter-list-name | sgt-map [{brief | vrf instance-name}]} [{brief | vrf
instance-name}]
Syntax Description connections Displays Cisco TrustSec SXP connections information.
brief (Optional) Displays an abbreviation of the SXP information.
vrf instance-name (Optional) Displays the SXP information for the specified Virtual
Routing and Forwarding (VRF) instance name.
filter-group {detailed | global | (Optional) Displays filter group information.
listener | speaker }
filter-list filter-list-name (Optional) Displays filter list information.
sgt-map (Optional) Displays the IP-to-SGT mappings received through SXP.
Command Default None
Command Modes
User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Examples The following example displays the SXP connections using the brief keyword:
Device# show cts sxp connection brief
SXP : Enabled
Default Password : Set
Default Source IP: Not Set
Connection retry open period: 10 secs
Reconcile period: 120 secs
Retry open timer is not running
-----------------------------------------------------------------------------
Peer_IP Source_IP Conn Status Duration
-----------------------------------------------------------------------------
10.10.10.1 10.10.10.2 On 0:00:02:14 (dd:hr:mm:sec)
10.10.2.1 10.10.2.2 On 0:00:02:14 (dd:hr:mm:sec)
Total num of SXP Connections = 2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
135
Cisco TrustSec
show cts sxp
The following example displays the CTS-SXP connections:
Device# show cts sxp connections
SXP : Enabled
Default Password : Set
Default Source IP: Not Set
Connection retry open period: 10 secs
Reconcile period: 120 secs
Retry open timer is not running
----------------------------------------------
Peer IP : 10.10.10.1
Source IP : 10.10.10.2
Set up : Peer
Conn status : On
Connection mode : SXP Listener
Connection inst# : 1
TCP conn fd : 1
TCP conn password: not set (using default SXP password)
Duration since last state change: 0:00:01:25 (dd:hr:mm:sec)
----------------------------------------------
Peer IP : 10.10.2.1
Source IP : 10.10.2.2
Set up : Peer
Conn status : On
Connection mode : SXP Listener
TCP conn fd : 2
TCP conn password: not set (using default SXP password)
Duration since last state change: 0:00:01:25 (dd:hr:mm:sec)
Total num of SXP Connections = 2
The following example displays the CTS-SXP connections for a bi-directional connection when the
device is both the speaker and listener:
Device# show cts sxp connections
SXP : Enabled
Highest Version Supported: 4
Default Password : Set
Default Source IP: Not Set
Connection retry open period: 120 secs
Reconcile period: 120 secs
Retry open timer is running
----------------------------------------------
Peer IP : 2.0.0.2
Source IP : 1.0.0.2
Conn status : On (Speaker) :: On (Listener)
Conn version : 4
Local mode : Both
Connection inst# : 1
TCP conn fd : 1(Speaker) 3(Listener)
TCP conn password: default SXP password
Duration since last state change: 1:03:38:03 (dd:hr:mm:sec) :: 0:00:00:46 (dd:hr:mm:sec)
The following example displays output from a CTS-SXP listener with a torn down connection to the
SXP speaker. Source IP-to-SGT mappings are held for 120 seconds, the default value of the delete
hold down timer.
Device# show cts sxp connections
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
136
Cisco TrustSec
show cts sxp
SXP : Enabled
Default Password : Set
Default Source IP: Not Set
Connection retry open period: 10 secs
Reconcile period: 120 secs
Retry open timer is not running
----------------------------------------------
Peer IP : 10.10.10.1
Source IP : 10.10.10.2
Set up : Peer
Conn status : Delete_Hold_Down
Connection mode : SXP Listener
Connection inst# : 1
TCP conn fd : -1
TCP conn password: not set (using default SXP password)
Delete hold down timer is running
Duration since last state change: 0:00:00:16 (dd:hr:mm:sec)
----------------------------------------------
Peer IP : 10.10.2.1
Source IP : 10.10.2.2
Set up : Peer
Conn status : On
Connection inst# : 1
TCP conn fd : 2
TCP conn password: not set (using default SXP password)
Duration since last state change: 0:00:05:49 (dd:hr:mm:sec)
Total num of SXP Connections = 2
Related Commands Command Description
cts sxp connection peer Enters the Cisco TrustSec SXP peer IP address and specifies if a password is
used for the peer connection
cts sxp default password Configures the Cisco TrustSec SXP default password.
cts sxp default source-ip Configures the Cisco TrustSec SXP source IPv4 address.
cts sxp enable Enables Cisco TrustSec SXP on a device.
cts sxp log Enables logging for IP-to-SGT binding changes.
cts sxp reconciliation Changes the Cisco TrustSec SXP reconciliation period.
cts sxp retry Changes the Cisco TrustSec SXP retry period timer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
137
Cisco TrustSec
show platform hardware fed switch active fwd-asic resource tcam utilization
show platform hardware fed switch active fwd-asic resource
tcam utilization
To display CAM utilization information for ASIC, use the show platform hardware fed switch active
fwd-asic resource tcam utilization command in privileged EXEC mode.
show platform hardware fed switch active fwd-asic resource tcam utilization [ asic-number ] [ slice-id
]
Syntax Description asic-number Displays the ASIC number. Valid values are from
0 to 7.
slice-id Displays per slice usage.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is sample output from the show platform hardware fed switch active fwd-asic
resource tcam utilization command:
Device# enable
Device# show platform hardware fed switch active fwd-asic resource tcam utilization
CAM Utilization for ASIC [0]
Table Subtype Dir Max Used %Used V4 V6
MPLS Other
------------------------------------------------------------------------------------------------------
Mac Address Table EM I 32768 25 0.08% 0 0
0 25
Mac Address Table TCAM I 1024 22 2.15% 0 0
0 22
L3 Multicast EM I 8192 0 0.00% 0 0
0 0
L3 Multicast TCAM I 512 9 1.76% 3 6
0 0
L2 Multicast EM I 8192 0 0.00% 0 0
0 0
L2 Multicast TCAM I 512 11 2.15% 3 8
0 0
IP Route Table EM I 24576 14 0.06% 13 0
1 0
IP Route Table TCAM I 8192 30 0.37% 11 16
2 1
QOS ACL TCAM IO 5120 85 1.66% 28 38
0 19
TCAM I 45 0.88% 15 20
0 10
TCAM O 40 0.78% 13 18
0 9
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
138
Cisco TrustSec
show platform hardware fed switch active fwd-asic resource tcam utilization
Security ACL TCAM IO 5120 131 2.56% 26 60
0 45
TCAM I 88 1.72% 12 36
0 40
TCAM O 43 0.84% 14 24
0 5
Netflow ACL TCAM I 256 6 2.34% 2 2
0 2
PBR ACL TCAM I 1024 36 3.52% 30 6
0 0
Netflow ACL TCAM O 768 6 0.78% 2 2
0 2
Flow SPAN ACL TCAM IO 1024 13 1.27% 3 6
0 4
TCAM I 5 0.49% 1 2
0 2
TCAM O 8 0.78% 2 4
0 2
Control Plane TCAM I 512 290 56.64% 138 106
0 46
Tunnel Termination TCAM I 512 22 4.30% 9 13
0 0
Lisp Inst Mapping TCAM I 2048 2 0.10% 0 0
0 2
Security Association TCAM I 256 4 1.56% 2 2
0 0
CTS Cell Matrix/VPN
Label EM O 8192 0 0.00% 0 0
0 0
CTS Cell Matrix/VPN
Label TCAM O 512 1 0.20% 0 0
0 1
Client Table EM I 4096 0 0.00% 0 0
0 0
Client Table TCAM I 256 0 0.00% 0 0
0 0
Input Group LE TCAM I 1024 0 0.00% 0 0
0 0
Output Group LE TCAM O 1024 0 0.00% 0 0
0 0
Macsec SPD TCAM I 256 2 0.78% 0 0
0 2
Output fields are self-explanatory.
Related Commands Command Description
show platform hardware fed switch active fwd-asic Displays the current CAM table.
resource tcam table
show platform hardware fed switch active fwd-asic Displays the current CAM usage.
resource tcam usage
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
139
Cisco TrustSec
show platform hardware fed switch active sgacl resource usage
show platform hardware fed switch active sgacl resource usage
To display Security Group access control list (SGACL) resource information for Application Specific Integrated
Circuit (ASIC), use the show platform hardware fed switch active sgacl resource usage command in
privileged EXEC mode.
show platform hardware fed switch active sgacl resource usage
Syntax Description usage Displays SGACL resource usage.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is a sample output from the show platform hardware fed switch active sgacl resource
usage command:
Device# enable
Device# show platform hardware fed switch active sgacl resource usage
SGACL RESOURCE DETAILS ASIC :#0
================================
Percent Thresholds
Hardware Resource MAX Used Used Upper Lower
---------------------------------------------------------------------------
CTS Cell Matrix Config : 80 70
CTS Cell Matrix Entries : 8192 0 0 Normal
CTS Cell Overflow Entries : 512 1 0
Policy Configuration : 80 70
Policy Entries : 256 3 1 Normal
DGT Config : 80 70
DGT Entries : 4096 0 0 Normal
Security ACL Configured : 80 70
Security ACL Entries : 5120 131 2 Normal
Total Percent
SGACL TCAM Entries Used Used
------------------------------------------------------------------
Output PRE SGACL : 4 12
Output SGACL : 0 0
Output SGACL DEFAULT : 0 0
.
.
.
Device#
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
140
Cisco TrustSec
show platform software classification switch active F0 class-group-manager class-group client acl all
show platform software classification switch active F0
class-group-manager class-group client acl all
To display ACL class group ID, which is used to view Ternary Content Addressable Memory(TCAM) entry,
use the show platform software classification switch active F0 class-group-manager class-group client
acl all command in privileged EXEC mode.
show platform software classification switch active F0 class-group-manager class-group client acl all
Syntax Description class-group-manager Displays the class group manager.
class-group Displays the class group.
all Displays the ACL class group ID for all class
groups.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software classification switch active F0
class-group-manager class-group client acl all command:
Device#show platform software classification switch active F0 class-group-manager class-group
client acl all
QFP classification class client all group
class-group [ACL-GRP:273]
class-group [ACL-GRP:529]
class-group [ACL-GRP:801]
Output fields are self-explanatory.
Related Commands Command Description
show platform software classification switch active F0 Displays ACL class group information for the
class-group-manager class-group client acl name specified class group.
class-group name
show platform software classification switch active F0 Displays ACL class group information for the
class-group-manager class-group client acl class-group specified class group.
id
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
141
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 port
show platform software cts forwarding-manager switch active
F0 port
To display CTS information for forwarding manager interfaces, use the show platform software cts
forwarding-manager switch active F0 port command in privileged EXEC mode.
show platform software cts forwarding-manager switch active F0 port
Syntax Description F0 Embedded service processor slot
0.
port Displays the port CTS status.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software cts forwarding-manager switch active
F0 port command:
Device#show platform software cts forwarding-manager switch active F0 port
Forwarding Manager Interfaces CTS Information
Name ID CTS Enable Trusted Propagate SGT value
-----------------------------------------------------------------------------------
GigabitEthernet1/0/1 77 0 0 0 0
GigabitEthernet1/0/3 79 0 0 0 0
GigabitEthernet1/0/4 80 0 0 0 0
GigabitEthernet1/0/5 81 0 0 0 0
GigabitEthernet1/0/6 82 0 0 0 0
GigabitEthernet1/0/7 83 0 0 0 0
GigabitEthernet1/0/8 84 0 0 0 0
GigabitEthernet1/0/9 85 0 0 0 0
GigabitEthernet1/0/10 86 0 0 0 0
GigabitEthernet1/0/11 87 0 0 0 0
GigabitEthernet1/0/12 88 0 0 0 0
GigabitEthernet1/0/13 89 0 0 0 0
GigabitEthernet1/0/14 90 0 0 0 0
GigabitEthernet1/0/15 91 0 0 0 0
GigabitEthernet1/0/16 92 0 0 0 0
GigabitEthernet1/0/17 93 0 0 0 0
GigabitEthernet1/0/18 94 0 0 0 0
GigabitEthernet1/0/19 95 0 0 0 0
GigabitEthernet1/0/20 96 0 0 0 0
GigabitEthernet1/0/21 97 0 0 0 0
GigabitEthernet1/0/22 98 0 0 0 0
GigabitEthernet1/0/23 99 0 0 0 0
GigabitEthernet1/0/24 100 0 0 0 0
GigabitEthernet1/0/25 101 0 0 0 0
GigabitEthernet1/0/26 102 0 0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
142
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 port
GigabitEthernet1/0/27 103 0 0 0 0
GigabitEthernet1/0/28 104 0 0 0 0
GigabitEthernet1/0/29 105 0 0 0 0
GigabitEthernet1/0/30 106 0 0 0 0
GigabitEthernet1/0/31 107 0 0 0 0
GigabitEthernet1/0/32 108 0 0 0 0
GigabitEthernet1/0/33 109 0 0 0 0
GigabitEthernet1/0/34 110 0 0 0 0
GigabitEthernet1/0/35 111 0 0 0 0
GigabitEthernet1/0/36 112 0 0 0 0
GigabitEthernet1/0/37 113 0 0 0 0
GigabitEthernet1/0/38 114 0 0 0 0
GigabitEthernet1/0/39 115 0 0 0 0
GigabitEthernet1/0/40 116 0 0 0 0
GigabitEthernet1/0/41 117 0 0 0 0
Forwarding Manager Interfaces CTS Information
Name ID CTS Enable Trusted Propagate SGT value
-----------------------------------------------------------------------------------
GigabitEthernet1/0/42 118 0 0 0 0
GigabitEthernet1/0/43 119 0 0 0 0
GigabitEthernet1/0/44 120 0 0 0 0
GigabitEthernet1/0/45 121 0 0 0 0
GigabitEthernet1/0/46 122 0 0 0 0
GigabitEthernet1/0/47 123 0 0 0 0
GigabitEthernet1/1/1 125 0 0 0 0
GigabitEthernet1/1/2 126 0 0 0 0
GigabitEthernet1/1/3 127 0 0 0 0
GigabitEthernet1/1/4 128 0 0 0 0
TenGigabitEthernet1/1/1 129 0 0 0 0
TenGigabitEthernet1/1/2 130 0 0 0 0
TenGigabitEthernet1/1/3 131 0 0 0 0
TenGigabitEthernet1/1/4 132 0 0 0 0
TenGigabitEthernet1/1/5 133 0 0 0 0
TenGigabitEthernet1/1/6 134 0 0 0 0
TenGigabitEthernet1/1/7 135 0 0 0 0
TenGigabitEthernet1/1/8 136 0 0 0 0
FortyGigabitEthernet1/1/1 137 0 0 0 0
FortyGigabitEthernet1/1/2 138 0 0 0 0
TwentyFiveGigE1/1/1 139 0 0 0 0
TwentyFiveGigE1/1/2 140 0 0 0 0
AppGigabitEthernet1/0/1 141 0 0 0 0
GigabitEthernet2/0/1 142 1 0 0 0
GigabitEthernet2/0/2 143 0 0 0 0
GigabitEthernet2/0/3 144 0 0 0 0
GigabitEthernet2/0/4 145 0 0 0 0
GigabitEthernet2/0/5 146 0 0 0 0
GigabitEthernet2/0/6 147 0 0 0 0
GigabitEthernet2/0/7 148 0 0 0 0
GigabitEthernet2/0/8 149 0 0 0 0
GigabitEthernet2/0/9 150 0 0 0 0
GigabitEthernet2/0/10 151 0 0 0 0
GigabitEthernet2/0/11 152 0 0 0 0
GigabitEthernet2/0/12 153 0 0 0 0
GigabitEthernet2/0/13 154 0 0 0 0
GigabitEthernet2/0/14 155 0 0 0 0
GigabitEthernet2/0/15 156 0 0 0 0
GigabitEthernet2/0/16 157 0 0 0 0
GigabitEthernet2/0/17 158 0 0 0 0
Forwarding Manager Interfaces CTS Information
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
143
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 port
Name ID CTS Enable Trusted Propagate SGT value
-----------------------------------------------------------------------------------
GigabitEthernet2/0/18 159 0 0 0 0
GigabitEthernet2/0/19 160 0 0 0 0
GigabitEthernet2/0/20 161 0 0 0 0
GigabitEthernet2/0/21 162 0 0 0 0
GigabitEthernet2/0/22 163 0 0 0 0
GigabitEthernet2/0/23 164 0 0 0 0
GigabitEthernet2/0/24 165 0 0 0 0
GigabitEthernet2/0/25 166 0 0 0 0
GigabitEthernet2/0/26 167 0 0 0 0
GigabitEthernet2/0/27 168 0 0 0 0
GigabitEthernet2/0/28 169 0 0 0 0
GigabitEthernet2/0/29 170 0 0 0 0
GigabitEthernet2/0/30 171 0 0 0 0
GigabitEthernet2/0/31 172 0 0 0 0
GigabitEthernet2/0/32 173 0 0 0 0
GigabitEthernet2/0/33 174 0 0 0 0
GigabitEthernet2/0/34 175 0 0 0 0
GigabitEthernet2/0/35 176 0 0 0 0
GigabitEthernet2/0/36 177 0 0 0 0
GigabitEthernet2/0/37 178 0 0 0 0
GigabitEthernet2/0/38 179 0 0 0 0
GigabitEthernet2/0/39 180 0 0 0 0
GigabitEthernet2/0/40 181 0 0 0 0
GigabitEthernet2/0/41 182 0 0 0 0
GigabitEthernet2/0/42 183 0 0 0 0
GigabitEthernet2/0/43 184 0 0 0 0
GigabitEthernet2/0/44 185 0 0 0 0
GigabitEthernet2/0/45 186 0 0 0 0
GigabitEthernet2/0/46 187 0 0 0 0
GigabitEthernet2/0/47 188 0 0 0 0
GigabitEthernet2/1/1 190 0 0 0 0
GigabitEthernet2/1/2 191 0 0 0 0
GigabitEthernet2/1/3 192 0 0 0 0
GigabitEthernet2/1/4 193 0 0 0 0
TenGigabitEthernet2/1/1 194 0 0 0 0
TenGigabitEthernet2/1/2 195 0 0 0 0
TenGigabitEthernet2/1/3 196 0 0 0 0
TenGigabitEthernet2/1/4 197 0 0 0 0
TenGigabitEthernet2/1/5 198 0 0 0 0
TenGigabitEthernet2/1/6 199 0 0 0 0
Forwarding Manager Interfaces CTS Information
Name ID CTS Enable Trusted Propagate SGT value
-----------------------------------------------------------------------------------
TenGigabitEthernet2/1/7 200 0 0 0 0
TenGigabitEthernet2/1/8 201 0 0 0 0
FortyGigabitEthernet2/1/1 202 0 0 0 0
FortyGigabitEthernet2/1/2 203 0 0 0 0
TwentyFiveGigE2/1/1 204 0 0 0 0
TwentyFiveGigE2/1/2 205 0 0 0 0
AppGigabitEthernet2/0/1 206 0 0 0 0
GigabitEthernet1/0/2 213 0 0 0 0
The following table explains the significant fields shown in the output:
Table 8: show platform software cts forwarding-manager switch active F0 port Field Descriptions
Field Description
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
144
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 port
Name The name of the interface.
ID The interface ID.
CTS The status of CTS.
Enable
Trusted The trusted status of the interface.
Propagate The propagation status of the interface.
SGT value The value of SGT.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
145
Cisco TrustSec
show platform software cts forwarding-manager switch active F0
show platform software cts forwarding-manager switch active
F0
To display Security Group Tag (SGT) binding table, use the show platform software cts forwarding-manager
switch active F0 command in privileged EXEC mode.
show platform software cts forwarding-manager switch active F0
Syntax Description F0 Selects embedded service processor slot
0.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software cts forwarding-manager switch active
F0 command:
Device#show platform software cts forwarding-manager switch active F0
SGT Binding Table
Number of bindings: 1
2.2.2.2/32
SGT Src: 2
SGT Dst: 2
SGT Binding Table
Output fields are self-explanatory.
Related Commands Command Description
show platform software cts forwarding-manager switch Displays the port CTS status.
active F0 port
show platform software cts forwarding-manager switch Displays the SGACL permissions.
active F0 permissions
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
146
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 permissions
show platform software cts forwarding-manager switch active
F0 permissions
To display Security group access control lists (SGACLs) permissions, use the show platform software cts
forwarding-manager switch active F0 permissions command in privileged EXEC mode.
show platform software cts forwarding-manager switch active F0 permissions
Syntax Description F0 Selects embedded service processor slot
0.
permissions Displays SGACL permissions.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is sample output from the show platform software cts forwarding-manager switch active
F0 permissions command:
Device#show platform software cts forwarding-manager switch active F0 permissions
Forwarding Manager CTS permissions Information
sgt dgt ACL Group Name
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
4 2 V4SGACL7100
65535 65535 V4SGACL8100
65535 65535 V6SGACL9100
The following table explains the significant fields shown in the output:
Table 9: show platform software cts forwarding-manager switch active F0 permissions Field Descriptions
Field Description
sgt The source group tag.
dgt The destination group tag.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
147
Cisco TrustSec
show platform software cts forwarding-manager switch active F0 permissions
ACL Group The name of the ACL
Name group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
148
Cisco TrustSec
show platform software fed switch active acl counters hardware | inc SGACL
show platform software fed switch active acl counters
hardware | inc SGACL
To display counters from the forwarding engine driver, use the show platform software fed switch active
acl counters hardware | inc SGACL command in privileged EXEC mode.
show platform software fed switch active acl counters hardware | inc SGACL
Syntax Description counters Displays counter information.
hardware Displays hardware counters.
include Includes lines that match the specified string.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software fed switch active acl counters hardware
| inc SGACL command:
Device# show platform software fed switch active acl counters hardware | inc SGACL
Egress IPv4 SGACL Drop (0x3f000061): 0 frames
Egress IPv6 SGACL Drop (0x13000062): 0 frames
Egress IPv4 SGACL Test Cell Drop (0xd2000063): 0 frames
Egress IPv6 SGACL Test Cell Drop (0x40000064): 0 frames
Egress IPv4 Pre SGACL Forward (0x2c000067): 0 frames
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
149
Cisco TrustSec
show platform software fed switch active acl usage
show platform software fed switch active acl usage
To display Security Group access control lists (SGACLs) usage, use the show platform software fed switch
active acl usage command in privileged EXEC mode.
show platform software fed switch active acl usage
Syntax Description usage Displays ACL
usage.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is sample output from the show platform software fed switch active acl usage command:
Device# show platform software fed switch active acl usage
########################################################
######## ##################
####### Printing Usage Infos #################
######## ##################
########################################################
##### ACE Software VMR max:196608 used:282
########################################################
==================================================================================================
Feature Type ACL Type Dir Name Entries
Used
SGACL IPV4 Egress V4SGACL7100 2
==================================================================================================
Feature Type ACL Type Dir Name Entries
Used
SGACL_CATCHALL IPV4 Egress V4SGACL8100 1
==================================================================================================
Feature Type ACL Type Dir Name Entries
Used
SGACL_CATCHALL IPV6 Egress V6SGACL9100 1
==================================================================================================
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
150
Cisco TrustSec
show platform software fed switch active ifm mappings
show platform software fed switch active ifm mappings
show platform software fed switch active ifm mappings
Syntax Description ifm Displays interface manager information.
mappings Displays interface to hardware mapping information.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software fed switch active ifm mappings command:
Device#show platform software fed switch active ifm mappings
Interface IF_ID Inst Asic Core Port SubPort Mac Cntx LPN GPN Type
Active
GigabitEthernet3/0/1 0xa 1 0 1 0 0 26 6 1 193 NIF Y
GigabitEthernet3/0/2 0xb 1 0 1 1 0 6 7 2 194 NIF Y
GigabitEthernet3/0/3 0xc 1 0 1 2 0 28 8 3 195 NIF Y
GigabitEthernet3/0/4 0xd 1 0 1 3 0 27 9 4 196 NIF Y
GigabitEthernet3/0/5 0xe 1 0 1 4 0 30 10 5 197 NIF Y
GigabitEthernet3/0/6 0xf 1 0 1 5 0 29 11 6 198 NIF Y
GigabitEthernet3/0/7 0x10 1 0 1 6 0 32 12 7 199 NIF Y
GigabitEthernet3/0/8 0x11 1 0 1 7 0 31 13 8 200 NIF Y
GigabitEthernet3/0/9 0x12 1 0 1 8 0 19 14 9 201 NIF Y
GigabitEthernet3/0/10 0x13 1 0 1 9 0 5 15 10 202 NIF Y
GigabitEthernet3/0/11 0x14 1 0 1 10 0 21 16 11 203 NIF Y
GigabitEthernet3/0/12 0x15 1 0 1 11 0 20 17 12 204 NIF Y
GigabitEthernet3/0/13 0x16 1 0 1 12 0 23 18 13 205 NIF Y
GigabitEthernet3/0/14 0x17 1 0 1 13 0 22 19 14 206 NIF Y
GigabitEthernet3/0/15 0x18 1 0 1 14 0 25 20 15 207 NIF Y
GigabitEthernet3/0/16 0x19 1 0 1 15 0 24 21 16 208 NIF Y
GigabitEthernet3/0/17 0x1a 1 0 1 16 0 12 22 17 209 NIF Y
GigabitEthernet3/0/18 0x1b 1 0 1 17 0 4 23 18 210 NIF Y
GigabitEthernet3/0/19 0x1c 1 0 1 18 0 14 24 19 211 NIF Y
GigabitEthernet3/0/20 0x1d 1 0 1 19 0 13 25 20 212 NIF Y
GigabitEthernet3/0/21 0x1e 1 0 1 20 0 16 26 21 213 NIF Y
GigabitEthernet3/0/22 0x1f 1 0 1 21 0 15 27 22 214 NIF Y
GigabitEthernet3/0/23 0x20 1 0 1 22 0 18 28 23 215 NIF Y
GigabitEthernet3/0/24 0x21 1 0 1 23 0 17 29 24 216 NIF Y
GigabitEthernet3/0/25 0x22 0 0 0 24 0 26 6 25 217 NIF Y
GigabitEthernet3/0/26 0x23 0 0 0 25 0 6 7 26 218 NIF Y
GigabitEthernet3/0/27 0x24 0 0 0 26 0 28 8 27 219 NIF Y
GigabitEthernet3/0/28 0x25 0 0 0 27 0 27 9 28 220 NIF Y
GigabitEthernet3/0/29 0x26 0 0 0 28 0 30 10 29 221 NIF Y
GigabitEthernet3/0/30 0x27 0 0 0 29 0 29 11 30 222 NIF Y
GigabitEthernet3/0/31 0x28 0 0 0 30 0 32 12 31 223 NIF Y
GigabitEthernet3/0/32 0x29 0 0 0 31 0 31 13 32 224 NIF Y
GigabitEthernet3/0/33 0x2a 0 0 0 32 0 19 14 33 225 NIF Y
GigabitEthernet3/0/34 0x2b 0 0 0 33 0 5 15 34 226 NIF Y
GigabitEthernet3/0/35 0x2c 0 0 0 34 0 21 16 35 227 NIF Y
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
151
Cisco TrustSec
show platform software fed switch active ifm mappings
GigabitEthernet3/0/36 0x2d 0 0 0 35 0 20 17 36 228 NIF Y
GigabitEthernet3/0/37 0x2e 0 0 0 36 0 23 18 37 229 NIF Y
GigabitEthernet3/0/38 0x2f 0 0 0 37 0 22 19 38 230 NIF Y
GigabitEthernet3/0/39 0x30 0 0 0 38 0 25 20 39 231 NIF Y
GigabitEthernet3/0/40 0x31 0 0 0 39 0 24 21 40 232 NIF Y
GigabitEthernet3/0/41 0x32 0 0 0 40 0 12 22 41 233 NIF Y
GigabitEthernet3/0/42 0x33 0 0 0 41 0 4 23 42 234 NIF Y
GigabitEthernet3/0/43 0x34 0 0 0 42 0 14 24 43 235 NIF Y
GigabitEthernet3/0/44 0x35 0 0 0 43 0 13 25 44 236 NIF Y
GigabitEthernet3/0/45 0x36 0 0 0 44 0 16 26 45 237 NIF Y
GigabitEthernet3/0/46 0x37 0 0 0 45 0 15 27 46 238 NIF Y
GigabitEthernet3/0/47 0x38 0 0 0 46 0 18 28 47 239 NIF Y
GigabitEthernet3/0/48 0xd8 0 0 0 47 0 17 29 48 240 NIF Y
GigabitEthernet3/1/1 0x3a 1 0 1 48 0 3 4 49 241 NIF N
GigabitEthernet3/1/2 0x3b 1 0 1 49 0 2 5 50 242 NIF N
GigabitEthernet3/1/3 0x3c 0 0 0 50 0 3 4 51 243 NIF N
GigabitEthernet3/1/4 0x3d 0 0 0 51 0 2 5 52 244 NIF N
TenGigabitEthernet3/1/1 0x3e 1 0 1 52 0 3 3 53 245 NIF N
TenGigabitEthernet3/1/2 0x3f 1 0 1 53 0 2 2 54 246 NIF N
TenGigabitEthernet3/1/3 0x40 1 0 1 54 0 1 1 55 247 NIF N
TenGigabitEthernet3/1/4 0x41 1 0 1 55 0 0 0 56 248 NIF N
TenGigabitEthernet3/1/5 0x42 0 0 0 56 0 3 3 57 249 NIF N
TenGigabitEthernet3/1/6 0x43 0 0 0 57 0 2 2 58 250 NIF N
TenGigabitEthernet3/1/7 0x44 0 0 0 58 0 1 1 59 251 NIF N
TenGigabitEthernet3/1/8 0x45 0 0 0 59 0 0 0 60 252 NIF N
FortyGigabitEthernet3/1/1 0x46 1 0 1 60 0 0 0 61 253 NIF N
FortyGigabitEthernet3/1/2 0x47 0 0 0 61 0 0 0 62 254 NIF N
TwentyFiveGigE3/1/1 0x48 1 0 1 62 0 0 0 63 255 NIF N
TwentyFiveGigE3/1/2 0x49 0 0 0 63 0 0 0 64 256 NIF N
AppGigabitEthernet3/0/1 0x4a 1 0 1 24 0 11 30 65 257 NIF Y
The following table explains the significant fields shown in the output:
Table 10: show platform software fed switch active ifm mappings Field Descriptions
Field Description
Interface The name of the interface.
IF_ID The interface ID.
Inst The instance ID.
Asic The ASIC number.
Core The core number.
Port The port number of the interface.
SubPort The number of subports.
MAC The MAC address.
LPN The local port number inside ASIC.
GPN The global system number inside switch.
Type The type of interface.
Active The interface status (active/inactive).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
152
Cisco TrustSec
show platform software fed switch active ip route
show platform software fed switch active ip route
To display IP route information, use the show platform software fed switch active ip route command in
privileged EXEC mode.
show platform software fed switch active ip route
Syntax Description ip Accepts IP commands.
route Displays IPv4 Forwarding Information Base (FIB) details.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is sample output from the show platform software fed switch active ip route command:
Device# show platform software fed switch active ip route
vrf dest htm flags SGT DGID MPLS
Last-modified SecsSinceHit
--- ---- --- ----- --- ---- ----
------------------------ ------------
2 0.0.0.0/0 0x78f2fd3488a8 0x0 0 0
2023/03/14 06:38:18.684 1
2 127.0.0.0/8 0x78f2fd351508 0x0 0 0
2023/03/14 06:38:18.687 1
2 255.255.255.255/32 0x78f2fd34ebd8 0x0 0 0
2023/03/14 06:38:18.686 1
2 240.0.0.0/4 0x78f2fd350828 0x0 0 0
2023/03/14 06:38:18.686 1
2 0.0.0.0/32 0x78f2fd34cd88 0x0 0 0
2023/03/14 06:38:18.685 1
2 0.0.0.0/8 0x78f2fd350e98 0x0 0 0
2023/03/14 06:38:18.686 1
0 0.0.0.0/0 0x78f2fd345388 0x0 0 0
2023/03/14 06:39:09.383 352
0 9.24.0.0/32 0x78f2fd33e1c8 0x0 0 0
2023/03/14 06:38:38.930 1
0 9.24.0.1/32 0x78f2fd33a5e8 0x0 0 0
2023/03/14 06:39:09.390 5
0 127.0.0.0/8 0x78f2fd3501b8 0x0 0 0
2023/03/14 06:38:18.686 1
0 255.255.255.255/32 0x78f2fd34c478 0x0 0 0
2023/03/14 06:38:18.685 1
0 2.2.2.2/32 0x78f2fd3568e8 0x0 2 1
2023/03/14 06:39:09.383 1
0 9.24.255.255/32 0x78f2fd344838 0x0 0 0
2023/03/14 06:38:38.931 1
0 10.64.69.164/32 0x78f2fd33fac8 0x0 0 0
2023/03/14 06:39:09.383 1
0 10.77.128.69/32 0x78f2fd3420a8 0x0 0 0
2023/03/14 06:39:09.383 1
0 240.0.0.0/4 0x78f2fd34f4d8 0x0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
153
Cisco TrustSec
show platform software fed switch active ip route
2023/03/14 06:38:18.686 1
0 10.106.26.249/32 0x78f2fd3399a8 0x0 0 0
2023/03/14 06:39:09.383 1
0 0.0.0.0/32 0x78f2fd34a768 0x0 0 0
2023/03/14 06:38:18.685 1
0 9.24.23.30/32 0x78f2fd1f2078 0x0 0 0
2023/03/14 06:38:38.930 24
0 9.24.0.0/16 0x78f2fd33af48 0x0 0 0
2023/03/14 06:38:38.930 1
0 0.0.0.0/8 0x78f2fd34fb48 0x0 0 0
2023/03/14 06:38:18.686 1
The following table explains the significant fields shown in the output:
Table 11: show platform software fed switch active ip route Field Descriptions
Field Description
vrf The VRF ID.
dest The destination address.
htm The hash table manager object pointer for IP route.
SGT The security group tag.
DGID The destination tag ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
154
Cisco TrustSec
show platform software fed switch active sgacl detail
show platform software fed switch active sgacl detail
To display global enforcement status along with policy and count information, use the show platform software
fed switch active sgacl detail command in privileged EXEC mode.
show platform software fed switch active sgacl detail
Syntax Description sgacl Displays SGACL hardware information.
detail Displays detailed SGACL information.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software fed switch active sgacl detail command:
Device# show platform software fed switch active sgacl detail
Global Enforcement: Off
*Refcnt: for the non-SGACL feature
==================================== DGID Table ====================================
SGT/Refcnt DGT DGID test_cell monitor permitted denied
====================================================================================
*/3 2 1
The following table explains the significant fields shown in the output:
Table 12: show platform software fed switch active sgacl detail Field Descriptions
Field Description
SGT/Refcnt The security group tag/reinforcement.
DGT The destination tag.
DGID The destination tag ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
155
Cisco TrustSec
show platform software fed switch active sgacl port
show platform software fed switch active sgacl port
To display Layer 2 interface configuration settings for all interfaces, use the show platform software fed
switch active sgacl port command in privileged EXEC mode.
show platform software fed switch active sgacl port
Syntax Description sgacl Displays Security Group access control lists (SGACLs) hardware information.
port Specifies port configuration.
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software fed switch active sgacl port command:
Device# show platform software fed switch active sgacl port
Port Status Port-SGT Trust Propagate IngressCache EgressCache
-------------------------------------------------------------------------------
Gi3/0/1 Disabled 0 No No No No
Gi3/0/2 Disabled 0 No No No No
Gi3/0/3 Disabled 0 No No No No
Gi3/0/4 Disabled 0 No No No No
Gi3/0/5 Disabled 0 No No No No
Gi3/0/6 Disabled 0 No No No No
Gi3/0/7 Disabled 0 No No No No
Gi3/0/8 Disabled 0 No No No No
Gi3/0/9 Disabled 0 No No No No
Gi3/0/10 Disabled 0 No No No No
Gi3/0/11 Disabled 0 No No No No
Gi3/0/12 Disabled 0 No No No No
Gi3/0/13 Disabled 0 No No No No
Gi3/0/14 Disabled 0 No No No No
Gi3/0/15 Disabled 0 No No No No
Gi3/0/16 Disabled 0 No No No No
Gi3/0/17 Disabled 0 No No No No
Gi3/0/18 Disabled 0 No No No No
Gi3/0/19 Disabled 0 No No No No
Gi3/0/20 Disabled 0 No No No No
Gi3/0/21 Disabled 0 No No No No
Gi3/0/22 Disabled 0 No No No No
Gi3/0/23 Disabled 0 No No No No
Gi3/0/24 Disabled 0 No No No No
Gi3/0/25 Disabled 0 No No No No
Gi3/0/26 Disabled 0 No No No No
Gi3/0/27 Disabled 0 No No No No
Gi3/0/28 Disabled 0 No No No No
Gi3/0/29 Disabled 0 No No No No
Gi3/0/30 Disabled 0 No No No No
Gi3/0/31 Disabled 0 No No No No
Gi3/0/32 Disabled 0 No No No No
Gi3/0/33 Disabled 0 No No No No
Gi3/0/34 Disabled 0 No No No No
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
156
Cisco TrustSec
show platform software fed switch active sgacl port
Gi3/0/35 Disabled 0 No No No No
Gi3/0/36 Disabled 0 No No No No
Gi3/0/37 Disabled 0 No No No No
Gi3/0/38 Disabled 0 No No No No
Gi3/0/39 Disabled 0 No No No No
Gi3/0/40 Disabled 0 No No No No
Gi3/0/41 Disabled 0 No No No No
Gi3/0/42 Disabled 0 No No No No
Gi3/0/43 Disabled 0 No No No No
Gi3/0/44 Disabled 0 No No No No
Gi3/0/45 Disabled 0 No No No No
Gi3/0/46 Disabled 0 No No No No
Gi3/0/47 Disabled 0 No No No No
Gi3/0/48 Disabled 0 No No No No
Gi3/1/1 Disabled 0 No No No No
Gi3/1/2 Disabled 0 No No No No
Gi3/1/3 Disabled 0 No No No No
Gi3/1/4 Disabled 0 No No No No
Te3/1/1 Disabled 0 No No No No
Te3/1/2 Disabled 0 No No No No
Te3/1/3 Disabled 0 No No No No
Te3/1/4 Disabled 0 No No No No
Te3/1/5 Disabled 0 No No No No
Te3/1/6 Disabled 0 No No No No
Te3/1/7 Disabled 0 No No No No
Te3/1/8 Disabled 0 No No No No
Fo3/1/1 Disabled 0 No No No No
Fo3/1/2 Disabled 0 No No No No
Tw3/1/1 Disabled 0 No No No No
Tw3/1/2 Disabled 0 No No No No
Ap3/0/1 Disabled 0 No No No No
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
157
Cisco TrustSec
show platform software fed switch active sgacl vlan
show platform software fed switch active sgacl vlan
To display global enforcement status on VLANs, use the show platform software fed switch active sgacl
vlan command in privileged EXEC mode.
show platform software fed switch active sgacl vlan
Syntax Description sgacl Displays SGACL hardware information.
vlan Specifies VLAN configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software fed switch active sgacl vlan command:
Device# show platform software fed switch active sgacl vlan
Enforcement enabled:
vlan0
vlan1
vlan2
vlan10
vlan102
vlan192
vlan200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
158
Cisco TrustSec
show platform software status control-processor brief
show platform software status control-processor brief
To display brief information about CPU and memory, use the show platform software status
control-processor brief command in privileged EXEC mode.
show platform software status control-processor brief
Syntax Description status Displays system status.
control-processor Displays control processor status.
brief Displays brief status.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is a sample output from the show platform software status control-processor brief command:
Device# show platform software status control-processor brief
Load Average
Slot Status 1-Min 5-Min 15-Min
3-RP0 Healthy 0.03 0.07 0.04
Memory (kB)
Slot Status Total Used (Pct) Free (Pct) Committed (Pct)
3-RP0 Healthy 7745656 4178292 (54%) 3567364 (46%) 4755060 (61%)
CPU Utilization
Slot CPU User System Nice Idle IRQ SIRQ IOwait
3-RP0 0 0.50 0.40 0.00 99.10 0.00 0.00 0.00
1 0.90 0.50 0.00 98.59 0.00 0.00 0.00
2 0.40 0.40 0.00 99.20 0.00 0.00 0.00
3 0.80 0.30 0.00 98.90 0.00 0.00 0.00
4 0.60 0.30 0.00 99.09 0.00 0.00 0.00
5 0.70 0.30 0.00 99.00 0.00 0.00 0.00
6 1.20 0.30 0.00 98.50 0.00 0.00 0.00
7 0.59 0.39 0.00 99.00 0.00 0.00 0.00
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
159
Cisco TrustSec
show monitor capture <name> buffer
show monitor capture <name> buffer
To display the contents of a monitor capture buffer or a capture point, use the show monitor capture buffer
name buffer command in privileged EXEC mode.
show monitor capture name buffer
Syntax Description buffer Displays the contents of the specified capture
buffer.
name Represents the name of the capture buffer.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is sample output from the show monitor capturenamebuffer command:
Device# enable
Device# show monitor capture NewCapture buffer
Starting the packet display ........ Press Ctrl + Shift + 6 to exit
1 0.000000 10.4.1.117 -> 10.5.1.108 ICMP 124 Echo (ping) reply id=0x0008, seq=44279/63404,
ttl=127
2 0.108862 10.4.1.113 -> 10.5.1.109 ICMP 124 Echo (ping) reply id=0x0008, seq=26717/23912,
ttl=127
3 0.110106 10.4.1.119 -> 10.5.1.102 ICMP 124 Echo (ping) reply id=0x0008, seq=28341/46446,
ttl=127
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
160
Cisco TrustSec
timeout (CTS)
timeout (CTS)
To configure the response timeout in seconds, use the timeout command in policy-server configuration mode.
To go back to the default response timeout, use the no form of this command.
timeout seconds
no timeout
Syntax Description seconds Timeout in seconds. Valid values are
from 1 to 60.
Command Default The default is 5.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to change the policy-server timeout:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# timeout 8
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
161
Cisco TrustSec
tls server-trustpoint
tls server-trustpoint
Configures the Transport Layer Security (TLS) trustpoint, use the tls server-trustpoint command in
policy-server configuration mode. To remove the TLS trustpoint, use the no form of this command.
tls server-trustpoint name
no tls server-trustpoint
Syntax Description name Trustpoint name.
Command Default TLS is configured.
Command Modes Policy-server configuration (config-policy-server)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines TLS is used by a network device to connect to the Cisco Identity Services Engine (ISE). The device uses a
make or break approach to the TLS connection establishment, and there is no persistent TLS connection
between the device and Cisco ISE. After the TLS connection is established, the device can use this connection
to submit multiple REST API calls to specific uniform resource locators (URLs). After all the REST requests
are processed, the server terminates the connection through a TCP-FIN message. For new REST API calls,
a new connection must be established with the server.
If an invalid trustpoint is configured, the TLS handshake will fail and server is marked as dead.
Examples The following example shows how to configure a TLS trustpoint:
Device# enable
Device# configure terminal
Device(config)# policy-server name ise_server_2
Device(config-policy-server)# tls server-trustpoint ise_trust
Related Commands Command Description
cts policy-server name Configures the name of a policy server and
enters policy-server configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
162
PA R T III
Interface and Hardware Components
• Interface and Hardware Commands, on page 165
Interface and Hardware Commands
• bluetooth pin, on page 168
• clear macro auto configuration, on page 169
• device classifier, on page 170
• debug ilpower, on page 171
• debug interface, on page 172
• debug lldp packets, on page 173
• debug platform poe, on page 174
• debug platform software fed switch active punt packet-capture start, on page 175
• duplex, on page 176
• errdisable detect cause, on page 178
• errdisable recovery cause, on page 180
• errdisable recovery cause, on page 182
• hw-module beacon, on page 184
• hw-module switch upoe-plus, on page 185
• interface, on page 186
• interface range, on page 189
• ip mtu, on page 192
• ipv6 mtu, on page 193
• lldp (interface configuration), on page 194
• logging event power-inline-status, on page 196
• macro, on page 197
• macro auto, on page 200
• macro auto apply (Cisco IOS shell scripting capability), on page 203
• macro auto config (Cisco IOS shell scripting capability), on page 205
• macro auto control, on page 206
• macro auto execute, on page 208
• macro auto global control, on page 215
• macro auto global processing, on page 217
• macro auto mac-address-group, on page 218
• macro auto processing, on page 220
• macro auto sticky, on page 221
• macro auto trigger, on page 222
• macro description, on page 223
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
165
Interface and Hardware Components
• macro global, on page 224
• macro global description, on page 226
• mdix auto, on page 227
• mode (power-stack configuration), on page 228
• monitoring, on page 230
• network-policy, on page 231
• network-policy profile (global configuration), on page 232
• platform usb disable, on page 233
• power-priority , on page 234
• power inline, on page 236
• power inline police, on page 239
• power supply, on page 241
• power supply autoLC shutdown, on page 243
• shell trigger, on page 244
• show beacon all, on page 245
• show device classifier attached, on page 246
• show device classifier clients, on page 248
• show device classifier profile type, on page 249
• show environment, on page 252
• show errdisable detect, on page 254
• show errdisable recovery, on page 256
• show ip interface, on page 257
• show interfaces, on page 262
• show interfaces counters, on page 268
• show interfaces switchport, on page 270
• show interfaces transceiver, on page 272
• show inventory, on page 276
• show macro auto, on page 279
• show memory platform, on page 282
• show module, on page 285
• show mgmt-infra trace messages ilpower, on page 286
• show mgmt-infra trace messages ilpower-ha, on page 288
• show mgmt-infra trace messages platform-mgr-poe, on page 289
• show network-policy profile, on page 290
• show parser macro, on page 291
• show platform hardware bluetooth, on page 294
• show platform hardware fed switch forward, on page 295
• show platform hardware fed switch forward interface, on page 298
• show platform hardware fed switch forward last summary, on page 301
• show platform hardware fed switch fwd-asic counters tla, on page 304
• show platform hardware fed active fwd-asic resource tcam utilization, on page 308
• show platform resources, on page 310
• show platform software audit, on page 311
• show platform software fed switch punt cpuq rates, on page 315
• show platform software fed switch punt packet-capture display, on page 317
• show platform software fed switch punt packet-capture cpu-top-talker, on page 319
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
166
Interface and Hardware Components
• show platform software fed switch punt rates interfaces, on page 322
• show platform software ilpower, on page 325
• show platform software memory, on page 327
• show platform software process list, on page 332
• show platform software process memory, on page 336
• show platform software process slot switch, on page 339
• show platform software status control-processor, on page 341
• show platform software thread list, on page 344
• show platform usb status, on page 346
• show processes cpu platform, on page 347
• show processes cpu platform history, on page 350
• show processes cpu platform monitor, on page 353
• show processes memory, on page 355
• show processes memory platform, on page 358
• show processes platform, on page 362
• show power inline, on page 365
• show stack-power , on page 371
• show shell, on page 373
• show system mtu, on page 376
• show tech-support , on page 377
• show tech-support bgp, on page 379
• show tech-support diagnostic, on page 382
• show tech-support poe, on page 387
• speed, on page 417
• stack-power , on page 419
• switchport block, on page 421
• system mtu, on page 422
• tlv-type (device classifier condition), on page 423
• voice-signaling vlan (network-policy configuration), on page 425
• voice vlan (network-policy configuration), on page 427
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
167
Interface and Hardware Components
bluetooth pin
bluetooth pin
To configure a new Bluetooth pin, use the bluetooth pin command in interface configuration or global
configuration mode.
bluetooth pin pin
Syntax Description pin Pairing pin for the Bluetooth interface.
The pin is a 4-digit number.
Command Modes Interface configuration (config-if)
Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines The bluetooth pin command can be configured either in the interface configuration or global configuration
mode. Cisco recommends using the global configuration mode to configure the Bluetooth pin.
Examples This example shows how to configure a new Bluetooth pin using the bluetooth pin command.
Device> enable
Device# configure terminal
Device(config)# bluetooth pin 1111
Device(config)#
Related Commands Command Description
show platform hardware bluetooth Displays information about the Bluetooth interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
168
Interface and Hardware Components
clear macro auto configuration
clear macro auto configuration
To remove the macro applied configuration from the interfaces, use the clear macro auto configuration
command.
Note Before executing the clear macro auto configuration command, you must disable Auto SmartPorts on the
switch.
clear macro auto configuration{all | interface [interface-id]}
Syntax Description all Removes macro applied configuration from all the
interfaces.
interface [interface-id] Removes macro applied configuration from an
interface.
Command Default This command has no default setting.
Command Modes User EXEC (>)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the command to remove configuration applied by macros from all the interfaces or a particular interface
on the switch.
You can verify your settings by entering the show macro auto interface command in privileged EXEC mode.
Example
This example shows how to remove the configuration from all the switch interfaces:
Device(config)# clear macro auto configuration all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
169
Interface and Hardware Components
device classifier
device classifier
To enable the device classifier, use the device classifier command in global configuration mode. Use the no
form of this command to disable the device classifier.
device classifier
no device classifier
Command Default This command is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the no device classifier command, in global configuration mode, to disable the device classifier. You
cannot disable the device classifier while it is being used by features such as Auto SmartPorts (ASP).
Example
This example shows how to enable the ASP device classifier on a switch:
Device(config)# device classifier
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
170
Interface and Hardware Components
debug ilpower
debug ilpower
To enable debugging of the power controller and Power over Ethernet (PoE) system, use the debug ilpower
command in privileged EXEC mode. To disable debugging, use the no form of this command.
debug ilpower {cdp | event | ha | ipc | police | port | powerman | registries | scp | sense}
no debug ilpower {cdp | event | ha | ipc | police | port | powerman | registries | scp | sense}
Syntax Description cdp Displays PoE Cisco Discovery Protocol (CDP) debug messages.
event Displays PoE event debug messages.
ha Displays PoE high-availability messages.
ipc Displays PoE Inter-Process Communication (IPC) debug messages.
police Displays PoE police debug messages.
port Displays PoE port manager debug messages.
powerman Displays PoE power management debug messages.
registries Displays PoE registries debug messages.
scp Displays PoE SCP debug messages.
sense Displays PoE sense debug messages.
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is supported only on PoE-capable switches.
When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging
on a stack member, you can start a session from the active switch by using the session switch-number EXEC
command. Then enter the debug command at the command-line prompt of the stack member. You also can
use the remote command stack-member-number LINE EXEC command on the active switc to enable debugging
on a member switch without first starting a session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
171
Interface and Hardware Components
debug interface
debug interface
To enable debugging of interface-related activities, use the debug interface command in privileged EXEC
mode. To disable debugging, use the no form of this command.
debug interface {interface-id | counters {exceptions | protocol memory} | null interface-number |
port-channel port-channel-number | states|vlan vlan-id}
no debug interface {interface-id | counters {exceptions | protocol memory} | null interface-number
| port-channel port-channel-number | states|vlan vlan-id}
Syntax Description interface-id ID of the physical interface. Displays debug messages for the specified
physical port, identified by type switch number/module number/port, for
example, gigabitethernet 1/0/2.
null interface-number Displays debug messages for null interfaces. The interface number is always
0.
port-channel Displays debug messages for the specified EtherChannel port-channel
port-channel-number interface. The port-channel-number range is 1 to 48.
vlan vlan-id Displays debug messages for the specified VLAN. The vlan range is 1 to
4094.
counters Displays counters debugging information.
exceptions Displays debug messages when a recoverable exceptional condition occurs
during the computation of the interface packet and data rate statistics.
protocol memory Displays debug messages for memory operations of protocol counters.
states Displays intermediary debug messages when an interface's state transitions.
Command Default Debugging is disabled.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not specify a keyword, all debug messages appear.
The undebug interface command is the same as the no debug interface command.
When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging
on a stack member, you can start a session from the active switch by using the session switch-number EXEC
command. Then enter the debug command at the command-line prompt of the stack member. You also can
use the remote command stack-member-number LINE EXEC command on the active switch to enable
debugging on a member switch without first starting a session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
172
Interface and Hardware Components
debug lldp packets
debug lldp packets
To enable debugging of Link Layer Discovery Protocol (LLDP) packets, use the debug lldp packets command
in privileged EXEC mode. To disable debugging, use the no form of this command.
debug lldp packets
no debug lldp packets
Syntax Description This commnd has no arguments or keywords.
Command Default Debugging is disabled.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug lldp packets command is the same as the no debug lldp packets command.
When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging
on a stack member, you can start a session from the active switch by using the session switch-number EXEC
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
173
Interface and Hardware Components
debug platform poe
debug platform poe
To enable debugging of a Power over Ethernet (PoE) port, use the debug platform poe command in privileged
EXEC mode. To disable debugging, use the no form of this command.
debug platform poe [{error | info}] [switch switch-number]
no debug platform poe [{error | info}] [switch switch-number]
Syntax Description error (Optional) Displays PoE-related error debug messages.
info (Optional) Displays PoE-related information debug messages.
switch switch-number (Optional) Specifies the stack member. This keyword is supported only on
stacking-capable switches.
Command Default Debugging is disabled.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug platform poe command is the same as the no debug platform poe command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
174
Interface and Hardware Components
debug platform software fed switch active punt packet-capture start
debug platform software fed switch active punt packet-capture
start
To enable debugging of packets during high CPU utilization, for an active switch, use the debug platform
software fed switch active punt packet-capture start command in privileged EXEC mode. To disable
debugging of packets during high CPU utilization, for an active switch, use the debug platform software
fed switch active punt packet-capture stop command in privileged EXEC mode.
debug platform software fed switch active punt packet-capture start
debug platform software fed switch active punt packet-capture stop
Syntax Description switch active Displays information about the active switch.
punt Specifies the punt information.
packet-capture Specifies information about the captured packet.
start Enables debugging of the active switch.
stop Disables debugging of the active switch.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The debug platform software fed switch active punt packet-capture start command starts the debugging
of packets during high CPU utilization. The packet capture is stopped when the 4k buffer size is exceeded.
Examples The following is a sample output from the debug platform software fed switch active punt
packet-capture start command:
Device# debug platform software fed switch active packet-capture start
Punt packet capturing started.
The following is a sample output from the debug platform software fed switch active punt
packet-capture stop command:
Device# debug platform software fed switch active packet-capture stop
Punt packet capturing stopped. Captured 101 packet(s)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
175
Interface and Hardware Components
duplex
duplex
To specify the duplex mode of operation for a port, use the duplex command in interface configuration mode.
To return to the default value, use the no form of this command.
duplex {auto | full | half}
no duplex {auto | full | half}
Syntax Description auto Enables automatic duplex configuration. The port automatically detects whether it should run in full-
or half-duplex mode, depending on the attached device mode.
full Enables full-duplex mode.
half Enables half-duplex mode (only for interfaces operating at 10 or 100 Mb/s). You cannot configure
half-duplex mode for interfaces operating at 1000 Mb/s, 10,000 Mb/s, 2.5Gb/s, or 5Gb/s.
Command Default The default is auto for Gigabit Ethernet ports.
Duplex options are not supported on the 1000BASE-x or 10GBASE-x (where -x is -BX, -CWDM, -LX, -SX,
or -ZX) small form-factor pluggable (SFP) modules.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines For Gigabit Ethernet ports, setting the port to auto has the same effect as specifying full if the attached device
does not autonegotiate the duplex parameter.
Note Half-duplex mode is supported on Gigabit Ethernet interfaces if the duplex mode is auto and the connected
device is operating at half duplex. However, you cannot configure these interfaces to operate in half-duplex
mode.
Certain ports can be configured to be either full duplex or half duplex. How this command is applied depends
on the device to which the switch is attached.
If both ends of the line support autonegotiation, we highly recommend using the default autonegotiation
settings. If one interface supports autonegotiation and the other end does not, configure duplex and speed on
both interfaces, and use the auto setting on the supported side.
If the speed is set to auto, the switch negotiates with the device at the other end of the link for the speed setting
and then forces the speed setting to the negotiated value. The duplex setting remains as configured on each
end of the link, which could result in a duplex setting mismatch.
You can configure the duplex setting when the speed is set to auto.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
176
Interface and Hardware Components
duplex
Caution Changing the interface speed and duplex mode configuration might shut down and re-enable the interface
during the reconfiguration.
You can verify your setting by entering the show interfaces privileged EXEC command.
Examples This example shows how to configure an interface for full-duplex operation:
Device(config)# interface gigabitethernet1/0/1
Devic(config-if)# duplex full
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
177
Interface and Hardware Components
errdisable detect cause
errdisable detect cause
To enable error-disable detection for a specific cause or for all causes, use the errdisable detect cause
command in global configuration mode. To disable the error-disable detection feature, use the no form of this
command.
errdisable detect cause {all | arp-inspection | bpduguard shutdown vlan | dhcp-rate-limit | dtp-flap
| gbic-invalid | inline-power | link-flap | loopback | pagp-flap | pppoe-ia-rate-limit | psp shutdown
vlan | security-violation shutdown vlan | sfp-config-mismatch}
no errdisable detect cause {all | arp-inspection | bpduguard shutdown vlan | dhcp-rate-limit | dtp-flap
| gbic-invalid | inline-power | link-flap | loopback | pagp-flap | pppoe-ia-rate-limit | psp shutdown
vlan | security-violation shutdown vlan | sfp-config-mismatch}
Syntax Description all Enables error detection for all error-disabled causes.
arp-inspection Enables error detection for dynamic Address Resolution Protocol (ARP)
inspection.
bpduguard shutdown vlan Enables per-VLAN error-disable for BPDU guard.
dhcp-rate-limit Enables error detection for DHCP snooping.
dtp-flap Enables error detection for the Dynamic Trunking Protocol (DTP)
flapping.
gbic-invalid Enables error detection for an invalid Gigabit Interface Converter (GBIC)
module.
Note This error refers to an invalid small form-factor pluggable
(SFP) module.
inline-power Enables error detection for the Power over Ethernet (PoE) error-disabled
cause.
Note This keyword is supported only on switches with PoE ports.
link-flap Enables error detection for link-state flapping.
loopback Enables error detection for detected loopbacks.
pagp-flap Enables error detection for the Port Aggregation Protocol (PAgP) flap
error-disabled cause.
pppoe-ia-rate-limit Enables error detection for the PPPoE Intermediate Agent rate-limit
error-disabled cause.
psp shutdown vlan Enables error detection for protocol storm protection (PSP).
security-violation shutdown Enables voice aware 802.1x security.
vlan
sfp-config-mismatch Enables error detection on an SFP configuration mismatch.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
178
Interface and Hardware Components
errdisable detect cause
Command Default Detection is enabled for all causes. All causes, except per-VLAN error disabling, are configured to shut down
the entire port.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A cause (such as a link-flap or dhcp-rate-limit) is the reason for the error-disabled state. When a cause is
detected on an interface, the interface is placed in an error-disabled state, an operational state that is similar
to a link-down state.
When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For
the bridge protocol data unit (BPDU) guard, voice-aware 802.1x security, and port-security features, you can
configure the switch to shut down only the offending VLAN on the port when a violation occurs, instead of
shutting down the entire port.
If you set a recovery mechanism for the cause by entering the errdisable recovery global configuration
command, the interface is brought out of the error-disabled state and allowed to retry the operation when all
causes have timed out. If you do not set a recovery mechanism, you must enter the shutdown and then the
no shutdown commands to manually recover an interface from the error-disabled state.
For protocol storm protection, excess packets are dropped for a maximum of two virtual ports. Virtual port
error disabling using the psp keyword is not supported for EtherChannel and Flexlink interfaces.
To verify your settings, enter the show errdisable detect privileged EXEC command.
This example shows how to enable error-disabled detection for the link-flap error-disabled cause:
Device(config)# errdisable detect cause link-flap
This command shows how to globally configure BPDU guard for a per-VLAN error-disabled state:
Device(config)# errdisable detect cause bpduguard shutdown vlan
This command shows how to globally configure voice-aware 802.1x security for a per-VLAN
error-disabled state:
Device(config)# errdisable detect cause security-violation shutdown vlan
You can verify your setting by entering the show errdisable detect privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
179
Interface and Hardware Components
errdisable recovery cause
errdisable recovery cause
To enable the error-disabled mechanism to recover from a specific cause, use the errdisable recovery cause
command in global configuration mode. To return to the default setting, use the no form of this command.
errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit |
dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure |
pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control |
udld}
no errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit
| dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure |
pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control |
udld}
Syntax Description all Enables the timer to recover from all error-disabled causes.
arp-inspection Enables the timer to recover from the Address Resolution Protocol
(ARP) inspection error-disabled state.
bpduguard Enables the timer to recover from the bridge protocol data unit
(BPDU) guard error-disabled state.
channel-misconfig Enables the timer to recover from the EtherChannel misconfiguration
error-disabled state.
dhcp-rate-limit Enables the timer to recover from the DHCP snooping error-disabled
state.
dtp-flap Enables the timer to recover from the Dynamic Trunking Protocol
(DTP) flap error-disabled state.
gbic-invalid Enables the timer to recover from an invalid Gigabit Interface
Converter (GBIC) module error-disabled state.
Note This error refers to an invalid small form-factor
pluggable (SFP) error-disabled state.
inline-power Enables the timer to recover from the Power over Ethernet (PoE)
error-disabled state.
This keyword is supported only on switches with PoE ports.
link-flap Enables the timer to recover from the link-flap error-disabled state.
loopback Enables the timer to recover from a loopback error-disabled state.
mac-limit Enables the timer to recover from the mac limit error-disabled state.
pagp-flap Enables the timer to recover from the Port Aggregation Protocol
(PAgP)-flap error-disabled state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
180
Interface and Hardware Components
errdisable recovery cause
port-mode-failure Enables the timer to recover from the port mode change failure
error-disabled state.
pppoe-ia-rate-limit Enables the timer to recover from the PPPoE IA rate limit
error-disabled state.
psecure-violation Enables the timer to recover from a port security violation disable
state.
psp Enables the timer to recover from the protocol storm protection (PSP)
error-disabled state.
security-violation Enables the timer to recover from an IEEE 802.1x-violation disabled
state.
sfp-config-mismatch Enables error detection on an SFP configuration mismatch.
storm-control Enables the timer to recover from a storm control error.
udld Enables the timer to recover from the UniDirectional Link Detection
(UDLD) error-disabled state.
Command Default Recovery is disabled for all causes.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A cause (such as all or BDPU guard) is defined as the reason that the error-disabled state occurred. When a
cause is detected on an interface, the interface is placed in the error-disabled state, an operational state similar
to link-down state.
When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For
the BPDU guard and port-security features, you can configure the switch to shut down only the offending
VLAN on the port when a violation occurs, instead of shutting down the entire port.
If you do not enable the recovery for the cause, the interface stays in the error-disabled state until you enter
the shutdown and the no shutdown interface configuration commands. If you enable the recovery for a cause,
the interface is brought out of the error-disabled state and allowed to retry the operation again when all the
causes have timed out.
Otherwise, you must enter the shutdown and then the no shutdown commands to manually recover an
interface from the error-disabled state.
You can verify your settings by entering the show errdisable recovery privileged EXEC command.
Examples This example shows how to enable the recovery timer for the BPDU guard error-disabled cause:
Device# Device#configure terminal
Device(config)# errdisable recovery cause bpduguard
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
181
Interface and Hardware Components
errdisable recovery cause
errdisable recovery cause
To enable the error-disabled mechanism to recover from a specific cause, use the errdisable recovery cause
command in global configuration mode. To return to the default setting, use the no form of this command.
errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit |
dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure |
pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control |
udld}
no errdisable recovery cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit
| dtp-flap | gbic-invalid | inline-power | link-flap | loopback | mac-limit | pagp-flap | port-mode-failure |
pppoe-ia-rate-limit | psecure-violation | psp | security-violation | sfp-config-mismatch | storm-control |
udld}
Syntax Description all Enables the timer to recover from all error-disabled causes.
arp-inspection Enables the timer to recover from the Address Resolution Protocol
(ARP) inspection error-disabled state.
bpduguard Enables the timer to recover from the bridge protocol data unit
(BPDU) guard error-disabled state.
channel-misconfig Enables the timer to recover from the EtherChannel misconfiguration
error-disabled state.
dhcp-rate-limit Enables the timer to recover from the DHCP snooping error-disabled
state.
dtp-flap Enables the timer to recover from the Dynamic Trunking Protocol
(DTP) flap error-disabled state.
gbic-invalid Enables the timer to recover from an invalid Gigabit Interface
Converter (GBIC) module error-disabled state.
Note This error refers to an invalid small form-factor
pluggable (SFP) error-disabled state.
inline-power Enables the timer to recover from the Power over Ethernet (PoE)
error-disabled state.
This keyword is supported only on switches with PoE ports.
link-flap Enables the timer to recover from the link-flap error-disabled state.
loopback Enables the timer to recover from a loopback error-disabled state.
mac-limit Enables the timer to recover from the mac limit error-disabled state.
pagp-flap Enables the timer to recover from the Port Aggregation Protocol
(PAgP)-flap error-disabled state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
182
Interface and Hardware Components
errdisable recovery cause
port-mode-failure Enables the timer to recover from the port mode change failure
error-disabled state.
pppoe-ia-rate-limit Enables the timer to recover from the PPPoE IA rate limit
error-disabled state.
psecure-violation Enables the timer to recover from a port security violation disable
state.
psp Enables the timer to recover from the protocol storm protection (PSP)
error-disabled state.
security-violation Enables the timer to recover from an IEEE 802.1x-violation disabled
state.
sfp-config-mismatch Enables error detection on an SFP configuration mismatch.
storm-control Enables the timer to recover from a storm control error.
udld Enables the timer to recover from the UniDirectional Link Detection
(UDLD) error-disabled state.
Command Default Recovery is disabled for all causes.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A cause (such as all or BDPU guard) is defined as the reason that the error-disabled state occurred. When a
cause is detected on an interface, the interface is placed in the error-disabled state, an operational state similar
to link-down state.
When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For
the BPDU guard and port-security features, you can configure the switch to shut down only the offending
VLAN on the port when a violation occurs, instead of shutting down the entire port.
If you do not enable the recovery for the cause, the interface stays in the error-disabled state until you enter
the shutdown and the no shutdown interface configuration commands. If you enable the recovery for a cause,
the interface is brought out of the error-disabled state and allowed to retry the operation again when all the
causes have timed out.
Otherwise, you must enter the shutdown and then the no shutdown commands to manually recover an
interface from the error-disabled state.
You can verify your settings by entering the show errdisable recovery privileged EXEC command.
Examples This example shows how to enable the recovery timer for the BPDU guard error-disabled cause:
Device# Device#configure terminal
Device(config)# errdisable recovery cause bpduguard
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
183
Interface and Hardware Components
hw-module beacon
hw-module beacon
To control the beacon LED on a device, use the hw-module beacon command in the privileged EXEC mode
or global configuration mode.
Cisco IOS XE Fuji 16.8.x and Earlier Releases
hw-module beacon { off | on } switch switch-number
Cisco IOS XE Fuji 16.9.1 and Later Releases
hw-module beacon slot { switch-number | active | standby } { off | on }
Syntax Description off Turns the beacon off.
on Turns the beacon on.
switch switch-number Specifies the switch to be controlled.
• switch-number: Switch number. The range is
from 1 to 8.
slot {switch-number | active | standby} Specifies the switch to be controlled.
• switch-number: Switch number. The range is
from 1 to 8.
• active: Specifies the active switch.
• standby: Specifies the standby switch.
Command Default This command has no default settings.
Command Modes Global configuration (config) (Cisco IOS XE Fuji 16.8.x and Earlier Releases)
Privileged EXEC (#) (Cisco IOS XE Fuji 16.9.1 and Later Releases)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Fuji 16.9.1 This command was modified.
Usage Guidelines Use this command to enable or disable the switch LED. Blue indicates the switch LED is on and black indicates
that it is off.
The following example shows how to switch on the LED beacon of the active switch:
Device> enable
Device# hw-module beacon slot active on
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
184
Interface and Hardware Components
hw-module switch upoe-plus
hw-module switch upoe-plus
To enable the 802.3bt mode on the device, use the hw-module switch upoe-plus comamnd in the Global
Configuration mode. To unconfigure the 802.3bt mode, use the no form of the command.
hw-module switch switch-number upoe-plus
no hw-module switch switch-number upoe-plus
Command Default The device is in 802.3at mode.
Command Modes Global Configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines When the device boots up, it is in 802.3at-compliant mode by default. Use the hw-module switchswitch-number
upoe-plus command to enable 802.3bt Type 3 mode ton the device. This command causes the device to be
power-cycled to enable 802.3bt compliance.
The following command enables 802.3bt mode on the switch which is the second member of the
stack.
Device> enable
Device# configure terminal
Device(config)# hw-module switch 2 upoe-plus
!!!WARNING!!!This configuration will power cycle the switch to make it effective. Would you
like to continue y/n?
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
185
Interface and Hardware Components
interface
interface
To configure an interface, use the interface command.
interface {Auto-Template interface-number | FiveGigabitEthernet
switch-number/slot-number/port-number | GigabitEthernet switch-number/slot-number/port-number |
Loopback interface-number Null interface-number Port-channel interface-number TenGigabitEthernet
switch-number/slot-number/port-number TwentyFiveGigE switch-number/slot-number/port-number
TwoGigabitEthernet switch-number/slot-number/port-number Tunnel interface-number Vlan
interface-number }
Syntax Description Auto-Template interface-number Enables you to configure a auto-template interface.
The range is from 1 to 999.
FiveGigabitEthernet Enables you to configure a 5-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 0.
• port-number — Port number. The range is from
1 to 48.
FortyGigabitEthernet Enables you to configure a 40-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 1.
• port-number — Port number. The range is from
1 to 2.
GigabitEthernet Enables you to configure a Gigabit Ethernet IEEE
switch-number/slot-number/port-number 802.3z interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. The range is from
0 to 1.
• port-number — Port number. The range is from
1 to 48.
Loopback interface-number Enables you to configure a loopback interface. The
range is from 0 to 2147483647.
Null interface-number Enables you to configure a null interface. The default
value is 0.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
186
Interface and Hardware Components
interface
Port-channel interface-number Enables you to configure a port-channel interface.
The range is from 1 to 128.
TenGigabitEthernet Enables you to configure a 10-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number
— Slot number. The range is from 0 to 1.
• port-number — Port number. The range is from
1 to 24 and 37 to 48
.
TwentyFiveGigE Enables you to configure a 25-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 1.
• port-number — Port number. The range is from
1 to 2.
TwoGigabitEthernet Enables you to configure a 2.5-Gigabit Ethernet
switch-number/slot-number/port-number interface.
Note 2.5G ports are available only on
C9300-48UXM switch model.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 0.
• port-number — Port number. The range is from
1 to 36.
Tunnel interface-number Enables you to configure a tunnel interface. The range
is from 0 to 2147483647.
Vlan interface-number Enables you to configure a switch VLAN. The range
is from 1 to 4094.
Command Default None
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
187
Interface and Hardware Components
interface
Usage Guidelines You can not use the "no" form of this command.
Examples The following example shows how to configure a tunnel interface:
Device(config)# interface Tunnel 15
Device(config-if)#
The following example shows how to configure a 25-Gigabit Ethernet interface
Device(config)# interface TwentyFiveGigE 1/1/1
Device(config-if)#
The following example shows how to configure a 40-Gigabit Ethernet interface
Device(config)# interface FortyGigabitEthernet 1/1/2
Device(config-if)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
188
Interface and Hardware Components
interface range
interface range
To configure an interface range, use the interface range command.
interface range {Auto-Template interface-number | FiveGigabitEthernet
switch-number/slot-number/port-number | FortyGigabitEthernet switch-number/slot-number/port-number
| GigabitEthernet switch-number/slot-number/port-number | Loopback interface-number Null
interface-number Port-channel interface-number TenGigabitEthernet
switch-number/slot-number/port-number TwentyFiveGigE switch-number/slot-number/port-number
TwoGigabitEthernet switch-number/slot-number/port-number Tunnel interface-number Vlan
interface-number }
Syntax Description Auto-Template interface-number Enables you to configure a auto-template interface.
The range is from 1 to 999.
FiveGigabitEthernet Enables you to configure a 5-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 0.
• port-number — Port number. The range is from
1 to 48.
FortyGigabitEthernet Enables you to configure a 40-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 1.
• port-number — Port number. The range is from
1 to 2.
GigabitEthernet Enables you to configure a Gigabit Ethernet IEEE
switch-number/slot-number/port-number 802.3z interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. The range is from
0 to 1.
• port-number — Port number. The range is from
1 to 48.
Loopback interface-number Enables you to configure a loopback interface. The
range is from 0 to 2147483647.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
189
Interface and Hardware Components
interface range
Null interface-number Enables you to configure a null interface. The default
value is 0.
Port-channel interface-number Enables you to configure a port-channel interface.
The range is from 1 to 128.
TenGigabitEthernet Enables you to configure a 10-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number
— Slot number. The range is from 0 to 1.
• port-number — Port number. The range is from
1 to 24 and 37 to 48
.
TwentyFiveGigE Enables you to configure a 25-Gigabit Ethernet
switch-number/slot-number/port-number interface.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 1.
• port-number — Port number. The range is from
1 to 2.
TwoGigabitEthernet Enables you to configure a 2.5-Gigabit Ethernet
switch-number/slot-number/port-number interface.
Note 2.5G ports are available only on
C9300-48UXM switch model.
• switch-number — Switch ID. The range is from
1 to 8.
• slot-number — Slot number. Value is 0.
• port-number — Port number. The range is from
1 to 36.
Tunnel interface-number Enables you to configure a tunnel interface. The range
is from 0 to 2147483647.
Vlan interface-number Enables you to configure a switch VLAN. The range
is from 1 to 4094.
Command Default None
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
190
Interface and Hardware Components
interface range
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This example shows how you can configure interface range:
Device(config)# interface range vlan 1-100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
191
Interface and Hardware Components
ip mtu
ip mtu
To set the IP maximum transmission unit (MTU) size of routed packets on all routed ports of the switch or
switch stack, use the ip mtu command in interface configuration mode. To restore the default IP MTU size,
use the no form of this command.
ip mtu bytes
no ip mtu bytes
Syntax Description bytes MTU size, in bytes. The range is from 68 up to the system MTU value (in bytes).
Command Default The default IP MTU size for frames received and sent on all switch interfaces is 1500 bytes.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The upper limit of the IP value is based on the switch or switch stack configuration and refers to the currently
applied system MTU value. For more information about setting the MTU sizes, see the system mtu global
configuration command.
To return to the default IP MTU setting, you can apply the default ip mtu command or the no ip mtu command
on the interface.
You can verify your setting by entering the show ip interface interface-id or show interfaces interface-id
privileged EXEC command.
The following example sets the maximum IP packet size for VLAN 200 to 1000 bytes:
Device(config)# interface vlan 200
Device(config-if)# ip mtu 1000
The following example sets the maximum IP packet size for VLAN 200 to the default setting of 1500
bytes:
Device(config)# interface vlan 200
Device(config-if)# default ip mtu
This is an example of partial output from the show ip interface interface-id command. It displays
the current IP MTU setting for the interface.
Device# show ip interface gigabitethernet4/0/1
GigabitEthernet4/0/1 is up, line protocol is up
Internet address is 18.0.0.1/24
Broadcast address is 255.255.255.255
Address determined by setup command
MTU is 1500 bytes
Helper address is not set
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
192
Interface and Hardware Components
ipv6 mtu
ipv6 mtu
To set the IPv6 maximum transmission unit (MTU) size of routed packets on all routed ports of the switch or
switch stack, use the ipv6 mtu command in interface configuration mode. To restore the default IPv6 MTU
size, use the no form of this command.
ipv6 mtu bytes
no ipv6 mtu bytes
Syntax Description bytes MTU size, in bytes. The range is from 1280 up to the system MTU value (in bytes).
Command Default The default IPv6 MTU size for frames received and sent on all switch interfaces is 1500 bytes.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The upper limit of the IPv6 MTU value is based on the switch or switch stack configuration and refers to the
currently applied system MTU value. For more information about setting the MTU sizes, see the system mtu
global configuration command.
To return to the default IPv6 MTU setting, you can apply the default ipv6 mtu command or the no ipv6 mtu
command on the interface.
You can verify your setting by entering the show ipv6 interface interface-id or show interface interface-id
privileged EXEC command.
The following example sets the maximum IPv6 packet size for an interface to 2000 bytes:
Device(config)# interface gigabitethernet4/0/1
Device(config-if)# ipv6 mtu 2000
The following example sets the maximum IPv6 packet size for an interface to the default setting of
1500 bytes:
Device(config)# interface gigabitethernet4/0/1
Device(config-if)# default ipv6 mtu
This is an example of partial output from the show ipv6 interface interface-id command. It displays
the current IPv6 MTU setting for the interface.
Device# show ipv6 interface gigabitethernet4/0/1
GigabitEthernet4/0/1 is up, line protocol is up
Internet address is 18.0.0.1/24
Broadcast address is 255.255.255.255
Address determined by setup command
MTU is 1500 bytes
Helper address is not set
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
193
Interface and Hardware Components
lldp (interface configuration)
lldp (interface configuration)
To enable Link Layer Discovery Protocol (LLDP) on an interface, use the lldp command in interface
configuration mode. To disable LLDP on an interface, use the no form of this command.
lldp {med-tlv-select tlv | receive | tlv-select power-management | transmit}
no lldp {med-tlv-select tlv | receive | tlv-select power-management | transmit}
Syntax Description med-tlv-select Selects an LLDP Media Endpoint Discovery (MED) time-length-value
(TLV) element to send.
tlv String that identifies the TLV element. Valid values are the following:
• inventory-management— LLDP MED Inventory Management
TLV.
• location— LLDP MED Location TLV.
• network-policy— LLDP MED Network Policy TLV.
• power-management— LLDP MED Power Management TLV.
receive Enables the interface to receive LLDP transmissions.
tlv-select Selects the LLDP TLVs to send.
power-management Sends the LLDP Power Management TLV.
transmit Enables LLDP transmission on the interface.
Command Default LLDP is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is supported on 802.1 media types.
If the interface is configured as a tunnel port, LLDP is automatically disabled.
The following example shows how to disable LLDP transmission on an interface:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# no lldp transmit
The following example shows how to enable LLDP transmission on an interface:
Device(config)# interface gigabitethernet1/0/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
194
Interface and Hardware Components
lldp (interface configuration)
Device(config-if)# lldp transmit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
195
Interface and Hardware Components
logging event power-inline-status
logging event power-inline-status
To enable the logging of Power over Ethernet (PoE) events, use the logging event power-inline-status
command in interface configuration mode. To disable the logging of PoE status events, use the no form of
this command.
logging event power-inline-status
no logging event power-inline-status
Syntax Description This command has no arguments or keywords.
Command Default Logging of PoE events is enabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The no form of this command does not disable PoE error events.
Examples This example shows how to enable logging of PoE events on a port:
Device(config-if)# interface gigabitethernet1/0/1
Device(config-if)# logging event power-inline-status
Device(config-if)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
196
Interface and Hardware Components
macro
macro
To apply a macro to an interface or to apply and debug a macro on an interface, use the macro command in
interface configuration mode.
macro {apply | trace}macro-name [parameter {value}][parameter {value}][parameter {value}]
Syntax Description apply Applies a macro to an interface.
trace Applies a macro to an interface and then debugs it.
macro-name Specifies the name of the macro.
parameter value (Optional) Specifies unique parameter values that are specific to the
interface. You can enter up to three keyword-value pairs. Parameter
keyword matching is case sensitive.
All matching occurrences of the keyword are replaced with the
corresponding value.
Command Default This command has no default setting.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can use the macro apply macro-name command to apply and show the macros running on an interface.
You can use the macro trace macro-name command to apply and then debug the macro to find any syntax
or configuration errors.
If a command fails because of a syntax error or a configuration error when you apply a macro, the macro
continues to apply the remaining commands to the interface.
When creating a macro that requires the assignment of unique values, use the parameter value keywords to
designate values specific to the interface.
Keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the
corresponding value. Any full match of a keyword, even if it is part of a larger string, is considered a match
and is replaced by the corresponding value.
Some macros might contain keywords that require a parameter value. You can use the macro apply macro-name
? command to display a list of any required values in the macro. If you apply a macro without entering the
keyword values, the commands are invalid and are not applied.
There are Cisco-default SmartPorts macros embedded in the switch software. You can display these macros
and the commands that they contain by using the show parser macro command in user EXEC mode.
Follow these guidelines when you apply a Cisco-default SmartPorts macro on an interface:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
197
Interface and Hardware Components
macro
• Display all macros on the switch by using the show parser macro command in user EXEC mode. Display
the contents of a specific macro by using the show parser macro macro-name command in user EXEC
mode.
• Keywords that begin with $ mean that a unique parameter value is required. Append the Cisco-default
macro with the required values by using the parameter value keywords.
The Cisco-default macros use the $ character to identify required keywords. You can use the $ character to
define keywords when you create a macro.
When you apply a macro to an interface, the macro name is automatically added to the interface. You can
display the applied commands and macro names by using the show running-config interface interface-id
command in user EXEC mode.
A macro applied to an interface range behaves the same way as a macro applied to a single interface. When
you use an interface range, the macro is applied sequentially to each interface within the range. If a macro
command fails on one interface, it is still applied to the remaining interfaces.
You can delete a macro-applied configuration on an interface by entering the default interface interface-id
command in interface configuration mode.
Example
After you use the macro name command, in interface configuration mode, you can apply it to an
interface. This example shows how to apply a user-created macro called duplex to an interface:
Device(config-if)# macro apply duplex
To debug a macro, use the macro trace command, in interface configuration mode, to find any
syntax or configuration errors in the macro as it is applied to an interface.
Device(config-if)# macro trace duplex
Applying command...‘duplex auto’
%Error Unknown error.
Applying command...‘speed nonegotiate’
This example shows how to display the Cisco-default cisco-desktop macro and how to apply the
macro and set the access VLAN ID to 25 on an interface:
Device# show parser macro cisco-desktop
--------------------------------------------------------------
Macro name : cisco-desktop
Macro type : default
# Basic interface - Enable data VLAN only
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID
switchport mode access
# Enable port security limiting port to a single
# MAC address -- that of desktop
switchport port-security
switchport port-security maximum 1
# Ensure port-security age is greater than one minute
# and use inactivity timer
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity
# Configure port as an edge network port
spanning-tree portfast
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
198
Interface and Hardware Components
macro
spanning-tree bpduguard enable
--------------------------------------------------------------
Device#
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# interface gigabitethernet1/0/4
Device(config-if)# macro apply cisco-desktop $AVID 25
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
199
Interface and Hardware Components
macro auto
macro auto
To configure and apply a global macro using the CLI, use the macro auto command in privileged EXEC
mode.
Use the no form of this command to return to the default setting.
macro auto {apply | config} macro-name
Syntax Description apply Applies the macro.
config Enters the macro parameters.
macro-name Specifies the macro name.
Command Default No macros are applied to the switch.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To remove the macro from the switch, enter the no forms of the macro commands.
If you enter the macro auto config macro-name command, you are prompted to enter values for all the macro
parameters.
Use the exact text string when entering the macro-name. The entries are case sensitive.
The user-defined values appear only in the show macro auto or show running-config command output.
Example
This example shows how to display global macros:
Device# macro auto apply ?
CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parameters
CISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parameters
CISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parameters
CISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parameters
CISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parameters
CISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain name
CISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parameters
CISCO_SWITCH_HOSTNAME_CONFIG Configure hostname
CISCO_SWITCH_HTTP_SERVER_CONFIG Configure http server
CISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging server
CISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parameters
CISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parameters
CISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP server
CISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius server
CISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parameters
CISCO_SWITCH_SETUP_USR_CONFIG Configure the user parameters
CISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
200
Interface and Hardware Components
macro auto
CISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs server
CISCO_SWITCH_USER_PASS_CONFIG Configure username and password
Device# macro auto config ?
CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parameters
CISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parameters
CISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parameters
CISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parameters
CISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parameters
CISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain name
CISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parameters
CISCO_SWITCH_HOSTNAME_CONFIG Configure hostname
CISCO_SWITCH_HTTP_SERVER_CONFIG Configure http server
CISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging server
CISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parameters
CISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parameters
CISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP server
CISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius server
CISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parameters
CISCO_SWITCH_SETUP_USR_CONFIG Configure the user parameters
CISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interface
CISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs server
CISCO_SWITCH_USER_PASS_CONFIG Configure username and password
This example shows how to display the parameters for a specific macro:
Device# macro auto config CISCO_SWITCH_AUTO_IP_CONFIG ?
CISCO_SWITCH_DOMAIN_NAME_CONFIG domain name parameters
CISCO_SWITCH_LOGGING_SERVER_CONFIG logging host parameters
CISCO_SWITCH_NAME_SERVER_CONFIG name server parameters
CISCO_SWITCH_NTP_SERVER_CONFIG ntp server parameters
LINE Provide parameters of form [Parameters
name=value]
<cr>
Device# macro auto config CISCO_SWITCH_AUTO_PCI_CONFIG ?
CISCO_SWITCH_AAA_ACCOUNTING aaa accounting parameters
CISCO_SWITCH_AAA_AUTHENTICATION aaa authentication parameters
CISCO_SWITCH_AAA_AUTHORIZATION aaa authorization parameters
CISCO_SWITCH_HTTP_SERVER_CONFIG http server parameters
CISCO_SWITCH_RADIUS_SERVER_CONFIG radius server parameters
CISCO_SWITCH_TACACS_SERVER_CONFIG tacacs server parameters
LINE Provide parameters of form [Parameters
name=value]
<cr>
Device# macro auto config CISCO_SWITCH_SETUP_SNMP_TRAPS ?
CISCO_SWITCH_SNMP_SOURCE_CONFIG snmp source parameters
LINE Provide parameters of form [Parameters
name=value]
<cr>
Device# macro auto config CISCO_SWITCH_SETUP_USR_CONFIG ?CISCO_AUTO_TIMEZONE_CONFIG timezone
parameters
CISCO_SWITCH_HOSTNAME_CONFIG hostname parameter
LINE Provide parameters of form [Parameters
name=value]
<cr>
This example shows how to set macro parameters and apply the macro using the CLI:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
201
Interface and Hardware Components
macro auto
Device# macro auto config CISCO_SWITCH_ETHERCHANNEL_CONFIG
Enter the port channel id[1-48] for 3K & 2350,[1-6] for 2K: 2
Enter the port channel type, Layer:[2-3(L3 not supported on 2K)]: 2
Enter etherchannel mode for the interface[auto/desirable/on/active/passive]: active
Enter the channel protocol[lacp/none]: lacp
Enter the number of interfaces to join the etherchannel[8-PAGP/MODE:ON,16-LACP]: 7
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/1
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/2
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/3
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/4
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/5
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/6
Enter interface name[GigabitEthernet3/0/3]: gigabitethernet1/0/7
Do you want to apply the parameters? [yes/no]: yes
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Enter configuration commands, one per line. End with CNTL/Z.
Device# macro auto apply CISCO_SWITCH_ETHERCHANNEL_CONFIG
Enter configuration commands, one per line. End with CNTL/Z.
Device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
202
Interface and Hardware Components
macro auto apply (Cisco IOS shell scripting capability)
macro auto apply (Cisco IOS shell scripting capability)
To configure and apply a global macro using the Cisco IOS shell scripting capability, use the macro auto
apply command in privileged EXEC mode. Use the no form of this command to return to the default setting.
macro auto apply macro-name
Syntax Description apply Applies the macro.
macro-name Specifies the macro name.
Command Default No macros are applied to the switch.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To remove the macro from the switch, enter the no forms of the macro commands.
Use the exact text string when entering the macro-name. The entries are case sensitive.
The user-defined values appear only in the show macro auto or show running-config command output.
You can also use the Cisco IOS shell scripting capability to set the parameters. For examples, see the
“Configuring and Applying Global Macros” section in the “Configuring Auto Smartports and Static Smartports
Macros” chapter.
Example
This example shows how to display global macros:
Device# macro auto apply ?
CISCO_SWITCH_AAA_ACCOUNTING Configure aaa accounting parameters
CISCO_SWITCH_AAA_AUTHENTICATION Configure aaa authentication parameters
CISCO_SWITCH_AAA_AUTHORIZATION Configure aaa authorization parameters
CISCO_SWITCH_AUTO_IP_CONFIG Configure the ip parameters
CISCO_SWITCH_AUTO_PCI_CONFIG Configure PCI compliant parameters
CISCO_SWITCH_DOMAIN_NAME_CONFIG Configure domain name
CISCO_SWITCH_ETHERCHANNEL_CONFIG Configure the etherchannel parameters
CISCO_SWITCH_HOSTNAME_CONFIG Configure hostname
CISCO_SWITCH_HTTP_SERVER_CONFIG Configure http server
CISCO_SWITCH_LOGGING_SERVER_CONFIG Configure logging server
CISCO_SWITCH_MGMT_VLAN_CONFIG Configure management vlan parameters
CISCO_SWITCH_NAME_SERVER_CONFIG Configure name server parameters
CISCO_SWITCH_NTP_SERVER_CONFIG Configure NTP server
CISCO_SWITCH_RADIUS_SERVER_CONFIG Configure radius server
CISCO_SWITCH_SETUP_SNMP_TRAPS Configure SNMP trap parameters
CISCO_SWITCH_SETUP_USR_CONFIG Configure the user parameters
CISCO_SWITCH_SNMP_SOURCE_CONFIG Configure snmp source interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
203
Interface and Hardware Components
macro auto apply (Cisco IOS shell scripting capability)
CISCO_SWITCH_TACACS_SERVER_CONFIG Configure tacacs server
CISCO_SWITCH_USER_PASS_CONFIG Configure username and password
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
204
Interface and Hardware Components
macro auto config (Cisco IOS shell scripting capability)
macro auto config (Cisco IOS shell scripting capability)
To configure and apply a global macro, use the macro auto config command in privileged EXEC mode. Use
the no form of this command to return to the default setting.
macro auto config macro-name [parameter=value [parameter=value]...]
Syntax Description config Enters the macro parameters.
macro-name Specifies the macro name.
parameter=value [parameter=value] parameter=value—Replaces values for global macro parameter
... values. Enter values in the form of name value pair separated by a
space: <name1>=<value1> [<name2>=<value2>...]
Command Default No macros are applied to the switch.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To remove the macro from the switch, enter the no forms of the macro commands.
If you enter the macro auto config macro-name command, you are prompted to enter values for all the macro
parameters.
Use the exact text string when entering the macro-name and parameters. The entries are case sensitive.
The user-defined values appear only in the show macro auto or show running-config command output.
You can also use the Cisco IOS shell scripting capability to set the parameters. For examples, see the
“Configuring and Applying Global Macros” section in the “Configuring Auto Smartports and Static Smartports
Macros” chapter.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
205
Interface and Hardware Components
macro auto control
macro auto control
To specify when the switch applies an Auto Smartports macro based on the detection method, device type,
or trigger (referred to as event trigger control), use the macro auto control command in interface configuration
mode. Use the no form of this command to disable trigger-to-macro mapping. The switch then does not apply
macros based on event triggers.
macro auto control {detection [cdp] [lldp] [mac-address] | device [ip-camera] [media-player] [phone]
[lightweight-ap] [access-point] [router] [switch] | trigger [last-resort]}
no macro auto control {detection [cdp] [lldp] [mac-address] | device [ip-camera] [media-player]
[phone] [lightweight-ap] [access-point] [router] [switch] | trigger [last-resort]}
Syntax Description detection [cdp] [lldp] [mac-address] detection—Sets one or more of these as
an event trigger:
• (Optional) cdp—CDP messages
• (Optional) lldp—LLDP messages
• (Optional)
mac-address—User-defined MAC
address groups
device [access-point] [ip-camera] [lightweight-ap] device—Sets one or more of these
[media-player] [phone] [router] [switch] devices as an event trigger:
• (Optional)
access-point—Autonomous access
point
• (Optional) ip-camera—Cisco IP
video surveillance camera
• (Optional)
lightweight-ap—Lightweight
access point
• (Optional) media-player—Digital
media player
• (Optional) phone—Cisco IP phone
• (Optional) router—Cisco router
• (Optional) switch—Cisco switch
trigger [last-resort] trigger—Sets a specific event trigger.
• (Optional) last-resort—Last-resort
trigger.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
206
Interface and Hardware Components
macro auto control
Command Default The switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses
MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not set event triggers, the switch uses the device type as the event trigger. If the switch cannot
determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages,
and LLDP messages in random order.
To verify that a macro is applied to an interface, use the show macro auto interface command in user EXEC
mode.
Example
This example shows how to set LLDP messages and MAC address groups as event triggers:
Device(config)# interface gigabitethernet 5/0/2
Device(config-if)# macro auto control detection lldp mac-address
Device(config-if)# exit
Device(config)# end
This example shows how to set access points, video surveillance cameras, and digital media players
as event triggers:
Note The switch applies a built-in macro only when it detects an access point, video surveillance camera,
or digital media player.
Device(config)# interface gigabitethernet 5/0/1
Device(config-if)# macro auto control device access-point ip-camera media-player
Device(config-if)# exit
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
207
Interface and Hardware Components
macro auto execute
macro auto execute
To replace built-in macro default values and to configure mapping from an event trigger to a built-in or
user-defined macro, use the macro auto execute command in global configuration mode.
macro auto execute event trigger {builtin built-in macro | remote url}{parameter=value}{function contents}
no macro auto execute event trigger {builtin built-in macro | remote url}{parameter=value}{function
contents}
Syntax Description event trigger Defines mapping from an event trigger to a built-in macro.
Specifies an event trigger:
• CISCO_CUSTOM_EVENT
• CISCO_DMP_EVENT
• CISCO_IPVSC_EVENT
• CISCO_LAST_RESORT_EVENT
• CISCO_PHONE_EVENT
• CISCO_ROUTER_EVENT
• CISCO_SWITCH_EVENT
• CISCO_WIRELESS_AP_EVENT
• CISCO_WIRELESS_LIGHTWEIGHT_AP_EVENT
• WORD—Apply a user-defined event trigger such as a MAC address group
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
208
Interface and Hardware Components
macro auto execute
builtin built-in macro (Optional) Specifies a builtin built-in macro name:
name
• CISCO_AP_AUTO_SMARTPORT
Specify the parameter value: NATIVE_VLAN=1
• CISCO_DMP_AUTO_SMARTPORT
Specify the parameter value: ACCESS_VLAN=1.
• CISCO_IPVSC_AUTO_SMARTPORT
Specify the parameter value: ACCESS_VLAN=1.
• CISCO_LWAP_AUTO_SMARTPORT
Specify the parameter value: ACCESS_VLAN=1.
• CISCO_PHONE_AUTO_SMARTPORT
Specify the parameter values: ACCESS_VLAN=1 and VOICE_VLAN=2.
• CISCO_ROUTER_AUTO_SMARTPORT
Specify the parameter value: NATIVE_VLAN=1.
• CISCO_SWITCH_AUTO_SMARTPORT
Specify the parameter value: NATIVE_VLAN=1.
parameter=value (Optional) parameter=value—Replaces default values for parameter values shown
for the bultin-macro name, for example, ACCESS_VLAN=1. Enter new values
in the form of name value pair separated by a space: [<name1>=<value1>
<name2>=<value2>...].
{function contents} (Optional) {function contents}— Specifies a user-defined macro to associate with
the trigger. Enter the macro contents within braces. Begin the Cisco IOS shell
commands with the left brace and end the command grouping with the right brace.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
209
Interface and Hardware Components
macro auto execute
remote url (Optional) Specifies a remote server location:
• The syntax for the local flash file system on the standalone switch or the
stack's active switch: flash:
The syntax for the local flash file system on a stack member:
flash member number:
The syntax for the FTP:
ftp:[[//username[:password]@location]/directory]/filename
The syntax for an HTTP server:
http://[[username:password]@]{hostname | host-ip}[/directory]/filename
The syntax for a secure HTTP server:
https://[[username:password]@]{hostname | host-ip}[/directory]/filename
The syntax for the NVRAM:
nvram://[[username:password]@][/directory]/filename
The syntax for the Remote Copy Protocol (RCP):
rcp:[[//username@location]/directory]/filename
The syntax for the Secure Copy Protocol (SCP):
scp:[[//username@location]/directory]/filename
The syntax for the TFTP:
tftp:[[//location]/directory]/filename
Command Default None
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the macro auto execute command to replace the built-in macro default values with values that are specific
to your switch.
The switch automatically maps from event triggers to built-in macros. The built-in macros are system-defined
macros in the software image. You can also create user-defined macros by using the Cisco IOS shell scripting
capability.
You can create new event triggers by using the shell trigger commands in global configuration mode. Use
the show shell triggers command in privileged EXEC to display the contents of the user-defined triggers and
macros.
You can use the macro auto mac-address-group command in global configuration mode to create event
triggers for devices that do not support Cisco Discovery Protocol (CDP) or Link Layer Discovery Protocol
(LLDP).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
210
Interface and Hardware Components
macro auto execute
You can use the remote macro feature to store macros in a central location for designated network switches
to use. You can then maintain and update the macro files for use by multiple switches. Use remote url to
configure the remote server location and macro path information. There are no specific file extension
requirements for saved macro files.
Auto Smartports macros and antimacros (the antimacro is the portion of the applied macro that removes it at
link down) have these guidelines and limitations:
• You can delete or change the built-in macros. However, you can override a built-in macro by creating a
user-defined macro with the same name. To restore the original built-in macro, delete the user-defined
macro.
• If you enable both the macro auto device and the macro auto execute commands, the parameters
specified in the command last executed are applied to the switch. Only one command is active on the
switch.
• To avoid system conflicts when macros are applied, remove all port configurations except for 802.1x
authentication.
• Do not configure port security when enabling Auto SmartPorts on the switch.
• If the macro conflicts with the original configuration, either the macro does not apply some of the original
configuration commands, or the antimacro does not remove them. (The antimacro is the portion of the
applied macro that removes the macro at a link-down event.)
• For example, if 802.1x authentication is enabled, you cannot remove the switchport-mode access
configuration. Remove the 802.1x authentication before removing the switchport mode configuration.
• A port cannot be a member of an EtherChannel when you apply Auto SmartPorts macros.
• The built-in-macro default data VLAN is VLAN 1. The default voice VLAN is VLAN 2. If your switch
uses different access, native, or voice VLANs, use the macro auto device or the macro auto execute
commands to configure the values.
• For 802.1x authentication or MAC authentication bypass (MAB), to detect non-Cisco devices, configure
the RADIUS server to support the Cisco attribute-value pair auto-smart-port=event trigger
• The switch supports Auto SmartPort macros only on directly connected devices. Multiple device
connections, such as hubs, are not supported.
• If authentication is enabled on a port, the switch ignores a MAC address trigger if authentication fails.
• The order of CLI commands within the macro and the corresponding antimacro can be different.
Example
This example shows how to use two built-in macros for connecting Cisco switches and Cisco IP
phones to the switch. This example modifies the default voice VLAN, access VLAN, and native
VLAN for the trunk interface:
Device(config)# !!! the next command modifies the access and voice vlans
Device(config)# !!! for the built in Cisco IP phone auto smartport macro
Device(config)# macro auto execute CISCO_PHONE_EVENT builtin CISCO_PHONE_AUTO_SMARTPORT
ACCESS_VLAN=10 VOICE_VLAN=20
Device(config)# !!! the next command modifies the Native vlan used for inter switch trunks
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
211
Interface and Hardware Components
macro auto execute
Device(config)# macro auto execute CISCO_SWITCH_EVENT builtin CISCO_SWITCH_AUTO_SMARTPORT
NATIVE_VLAN=10
Device(config)# !!! the next command enables auto smart ports globally
Device(config)# macro auto global processing
Device(config)# exit
Device# !!! here is the running configuration of the interface connected
Device# !!! to another Cisco Switch after the Macro is applied
Device# show running-config interface gigabitethernet1/0/1
Building configuration...
Current configuration : 284 bytes
!
interface GigabitEthernet1/0/1
switchport trunk encapsulation dot1q
switchport trunk native vlan 10
switchport mode trunk
srr-queue bandwidth share 10 10 60 20
queue-set 2
priority-queue out
mls qos trust cos
auto qos voip trust
macro description CISCO_SWITCH_EVENT
end
This example shows how to map a user-defined event trigger called media player to a user-defined
macro
1. Connect the media player to an 802.1x- or MAB-enabled switch port.
2. On the RADIUS server, set the attribute-value pair to auto-smart-port=DMP_EVENT
3. On the switch, create the event trigger DMP_EVENT, and enter the user-defined macro commands.
4. The switch recognizes the attribute-value pair=DMP_EVENT response from the RADIUS server
and applies the macro associated with this event trigger.
Device(config)# shell trigger DMP_EVENT mediaplayer
Device(config)# macro auto execute DMP_EVENT {
if [[ $LINKUP == YES ]]; then
conf t
interface $INTERFACE
macro description $TRIGGER
switchport access vlan 1
switchport mode access
switchport port-security
switchport port-security maximum 1
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity
spanning-tree portfast
spanning-tree bpduguard enable
exit
fi
if [[ $LINKUP == NO ]]; then
conf t
interface $INTERFACE
no macro description $TRIGGER
no switchport access vlan 1
if [[ $AUTH_ENABLED == NO ]]; then
no switchport mode access
fi
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
212
Interface and Hardware Components
macro auto execute
no switchport port-security
no switchport port-security maximum 1
no switchport port-security violation restrict
no switchport port-security aging time 2
no switchport port-security aging type inactivity
no spanning-tree portfast
no spanning-tree bpduguard enable
exit
fi
Table 13: Supported Cisco IOS Shell Keywords
Command Description
{ Begin the command grouping.
} End the command grouping.
[[ Use as a conditional construct.
]] Use as a conditional construct.
else Use as a conditional construct.
== Use as a conditional construct.
fi Use as a conditional construct.
if Use as a conditional construct.
then Use as a conditional construct.
-z Use as a conditional construct.
$ Variables that begin with the $ character are replaced
with a parameter value.
# Use the # character to enter comment text.
Table 14: Unsupported Cisco IOS Shell Reserved Keywords
Command Description
| Pipeline.
case Conditional construct.
esac Conditional construct.
for Looping construct.
function Shell function.
in Conditional construct.
select Conditional construct.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
213
Interface and Hardware Components
macro auto execute
Command Description
time Pipeline.
until Looping construct.
while Looping construct.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
214
Interface and Hardware Components
macro auto global control
macro auto global control
To specify when the switch applies an Auto Smartports macro based on the device type or trigger (referred
to as event trigger control), use the macro auto global control command in global configuration mode. Use
the no form of this command to disable trigger-to-macro mapping.
macro auto global control {detection [cdp] [lldp][mac-address] | device [access-point] [ip-camera]
[lightweight-ap] [media-player] [phone] [router] [switch] | trigger [last-resort]}
no macro auto global control {detection [cdp] [lldp] [mac-address] | device [access-point] [ip-camera]
[lightweight-ap] [media-player] [phone] [router] [switch] | trigger [last-resort]}
Syntax Description detection [cdp] [lldp] [mac-address] detection—Sets one or more of these as
an event trigger:
• (Optional) cdp—CDP messages
• (Optional) lldp—LLDP messages
• (Optional)
mac-address—User-defined MAC
address groups
device [access-point] [ip-camera] [lightweight-ap] device—Sets one or more of these
[media-player] [phone] [router] [switch] devices as an event trigger:
• (Optional)
access-point—Autonomous access
point
• (Optional) ip-camera—Cisco IP
video surveillance camera
• (Optional)
lightweight-ap—Lightweight
access point
• (Optional) media-player—Digital
media player
• (Optional) phone—Cisco IP phone
• (Optional) router—Cisco router
• (Optional) switch—Cisco switch
trigger [last-resort] trigger—Sets a specific event trigger.
• (Optional) last-resort—Last-resort
trigger.
Command Default The switch uses the device type as the event trigger. If the switch cannot determine the device type, it uses
MAC address groups, MAB messages, 802.1x authentication messages, and LLDP messages in random order.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
215
Interface and Hardware Components
macro auto global control
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not set event triggers, the switch uses the device type as the event trigger. If the switch cannot
determine the device type, it uses MAC address groups, MAB messages, 802.1x authentication messages,
and LLDP messages in random order.
To verify that a macro is applied to a switch, use the show macro auto global command in user EXEC mode.
Example
This example shows how to set CDP messages, LLDP messages and MAC address groups as event
triggers:
Device(config)# macro auto global control detection cdp lldp mac-address
Device(config)# end
This example shows how to set autonomous access points, lightweight access points, and IP phones:
Device(config)# macro auto global control device access-point lightweight-ap phone
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
216
Interface and Hardware Components
macro auto global processing
macro auto global processing
To enable Auto SmartPorts macros on the switch, use the macro auto global processing command in global
configuration mode. Use the no form of this command to disable the macros.
macro auto global processing
no macro auto global processing
Command Default Auto Smartports is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the macro auto global processing command to globally enable macros on the switch. To disable macros
on a specific port, use the no macro auto processing command in interface mode.
When using 802.1x or MAB authentication, you need to configure the RADIUS server to support the Cisco
attribute-value pair auto-smart-port=event trigger. If authentication fails, the macro is not applied. If the
802.1x or MAB authentication fails on the interface, the switch does not use the fallback CDP event trigger.
When CDP-identified devices advertise multiple capabilities, the switch chooses a capability first by switch
and then by router.
To verify that a macro is applied to an interface, use the show macro auto interfacecommand in privileged
EXEC mode.
Example
This example shows how to enable Auto SmartPorts on the switch and to disable the feature on a
specific interface:
Device(config)# macro auto global processing
Device(config)# interface gigabitethernet 0/1
Device(config-if)# no macro auto processing
Device(config-if)# exit
Device(config)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
217
Interface and Hardware Components
macro auto mac-address-group
macro auto mac-address-group
To create an event trigger for devices that do not support Cisco Discovery Protocol (CDP) or Link Layer
Discover Protocol (LLDP), use the macro auto mac-address-group command in global configuration mode.
Use the no form of this command to delete the group.
macro auto mac-address-group name {mac-address list list | oui {list list | range start-value size
number}}
no macro auto mac-address-group name {mac-address list list | oui {list list | range start-value size
number}}
Syntax Description name Specifies the group name.
ui (Optional) Specifies an operationally unique identifier (OUI) list or
range.
• list—Enter an OUI list in hexadecimal format separated by
spaces.
• range—Enter the starting OUI hexadecimal value (start-value).
• size—Enter the length of the range (number) from 1 to 5 to
create a list of sequential addresses.
mac-address list list (Optional) Configures a list of MAC addresses separated by a space.
Command Default No groups are defined.
Command Modes Group configuration (config-addr-grp-mac)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the macro auto mac-address-group command to create an event trigger for devices that do not support
CDP or LLDP. Use the MAC address group as a trigger to map to a built-in or user-defined macro by using
the macro auto execute command. At link-up the switch detects the device type and applies the specified
macro.
The switch supports up to ten MAC address groups. Each group can have up to 32 OUI and 32 MAC configured
addresses.
Example
This example shows how to create a MAC-address-group event trigger called address_trigger and
how to verify your entries:
Device(config)# macro auto mac-address-group mac address_trigger
Device(config-addr-grp-mac)# mac-address list 2222.3333.3334 22.33.44 a.b.c
Device(config-addr-grp-mac)# oui list 455555 233244
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
218
Interface and Hardware Components
macro auto mac-address-group
Device(config-addr-grp-mac)# oui range 333333 size 2
Device(config-addr-grp-mac)# exit
Device(config)# end
Device# show running configuration
!
!macro auto mac-address-group address_trigger
oui list 333334
oui list 333333
oui list 233244
oui list 455555
mac-address list 000A.000B.000C
mac-address list 0022.0033.0044
mac-address list 2222.3333.3334
!
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
219
Interface and Hardware Components
macro auto processing
macro auto processing
To enable Auto SmartPorts macros on an interface, use the macro auto processing command in interface
configuration mode. Use the no form of this command to disable the macros.
macro auto processing
no macro auto processing
Command Default Auto SmartPorts is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the macro auto processing command, in interface configuration mode, to enable macros on a specific
interface. To disable macros on a specific interface, use the no macro auto processing command, in interface
configuration mode.
A port cannot be a member of an EtherChannel when you apply Auto SmartPorts macros. If you use
EtherChannels, disable Auto SmartPorts on the EtherChannel interface by using the no macro auto processing
command. The EtherChannel interface applies the configuration to the member interfaces.
To verify that a macro is applied to an interface, use the show macro auto interface command in privileged
EXEC mode.
Example
This example shows how to enable Auto SmartPorts on the switch and to disable the feature on a
specific interface:
Device(config)# interface gigabitethernet 0/1
Device(config-if)# no macro auto processing
Device(config-if)# exit
Device(config)# macro auto global processing
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
220
Interface and Hardware Components
macro auto sticky
macro auto sticky
To configure macros to remain active after a link-down event, referred to as macro persistence, use the macro
auto sticky command in global configuration mode. Use the no form of this command to disable the macro
persistence.
macro auto sticky
no macro auto sticky
Command Default Macro persistence is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the macro auto sticky command so that macros remain active after a link-down event.
Example
This example shows how to enable macro persistence on an interface:
Device(config)# interface gigabitethernet 5/0/2
Device(config-if)# macro auto port sticky
Device(config-if)# exit
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
221
Interface and Hardware Components
macro auto trigger
macro auto trigger
To enter the configure-macro-trigger mode and define a trigger for a device that has no built-in trigger and
associate the trigger with a device or profile, use the macro auto trigger command in global configuration
mode. To remove the user-defined trigger, use the no form of this command.
macro auto trigger trigger_name {device | exit | no | profile}
no macro auto trigger trigger_name {device | exit | no | profile}
Syntax Description trigger_name Specifies a trigger to be associated with the device type or
profile name.
device Specifies a device name to map to the named trigger.
exit Exits device group configuration mode.
no Removes any configured device.
profile Specifies a profile name to map to the named trigger.
Command Default No user-defined triggers are configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If a device is classified by the Device Classifier, but does not have a built-in trigger defined, use the macro
auto trigger command, in global configuration mode, to define a trigger based on a device name or a profile
name. After you enter the command, the switch is in the configure-macro-trigger mode and the device, exit,
no, and profile keywords are visible. In this mode, you can provide a device name or a profile name to map
to the trigger. It is not necessary to map the trigger to both a device name and a profile name. If you map the
trigger to both names, the trigger-to-profile name mapping has preference for macro application.
You must use this command to configure a trigger when you configure a user-defined macro. The trigger
name is required for the custom macro configuration.
After the device is profiled, you must add the complete string to the device-group database.
Example
This example shows how to configure a user-defined trigger for a profile called DMP_EVENT
mediaplayer for use with a media player that has no built-in trigger:
Device(config)# macro auto trigger DMP
Device(config-macro-trigger)# profile mediaplayer-DMP
Device(config-macro-trigger)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
222
Interface and Hardware Components
macro description
macro description
To enter a description about which macros are applied to an interface, use the macro description command
in interface configuration mode. Use the no form of this command to remove the description. This command
is mandatory for Auto SmartPorts to work.
macro description text
no macro description text
Syntax Description description text Enters a description about the macros that are
applied to the specified interface.
Command Default This command has no default setting.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the description keyword to associate comment text or the macro name with an interface. When multiple
macros are applied on a single interface, the description text is from the last applied macro.
You can verify your settings by entering the show parser macro description command in privileged EXEC
mode.
Example
This example shows how to add a description to an interface:
(config-if)# macro description duplex settings
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
223
Interface and Hardware Components
macro global
macro global
To apply a macro to a switch or to apply and debug a macro on a switch, use the macro global command in
global configuration mode.
macro global {apply | trace} macro-name [parameter {value}][parameter {value}][parameter {value}]
parameter
Syntax Description apply Applies a macro to the switch.
trace Applies a macro to a switch and debugs the macro.
macro-name Specifies the name of the macro.
parameter value (Optional) Specifies unique parameter values that are specific to the switch.
You can enter up to three keyword-value pairs. Parameter keyword matching
is case sensitive. All matching occurrences of the keyword are replaced
with the corresponding value.
Command Default This command has no default setting.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines
Note You can delete a global macro-applied configuration on a switch only by entering the no version of each
command in the macro.
Use the macro global apply macro-name command to apply the macro to an interface.
Use the macro global trace macro-name command to apply and then debug the macro to find any syntax or
configuration errors.
If a command fails when you apply a macro because of a syntax error or a configuration error, the macro
continues to apply the remaining commands to the switch.
When creating a macro that requires the assignment of unique values, use the parameter value keywords to
designate values specific to the switch.
Keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the
corresponding value. Any full match of a keyword, even if it is part of a larger string, is considered a match
and is replaced by the corresponding value.
Some macros might contain keywords that require a parameter value. You can use the macro global apply
macro-name ? command to display a list of any required values in the macro. If you apply a macro without
entering the keyword values, the commands are invalid and are not applied.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
224
Interface and Hardware Components
macro global
There are Cisco-default Smartports macros embedded in the switch software. You can display these macros
and the commands they contain by using the show parser macro command in user EXEC mode.
Follow these guidelines when you apply a Cisco-default Smartports macro on a switch:
• Display all macros on the switch by using the show parser macro command. Display the contents of a
specific macro by using the show parser macro name macro-name command.
• Keywords that begin with $ mean that a unique parameter value is required. Append the Cisco-default
macro with the required values by using the parameter value keywords.
The Cisco-default macros use the $ character to help identify required keywords. There is no restriction
on using the $ character to define keywords when you create a macro.
When you apply a macro to a switch, the macro name is automatically added to the switch. You can display
the applied commands and macro names by using the show running-config command.
Example
After you have created a new macro by using the macro auto execute command, you can apply it
to a switch. This example shows how to view the snmp macro, how to apply the macro, set the
hostname to test-server, and set the IP precedence value to 7:
Device# show parser macro name snmp
Macro name : snmp
Macro type : customizable
#enable port security, linkup, and linkdown traps
snmp-server enable traps port-security
snmp-server enable traps linkup
snmp-server enable traps linkdown
#set snmp-server host
snmp-server host ADDRESS
#set SNMP trap notifications precedence
snmp-server ip precedence VALUE
--------------------------------------------------
Device(config)# macro global apply snmp ADDRESS test-server VALUE 7
To debug a macro, use the macro global trace command to find any syntax or configuration errors
in the macro when you apply it to a switch. In this example, the ADDRESS parameter value was
not entered, the snmp-server host command failed, and the remainder of the macro is applied to the
switch:
Device(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’
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
225
Interface and Hardware Components
macro global description
macro global description
To enter a description about the macros that are applied to a switch, use the macro global description
command in global configuration mode. Use the no form of this command to remove the description.
macro global description text
no macro global description text
Syntax Description description text Enters a description about the macros that are
applied to the switch.
Command Default This command has no default setting.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the description keyword to associate comment text or the macro name with a switch. When multiple
macros are applied on a switch, the description text is from the last applied macro.
You can verify your settings by entering the show parser macro description command in privileged EXEC
mode.
Example
This example shows how to add a description to a switch:
Device(config)# macro global description udld aggressive mode enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
226
Interface and Hardware Components
mdix auto
mdix auto
To enable the automatic medium-dependent interface crossover (auto-MDIX) feature on the interface, use
the mdix auto command in interface configuration mode. To disable auto-MDIX, use the no form of this
command.
mdix auto
no mdix auto
Syntax Description This command has no arguments or keywords.
Command Default Auto-MDIX is enabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When auto-MDIX is enabled, the interface automatically detects the required cable connection type
(straight-through or crossover) and configures the connection appropriately.
When you enable auto-MDIX on an interface, you must also set the interface speed and duplex to auto so
that the feature operates correctly.
When auto-MDIX (and autonegotiation of speed and duplex) is enabled on one or both of the connected
interfaces, link up occurs, even if the cable type (straight-through or crossover) is incorrect.
Auto-MDIX is supported on all 10/100 and 10/100/1000 Mb/s interfaces and on 10/100/1000BASE-TX small
form-factor pluggable (SFP) module interfaces. It is not supported on 1000BASE-SX or -LX SFP module
interfaces.
You can verify the operational state of auto-MDIX on the interface by entering the show controllers
ethernet-controller interface-id phy privileged EXEC command.
This example shows how to enable auto-MDIX on a port:
Device# configure terminal
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# speed auto
Device(config-if)# duplex auto
Device(config-if)# mdix auto
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
227
Interface and Hardware Components
mode (power-stack configuration)
mode (power-stack configuration)
To configure power stack mode for the power stack, use the mode command in power-stack configuration
mode. To return to the default settings, use the no form of the command.
mode {power-shared | redundant} [strict]
no mode
Syntax Description power-shared Sets the power stack to operate in power-shared mode. This is the default.
redundant Sets the power stack to operate in redundant mode. The largest power supply
is removed from the power pool to be used as backup power in case one of
the other power supplies fails.
strict (Optional) Configures the power stack mode to run a strict power budget.
The stack power needs cannot exceed the available power.
Command Default The default modes are power-shared and nonstrict.
Command Modes Power-stack configuration (config-stackpower)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is available only on switch stacks running the IP Base or IP Services feature set.
To access power-stack configuration mode, enter the stack-power stack power stack name global configuration
command.
Entering the no mode command sets the switch to the defaults of power-shared and non-strict mode.
Note For stack power, available power is the total power available for PoE from all power supplies in the power
stack, available power is the power allocated to all powered devices connected to PoE ports in the stack, and
consumed power is the actual power consumed by the powered devices.
In power-shared mode, all of the input power can be used for loads, and the total available power appears
as one large power supply. The power budget includes all power from all supplies. No power is set aside for
power supply failures. If a power supply fails, load shedding (shutting down of powered devices or switches)
might occur.
In redundant mode, the largest power supply is removed from the power pool to use as backup power in case
one of the other power supplies fails. The available power budget is the total power minus the largest power
supply. This reduces the available power in the pool for switches and powered devices, but in case of a failure
or an extreme power load, there is less chance of having to shut down switches or powered devices.
In strict mode, when a power supply fails and the available power drops below the budgeted power, the system
balances the budget through load shedding of powered devices, even if the actual power is less than the
available power. In nonstrict mode, the power stack can run in an over-allocated state and is stable as long as
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
228
Interface and Hardware Components
mode (power-stack configuration)
the actual power does not exceed the available power. In this mode, a powered device drawing more than
normal power could cause the power stack to start shedding loads. This is normally not a problem because
most devices do not run at full power. The chances of multiple powered devices in the stack requiring maximum
power at the same time is small.
In both strict and nonstrict modes, power is denied when there is no power available in the power budget.
This is an example of setting the power stack mode for the stack named power1 to power-shared
with strict power budgeting. All power in the stack is shared, but when the total available power is
allotted, no more devices are allowed power.
Device(config)# stack-power stack power1
Device(config-stackpower)# mode power-shared strict
Device(config-stackpower)# exit
This is an example of setting the power stack mode for the stack named power2 to redundant. The
largest power supply in the stack is removed from the power pool to provide redundancy in case one
of the other supplies fails.
Device(config)# stack-power stack power2
Device(config-stackpower)# mode redundant
Device(config-stackpower)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
229
Interface and Hardware Components
monitoring
monitoring
To enable monitoring of all optical transceivers and to specify the time period for monitoring the transceivers,
use the monitoring command in transceiver type configuration mode. To disable the monitoring, use the no
form of this command.
monitoring [ interval seconds ]
no monitoring [interval]
Syntax Description interval (Optional) Specifies the time interval for monitoring optical transceivers.
seconds
The range is from 300 to 3600 seconds, and the default interval time is 600 seconds.
Command Default The interval time is 600 seconds.
Command Modes Transceiver type configuration (config-xcvr-type)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You need digital optical monitoring (DOM) feature and transceiver module compatibility information to
configure the monitoring command. Refer to the compatibility matrix to get the lists of Cisco platforms and
minimum required software versions to support Gigabit Ethernet transceiver modules.
Gigabit Ethernet Transceivers transmit and receive Ethernet frames at a rate of a gigabit per second, as defined
by the IEEE 802.3-2008 standard. Cisco's Gigabit Ethernet Transceiver modules support Ethernet applications
across all Cisco switching and routing platforms. These pluggable transceivers offer a convenient and cost
effective solution for the adoption in data center, campus, metropolitan area access and ring networks, and
storage area networks.
The interval keyword enables you to change the default polling interval. For example, if you set the interval
as 1500 seconds, polling happens at every 1500th second. During the polling period entSensorStatus of optical
transceivers is set to Unavailable, and once the polling finishes entSensorStatus shows the actual status.
Examples This example shows how to enable monitoring of optical transceivers and set the interval time for
monitoring to 1500 seconds:
Device# configure terminal
Device(config)# transceiver type all
Device(config-xcvr-type)# monitoring interval 1500
This example shows how to disable monitoring for all transceiver types:
Device(config-xcvr-type)# no monitoring
Related Commands Command Description
transceiver type Enables monitoring on all transceivers.
all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
230
Interface and Hardware Components
network-policy
network-policy
To apply a network-policy profile to an interface, use the network-policy command in interface configuration
mode. To remove the policy, use the no form of this command.
network-policy profile-number
no network-policy
Syntax Description profile-number The network-policy profile number to apply to the interface.
Command Default No network-policy profiles are applied.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the network-policy profile number interface configuration command to apply a profile to an interface.
You cannot apply the switchport voice vlan command on an interface if you first configure a network-policy
profile on it. However, if switchport voice vlan vlan-id is already configured on the interface, you can apply
a network-policy profile on the interface. The interface then has the voice or voice-signaling VLAN
network-policy profile applied.
This example shows how to apply network-policy profile 60 to an interface:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# network-policy 60
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
231
Interface and Hardware Components
network-policy profile (global configuration)
network-policy profile (global configuration)
To create a network-policy profile and to enter network-policy configuration mode, use the network-policy
profile command in global configuration mode. To delete the policy and to return to global configuration
mode, use the no form of this command.
network-policy profile profile-number
no network-policy profile profile-number
Syntax Description profile-number Network-policy profile number. The range is 1 to 4294967295.
Command Default No network-policy profiles are defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the network-policy profile global configuration command to create a profile and to enter network-policy
profile configuration mode.
To return to privileged EXEC mode from the network-policy profile configuration mode, enter the exit
command.
When you are in network-policy profile configuration mode, you can create the profile for voice and voice
signaling by specifying the values for VLAN, class of service (CoS), differentiated services code point (DSCP),
and tagging mode.
These profile attributes are contained in the Link Layer Discovery Protocol for Media Endpoint Devices
(LLDP-MED) network-policy time-length-value (TLV).
This example shows how to create network-policy profile 60:
Device(config)# network-policy profile 60
Device(config-network-policy)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
232
Interface and Hardware Components
platform usb disable
platform usb disable
To disable all the USB ports on a device, use the platform usb disable command in global configuration
mode. To reenable all the USB ports on the device, use the no platform usb disable command.
platform usb disable
no platform usb disable
Command Default All the USB ports are enabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines The platform usb disable command disables all the USB ports on both stacked and standalone devices, but
not Bluetooth dongles connected to USB ports.
Examples The following example shows how to disable USB ports on a device:
Device> enable
Device# configure terminal
Device(config)# platform usb disable
This config cli may cause data corruption if there is some ongoing operation on usb device.
Do you want to proceed [confirm]?
y
Device(config)# end
Related Commands Command Description
show platform usb status Displays the status of the USB ports on a device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
233
Interface and Hardware Components
power-priority
power-priority
To configure Cisco StackPower power-priority values for a switch in a power stack and for its high-priority
and low-priority PoE ports, use the power-priority command in switch stack-power configuration mode. To
return to the default setting, use the no form of the command.
power-priority {high value | low value | switch value}
no power-priority {high | low | switch}
Syntax Description high value Sets the power priority for the ports configured as high-priority ports. The range is 1 to 27,
with 1 as the highest priority. The high value must be lower than the value set for the
low-priority ports and higher than the value set for the switch.
low value Sets the power priority for the ports configured as low-priority ports. The range is 1 to 27.
The low value must be higher than the value set for the high-priority ports and the value set
for the switch.
switch Sets the power priority for the switch. The range is 1 to 27. The switch value must be lower
value than the values set for the low and high-priority ports.
Command Default If no values are configured, the power stack randomly determines a default priority.
The default ranges are 1 to 9 for switches, 10 to 18 for high-priority ports, 19 to 27 for low-priority ports.
On non-PoE switches, the high and low values (for port priority) have no effect.
Command Modes Switch stack-power configuration (config-stack)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To access switch stack-power configuration mode, enter the stack-power switch switch-number global
configuration command.
Cisco StackPower power-priority values determine the order for shutting down switches and ports when power
is lost and load shedding must occur. Priority values are from 1 to 27; the highest numbers are shut down first.
We recommend that you configure different priority values for each switch and for its high priority ports and
low priority ports to limit the number of devices shut down at one time during a loss of power. If you try to
configure the same priority value on different switches in a power stack, the configuration is allowed, but you
receive a warning message.
Note This command is available only on switch stacks running the IP Base or IP Services feature set.
Examples This is an example of setting the power priority for switch 1 in power stack a to 7, for the high-priority
ports to 11, and for the low-priority ports to 20.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
234
Interface and Hardware Components
power-priority
Device(config)# stack-power switch 1
Device(config-switch-stackpower)# stack-id power_stack_a
Device(config-switch-stackpower)# power-priority high 11
Device(config-switch-stackpower)# power-priority low 20
Device(config-switch-stackpower)# power-priority switch 7
Device(config-switch-stackpower)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
235
Interface and Hardware Components
power inline
power inline
To configure the power management mode on Power over Ethernet (PoE) ports, use the power inline command
in interface configuration mode. To return to the default settings, use the no form of this command.
power inline {auto [max max-wattage] | never | port priority {high | low} | static [max
max-wattage]}
no power inline {auto | never | port priority {high | low} | static [max max-wattage]}
Syntax Description auto Enables powered-device detection.
If enough power is available,
automatically allocates power to
the PoE port after device detection.
Allocation is first-come, first-serve.
max max-wattage (Optional) Limits the power
allowed on the port. The range is
4000 to 30000 mW. If no value is
specified, the maximum is allowed.
never Disables device detection, and
disables power to the port.
port Configures the power priority of
the port. The default priority is low.
priority {high|low} Sets the power priority of the port.
In case of a power supply failure,
ports configured as low priority are
turned off first and ports configured
as high priority are turned off last.
The default priority is low.
static Enables powered-device detection.
Pre-allocates (reserves) power for
a port before the switch discovers
the powered device. This action
guarantees that the device
connected to the interface receives
enough power.
Command Default The default is auto (enabled).
The maximum wattage is 30,000 mW.
The default port priority is low.
Command Default Interface configuration (config-if)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
236
Interface and Hardware Components
power inline
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is supported only on PoE-capable ports. If you enter this command on a port that does not
support PoE, this error message appears:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# power inline auto
^
% Invalid input detected at '^' marker.
In a switch stack, this command is supported on all ports in the stack that support PoE.
Use the max max-wattage option to disallow higher-power powered devices. With this configuration, when
the powered device sends Cisco Discovery Protocol (CDP) messages requesting more power than the maximum
wattage, the switch removes power from the port. If the powered-device IEEE class maximum is greater than
the maximum wattage, the switch does not power the device. The power is reclaimed into the global power
budget.
Note The switch never powers any class 0 or class 3 device if the power inline max max-wattage command is
configured for less than 30 W.
If the switch denies power to a powered device (the powered device requests more power through CDP
messages or if the IEEE class maximum is greater than the maximum wattage), the PoE port is in a power-deny
state. The switch generates a system message, and the Oper column in the show power inline privileged
EXEC command output shows power-deny.
Use the power inline static max max-wattage command to give a port high priority. The switch allocates
PoE to a port configured in static mode before allocating power to a port configured in auto mode. The switch
reserves power for the static port when it is configured rather than upon device discovery. The switch reserves
the power on a static port even when there is no connected device and whether or not the port is in a shutdown
or in a no shutdown state. The switch allocates the configured maximum wattage to the port, and the amount
is never adjusted through the IEEE class or by CDP messages from the powered device. Because power is
pre-allocated, any powered device that uses less than or equal to the maximum wattage is guaranteed power
when it is connected to a static port. However, if the powered device IEEE class is greater than the maximum
wattage, the switch does not supply power to it. If the switch learns through CDP messages that the powered
device needs more than the maximum wattage, the powered device is shut down.
If the switch cannot pre-allocate power when a port is in static mode (for example, because the entire power
budget is already allocated to other auto or static ports), this message appears: Command rejected: power
inline static: pwr not available. The port configuration remains unchanged.
When you configure a port by using the power inline auto or the power inline static interface configuration
command, the port autonegotiates by using the configured speed and duplex settings. This is necessary to
determine the power requirements of the connected device (whether or not it is a powered device). After the
power requirements have been determined, the switch hardcodes the interface by using the configured speed
and duplex settings without resetting the interface.
When you configure a port by using the power inline never command, the port reverts to the configured
speed and duplex settings.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
237
Interface and Hardware Components
power inline
If a port has a Cisco powered device connected to it, you should not use the power inline never command
to configure the port. A false link-up can occur, placing the port in an error-disabled state.
Use the power inline port priority {high | low} command to configure the power priority of a PoE port.
Powered devices connected to ports with low port priority are shut down first in case of a power shortage.
You can verify your settings by entering the show power inline EXEC command.
Examples This example shows how to enable detection of a powered device and to automatically power a PoE
port on a switch:
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# power inline auto
This example shows how to configure a PoE port on a switch to allow a class 1 or a class 2 powered
device:
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# power inline auto max 7000
This example shows how to disable powered-device detection and to not power a PoE port on a
switch:
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# power inline never
This example shows how to set the priority of a port to high, so that it would be one of the last ports
to be shut down in case of power supply failure:
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# power inline port priority high
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
238
Interface and Hardware Components
power inline police
power inline police
To enable policing of real-time power consumption on a powered device, use the power inline police command
in interface configuration mode. To disable this feature, use the no form of this command
power inline police [action {errdisable | log}]
no power inline police
Syntax Description action (Optional) Configures the device to turn off power to the port if the real-time power
errdisable consumption exceeds the maximum power allocation on the port. This is the default action.
action log (Optional) Configures the device to generate a syslog message while still providing power
to a connected device if the real-time power consumption exceeds the maximum power
allocation on the port.
Command Default Policing of the real-time power consumption of the powered device is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is supported only on Power over Ethernet (PoE)-capable ports. If you enter this command on
a device or port that does not support PoE, an error message appears.
In a switch stack, this command is supported on all switches or ports in the stack that support PoE and real-time
power-consumption monitoring.
When policing of the real-time power consumption is enabled, the device takes action when a powered device
consumes more power than the allocated maximum amount.
When PoE is enabled, the device senses the real-time power consumption of the powered device. This feature
is called power monitoring or power sensing. The device also polices the power usage with the power policing
feature.
When power policing is enabled, the device uses one of the these values as the cutoff power on the PoE port
in this order:
1. The user-defined power level that limits the power allowed on the port when you enter the power inline
auto max max-wattage or the power inline static max max-wattage interface configuration command
2. The device automatically sets the power usage of the device by using CDP power negotiation or by the
IEEE classification and LLPD power negotiation.
If you do not manually configure the cutoff-power value, the device automatically determines it by using CDP
power negotiation or the device IEEE classification and LLDP power negotiation. If CDP or LLDP are not
enabled, the default value of 30 W is applied. However without CDP or LLDP, the device does not allow
devices to consume more than 15.4 W of power because values from 15400 to 30000 mW are only allocated
based on CDP or LLDP requests. If a powered device consumes more than 15.4 W without CDP or LLDP
negotiation, the device might be in violation of the maximum current Imax limitation and might experience
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
239
Interface and Hardware Components
power inline police
an Icut fault for drawing more current than the maximum. The port remains in the fault state for a time before
attempting to power on again. If the port continuously draws more than 15.4 W, the cycle repeats.
When a powered device connected to a PoE+ port restarts and sends a CDP or LLDP packet with a power
TLV, the device locks to the power-negotiation protocol of that first packet and does not respond to power
requests from the other protocol. For example, if the device is locked to CDP, it does not provide power to
devices that send LLDP requests. If CDP is disabled after the device has locked on it, the device does not
respond to LLDP power requests and can no longer power on any accessories. In this case, you should restart
the powered device.
If power policing is enabled, the device polices power usage by comparing the real-time power consumption
to the maximum power allocated on the PoE port. If the device uses more than the maximum power allocation
(or cutoff power) on the port, the device either turns power off to the port, or the device generates a syslog
message and updates the LEDs (the port LEDs are blinking amber) while still providing power to the device.
• To configure the device to turn off power to the port and put the port in the error-disabled state, use the
power inline police interface configuration command.
• To configure the device to generate a syslog message while still providing power to the device, use the
power inline police action log command.
If you do not enter the action log keywords, the default action is to shut down the port, turn off power to it,
and put the port in the PoE error-disabled state. To configure the PoE port to automatically recover from the
error-disabled state, use the errdisable detect cause inline-power global configuration command to enable
error-disabled detection for the PoE cause and the errdisable recovery cause inline-power interval interval
global configuration command to enable the recovery timer for the PoE error-disabled cause.
Caution If policing is disabled, no action occurs when the powered device consumes more than the maximum power
allocation on the port, which could adversely affect the device.
You can verify your settings by entering the show power inline police privileged EXEC command.
Examples This example shows how to enable policing of the power consumption and configuring the device
to generate a syslog message on the PoE port on a device:
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# power inline police action log
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
240
Interface and Hardware Components
power supply
power supply
To configure and manage the internal power supplies on a switch, use the power supply command in privileged
EXEC mode.
power supply stack-member-number slot {A | B} {off | on}
Syntax Description stack-member-number Stack member number for which to configure the internal power
supplies. The range is 1 to 9, depending on the number of switches
in the stack.
This parameter is available only on stacking-capable switches.
slot Selects the switch power supply to set.
A Selects the power supply in slot A.
B Selects the power supply in slot B.
Note Power supply slot B is the closest slot to the outer
edge of the switch.
off Sets the switch power supply to off.
on Sets the switch power supply to on.
Command Default The switch power supply is on.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The power supply command applies to a switch or to a switch stack where all switches are the same platform.
In a switch stack with the same platform switches, you must specify the stack member before entering the
slot {A | B} off or on keywords.
To return to the default setting, use the power supply stack-member-number on command.
You can verify your settings by entering the show env power privileged EXEC command.
Examples This example shows how to set the power supply in slot A to off:
Device> power supply 2 slot A off
Disabling Power supply A may result in a power loss to PoE devices and/or switches ...
Continue? (yes/[no]): yes
Device
Jun 10 04:52:54.389: %PLATFORM_ENV-6-FRU_PS_OIR: FRU Power Supply 1 powered off
Jun 10 04:52:56.717: %PLATFORM_ENV-1-FAN_NOT_PRESENT: Fan is not present
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
241
Interface and Hardware Components
power supply
This example shows how to set the power supply in slot A to on:
Device> power supply 1 slot B on
Jun 10 04:54:39.600: %PLATFORM_ENV-6-FRU_PS_OIR: FRU Power Supply 1 powered on
This example shows the output of the show env power command:
Device> show env power
SW PID Serial# Status Sys Pwr PoE Pwr Watts
-- ------------------ ---------- --------------- ------- ------- -----
1A PWR-1RUC2-640WAC DCB1705B05B OK Good Good 250/390
1B Not Present
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
242
Interface and Hardware Components
power supply autoLC shutdown
power supply autoLC shutdown
To enable automatic shutdown control on linecards, use the power supply autoLC shutdown command in
global configuration mode. This command is enabled by default and cannot be disabled. The AutoLC
shutdown cannot be disabled message will be displayed if you try to disable it.
power supply autoLC shutdown
no power supply autoLC shutdown
Syntax Description This command has no arguments or keywords.
Command Default Automatic shutdown control on linecards is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This example shows how to enable automatic shutdown on linecards:
Device> enable
Device# configure terminal
Device(config)# power supply autoLC shutdown
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
243
Interface and Hardware Components
shell trigger
shell trigger
To create an event trigger, use the shell trigger command in global configuration mode. Use the no form of
this command to delete the trigger.
shell trigger identifier description
no shell trigger identifier description
Syntax Description identifier Specifies the event trigger identifier. The identifier should have no
spaces or hyphens between words.
description Specifies the event trigger description text.
Command Default System-defined event triggers:
• CISCO_DMP_EVENT
• CISCO_IPVSC_AUTO_EVENT
• CISCO_PHONE_EVENT
• CISCO_SWITCH_EVENT
• CISCO_ROUTER_EVENT
• CISCO_WIRELESS_AP_EVENT
• CISCO_WIRELESS_LIGHTWEIGHT_AP_EVENT
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to create user-defined event triggers for use with the macro auto device and the macro
auto execute commands.
To support dynamic device discovery when using IEEE 802.1x authentication, you need to configure the
RADIUS authentication server to support the Cisco attribute-value pair: auto-smart-port=event trigger.
Example
This example shows how to create a user-defined event trigger called RADIUS_MAB_EVENT:
Device(config)# shell trigger RADIUS_MAB_EVENT MAC_AuthBypass Event
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
244
Interface and Hardware Components
show beacon all
show beacon all
To display the status of beacon LED on the device, use the show beacon all command in privileged EXEC
mode.
show beacon {rp {active |standby}|slot slot-number } |all}
Syntax Description rp {active | standby} Specifies the active or the standby Switch whose
beacon LED status is to be displayed.
slot slot-num Specifies the slot whose beacon LED status is to be
displayed.
all Displays the status of all beacon LEDs.
Command History Release Modification
Cisco IOS XE Fuji 16.9.1 This command was introduced.
Command Default This command has no default settings.
Command Modes Privileged EXEC (#)
Usage Guidelines Use the command show beacon all to know the status of all beacon LEDs.
Sample output of show beacon all command.
Device#show beacon all
Switch# Beacon Status
-----------------------
*1 OFF
Sample output of show beacon rp command.
Device#show beacon rp active
Switch# Beacon Status
-----------------------
*1 OFF
Device#show beacon slot 1
Switch# Beacon Status
-----------------------
*1 OFF
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
245
Interface and Hardware Components
show device classifier attached
show device classifier attached
To display the devices connected to a switch and their associated properties, use the show device classifier
attached command in user EXEC mode.
show device classifier attached [{detail | interface interface_id | mac-address mac_address}]
Syntax Description detail Displays detailed device classifier information.
interface interface_id Displays information about devices attached to the
specified interface.
mac mac_address Displays device information for the specified
endpoint.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to display the devices connected to a switch. Use the show device classifier attached
command in privileged EXEC mode to display the configurable parameters for a device.
Example
This example shows how to use the show device classifier attached command with no optional
keywords to view the devices connected to the switch:
Device# show device classifier attached
MAC_Address Port_Id Profile Name
============== ======= ============================
000a.b8c6.1e07 Gi1/0/2 Cisco-Device
001f.9e90.1250 Gi1/0/4 Cisco-AP-Aironet-1130
======================================================
This example shows how to use the show device classifier attached command in privileged EXEC
mode with the optional mac-address keyword to view summary information about the connected
device with the specified MAC address:
Device# show device classifier attached mac-address 001f.9e90.1250
MAC_Address Port_Id Profile Name
============== ======= ============================
001f.9e90.1250 Gi1/0/4 Cisco-AP-Aironet-1130
==========================================================
This example shows how to use the show device classifier attached command in privileged EXEC
mode with the optional mac-address and detail keywords to view detailed information about the
connected device with the specified MAC address:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
246
Interface and Hardware Components
show device classifier attached
Device# show device classifier attached mac-address 001f.9e90.1250 detail
MAC_Address Port_Id Certainty Parent ProfileType Profile Name
Device_Name
============== ======= ========= ====== =========== ============================
===========
001f.9e90.1250 Gi1/0/4 40 2 Built-in Cisco-AP-Aironet-1130
cisco AIR-LAP1131AG-E-K9
=================================================================================================
This example shows how to use the show device classifier attached command in privileged EXEC
mode with the optional interface keyword to view summary information about the device connected
to the specified interface:
Device# show device classifier attached interface gi 1/0/2
MAC_Address Port_Id Profile Name
============== ======= ============================
000a.b8c6.1e07 Gi1/0/2 Cisco-Device
=====================================================
This example shows how to use the show device classifier attached command in privileged EXEC
mode with the optional interface and detail keywords to view detailed information about the device
connected to the specified interface:
Device# show device classifier attached interface gi 1/0/2 detail
MAC_Address Port_Id Certainty Parent ProfileType Profile Name
Device_Name
============== ======= ========= ====== =========== ============================
===========
000a.b8c6.1e07 Gi1/0/2 10 0 Default Cisco-Device cisco
WS-C2960-48TT-L
=================================================================================================
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
247
Interface and Hardware Components
show device classifier clients
show device classifier clients
To display the clients using the device classifier facility on the switch, use the show device classifier clients
command in user EXEC mode.
show device classifier clients
Command Default This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Device classifier (DC) is enabled by default when you enable a client application (for example, Auto SmartPorts)
that uses its functionality. Use the show device classifier clients command to display the clients that are using
the DC feature on the switch.
As long as any clients are using the DC, you cannot disable it by using the no device classifier command. If
you attempt to disable the DC while a client is using it, an error message appears.
Example
This example shows how to use the show device classifier clients command to view the clients
using the DC on the switch:
Device# show device classifier clients
Client Name
====================
Auto Smart Ports
This example shows the error message that appears when you attempt to disable DC while a
client is using it:
Switch(config)# no device classifier
These subsystems should be disabled before disabling Device classifier
Auto Smart Ports
% Error - device classifier is not disabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
248
Interface and Hardware Components
show device classifier profile type
show device classifier profile type
To display all the device types recognized by the device classifier, use the show device classifier profile type
command in user EXEC mode.
show device classifier profile type [{table [{built-in default}] | string filter_string}]
Syntax Description table Displays device classification in a table.
built-in Displays device classification information from the built-in
device table.
default Displays device classification information from the default
device table.
filter string Displays information for devices that match the filter.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command displays all the device types recognized by the device classification engine. The number of
available device types is the number of profiles stored on the switch. Because the number of profiles can be
very large, you can use the filter keyword to limit the command output.
Example
This example shows how to use the show device classifier profile type command in privileged
EXEC mode with no optional keywords to view the devices recognized by the device classifier:
Device# show device classifier profile type table
Valid Type Profile Name min Conf ID
=========== ========= ================== ======== ====
Valid Default Apple-Device 10 0
Valid Default Aruba-Device 10 1
Valid Default Avaya-Device 10 2
Valid Default Avaya-IP-Phone 20 3
Valid Default BlackBerry 20 4
Valid Default Cisco-Device 10 5
Valid Default Cisco-IP-Phone 20 6
Valid Default Cisco-IP-Phone-7902 70 7
Valid Default Cisco-IP-Phone-7905 70 8
Valid Default Cisco-IP-Phone-7906 70 9
Valid Default Cisco-IP-Phone-7910 70 10
Valid Default Cisco-IP-Phone-7911 70 11
Valid Default Cisco-IP-Phone-7912 70 12
Valid Default Cisco-IP-Phone-7940 70 13
Valid Default Cisco-IP-Phone-7941 70 14
Valid Default Cisco-IP-Phone-7942 70 15
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
249
Interface and Hardware Components
show device classifier profile type
Valid Default Cisco-IP-Phone-7945 70 16
Valid Default Cisco-IP-Phone-7945G 70 17
Valid Default Cisco-IP-Phone-7960 70 18
Valid Default Cisco-IP-Phone-7961 70 19
Valid Default Cisco-IP-Phone-7962 70 20
Valid Default Cisco-IP-Phone-7965 70 21
Valid Default Cisco-IP-Phone-7970 70 22
Valid Default Cisco-IP-Phone-7971 70 23
Valid Default Cisco-IP-Phone-7975 70 24
Valid Default Cisco-IP-Phone-7985 70 25
Valid Default Cisco-IP-Phone-9971 70 26
Valid Default Cisco-WLC-2100-Series 40 27
Valid Default DLink-Device 10 28
Valid Default Enterasys-Device 10 29
Valid Default HP-Device 10 30
Valid Default HP-JetDirect-Printer 30 31
Valid Default Lexmark-Device 10 32
Valid Default Lexmark-Printer-E260dn 30 33
Valid Default Microsoft-Device 10 34
Valid Default Netgear-Device 10 35
Valid Default NintendoWII 10 36
Valid Default Nortel-Device 10 37
Valid Default Nortel-IP-Phone-2000-Series 20 38
Valid Default SonyPS3 10 39
Valid Default XBOX360 20 40
Valid Default Xerox-Device 10 41
Valid Default Xerox-Printer-Phaser3250 30 42
Valid Default Aruba-AP 20 43
Valid Default Cisco-Access-Point 10 44
Valid Default Cisco-IP-Conference-Station-7935 70 45
Valid Default Cisco-IP-Conference-Station-7936 70 46
Valid Default Cisco-IP-Conference-Station-7937 70 47
Valid Default DLink-DAP-1522 20 48
Valid Default Cisco-AP-Aironet-1130 30 49
Valid Default Cisco-AP-Aironet-1240 30 50
Valid Default Cisco-AP-Aironet-1250 30 51
Valid Default Cisco-AIR-LAP 25 52
Valid Default Cisco-AIR-LAP-1130 30 53
Valid Default Cisco-AIR-LAP-1240 50 54
Valid Default Cisco-AIR-LAP-1250 50 55
Valid Default Cisco-AIR-AP 25 56
Valid Default Cisco-AIR-AP-1130 30 57
Valid Default Cisco-AIR-AP-1240 50 58
Valid Default Cisco-AIR-AP-1250 50 59
Invalid Default Sun-Workstation 10 60
Valid Default Linksys-Device 20 61
Valid Default LinksysWAP54G-Device 30 62
Valid Default HTC-Device 10 63
Valid Default MotorolaMobile-Device 10 64
Valid Default VMWare-Device 10 65
Valid Default ISE-Appliance 10 66
Valid Built-in Cisco-Device 10 0
Valid Built-in Cisco-Router 10 1
Valid Built-in Router 10 2
Valid Built-in Cisco-IP-Camera 10 3
Valid Built-in Cisco-IP-Camera-2xxx 30 4
Valid Built-in Cisco-IP-Camera-2421 50 5
Valid Built-in Cisco-IP-Camera-2500 50 6
Valid Built-in Cisco-IP-Camera-2520 50 7
Valid Built-in Cisco-IP-Camera-2530 50 8
Valid Built-in Cisco-IP-Camera-4xxx 50 9
Valid Built-in Cisco-Transparent-Bridge 8 10
Valid Built-in Transparent-Bridge 8 11
Valid Built-in Cisco-Source-Bridge 10 12
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
250
Interface and Hardware Components
show device classifier profile type
Valid Built-in Cisco-Switch 10 13
Valid Built-in Cisco-IP-Phone 20 14
Valid Built-in IP-Phone 20 15
Valid Built-in Cisco-DMP 10 16
Valid Built-in Cisco-DMP-4305G 70 17
Valid Built-in Cisco-DMP-4310G 70 18
Valid Built-in Cisco-DMP-4400G 70 19
Valid Built-in Cisco-WLC-2100-Series 40 20
Valid Built-in Cisco-Access-Point 10 21
Valid Built-in Cisco-AIR-LAP 30 22
Valid Built-in Cisco-AIR-AP 30 23
Valid Built-in Linksys-Device 20 24
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
251
Interface and Hardware Components
show environment
show environment
To display fan, temperature, and power information, use the show environment command in EXEC mode.
show environment { all | fan | power | stack | temperature | xps }
Syntax Description all Displays the fan and temperature environmental status and the status of
the internal power supplies.
fan Displays the switch fan status.
power Displays the internal power status of the active switch.
stack Displays all environmental status for each switch in the stack or for the
specified switch.
This keyword is available only on stacking-capable switches.
temperature Displays the switch temperature status.
xps Displays the status of the Cisco eXpandable Power System (XPS) 2200.
Command Default None
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show environment EXEC command to display the information for the switch being accessed—a
standalone switch or the active switch. Use this command with the stack keyword to display all information
for the stack or for the specified stack member.
If you enter the show environment temperature status command, the command output shows the switch
temperature state and the threshold level.
You can also use the show environment temperature command to display the switch temperature status.
The command output shows the green and yellow states as OK and the red state as FAULTY.
Examples This example shows a sample output of the show environment all command:
Device> show environment all
Switch 1 FAN 1 is OK
Switch 1 FAN 2 is OK
Switch 1 FAN 3 is OK
FAN PS-1 is NOT PRESENT
FAN PS-2 is OK
Switch 1: SYSTEM TEMPERATURE is OK
Inlet Temperature Value: 25 Degree Celsius
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
252
Interface and Hardware Components
show environment
Temperature State: GREEN
Yellow Threshold : 46 Degree Celsius
Red Threshold : 56 Degree Celsius
Hotspot Temperature Value: 35 Degree Celsius
Temperature State: GREEN
Yellow Threshold : 105 Degree Celsius
Red Threshold : 125 Degree Celsius
SW PID Serial# Status Sys Pwr PoE Pwr Watts
-- ------------------ ---------- --------------- ------- ------- -----
1A Unknown Unknown No Input Power Bad Bad 235
1B PWR-C1-350WAC DCB2137H04P OK Good Good 350
This example shows a sample output of the show environment power command:
Device> show environment power
SW PID Serial# Status Sys Pwr PoE Pwr Watts
-- ------------------ ---------- --------------- ------- ------- -----
1A Unknown Unknown No Input Power Bad Bad 235
1B PWR-C1-350WAC DCB2137H04P OK Good Good 350
This example shows a sample output of the show environment stack command:
Device# show environment stack
System Temperature Value: 41 Degree Celsius
System Temperature State: GREEN
Yellow Threshold : 66 Degree Celsius
Red Threshold : 76 Degree Celsius
This example shows a sample output of the show environment temperature command:
Device> show environment temperature
Switch 1: SYSTEM TEMPERATURE is OK
Inlet Temperature Value: 25 Degree Celsius
Temperature State: GREEN
Yellow Threshold : 46 Degree Celsius
Red Threshold : 56 Degree Celsius
Hotspot Temperature Value: 35 Degree Celsius
Temperature State: GREEN
Yellow Threshold : 105 Degree Celsius
Red Threshold : 125 Degree Celsius
Table 15: States in the show environment temperature status Command Output
State Description
Green The switch temperature is in the normal operating range.
Yellow The temperature is in the warning range. You should check the external temperature around the
switch.
Red The temperature is in the critical range. The switch might not run properly if the temperature is in
this range.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
253
Interface and Hardware Components
show errdisable detect
show errdisable detect
To display error-disabled detection status, use the show errdisable detect command in EXEC mode.
show errdisable detect
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A gbic-invalid error reason refers to an invalid small form-factor pluggable (SFP) module.
The error-disable reasons in the command output are listed in alphabetical order. The mode column shows
how error-disable is configured for each feature.
You can configure error-disabled detection in these modes:
• port mode—The entire physical port is error-disabled if a violation occurs.
• vlan mode—The VLAN is error-disabled if a violation occurs.
• port/vlan mode—The entire physical port is error-disabled on some ports and is per-VLAN error-disabled
on other ports.
This is an example of output from the show errdisable detect command:
Device> show errdisable detect
ErrDisable Reason Detection Mode
----------------- --------- ----
arp-inspection Enabled port
bpduguard Enabled vlan
channel-misconfig Enabled port
community-limit Enabled port
dhcp-rate-limit Enabled port
dtp-flap Enabled port
gbic-invalid Enabled port
inline-power Enabled port
invalid-policy Enabled port
l2ptguard Enabled port
link-flap Enabled port
loopback Enabled port
lsgroup Enabled port
pagp-flap Enabled port
psecure-violation Enabled port/vlan
security-violatio Enabled port
sfp-config-mismat Enabled port
storm-control Enabled port
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
254
Interface and Hardware Components
show errdisable detect
udld Enabled port
vmps Enabled port
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
255
Interface and Hardware Components
show errdisable recovery
show errdisable recovery
To display the error-disabled recovery timer information, use the show errdisable recovery command in
EXEC mode.
show errdisable recovery
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A gbic-invalid error-disable reason refers to an invalid small form-factor pluggable (SFP) module interface.
Note Though visible in the output, the unicast-flood field is not valid.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
256
Interface and Hardware Components
show ip interface
show ip interface
To display the usability status of interfaces configured for IP, use the show ip interface command in privileged
EXEC mode.
show ip interface [type number] [brief]
Syntax Description type (Optional) Interface type.
number (Optional) Interface number.
brief (Optional) Displays a summary of the usability status information for each interface.
Note The output of the show ip interface brief command displays information of all the
available interfaces whether or not the corresponding network module for these
interfaces are connected. These interfaces can be configured if the network module
is connected. Run the show interface status command to see which network modules
are connected.
Command Default The full usability status is displayed for all interfaces configured for IP.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The Cisco IOS software automatically enters a directly connected route in the routing table if the interface is
usable (which means that it can send and receive packets). If an interface is not usable, the directly connected
routing entry is removed from the routing table. Removing the entry lets the software use dynamic routing
protocols to determine backup routes to the network, if any.
If the interface can provide two-way communication, the line protocol is marked "up." If the interface hardware
is usable, the interface is marked "up."
If you specify an optional interface type, information for that specific interface is displayed. If you specify
no optional arguments, information on all the interfaces is displayed.
When an asynchronous interface is encapsulated with PPP or Serial Line Internet Protocol (SLIP), IP fast
switching is enabled. A show ip interface command on an asynchronous interface encapsulated with PPP or
SLIP displays a message indicating that IP fast switching is enabled.
You can use the show ip interface brief command to display a summary of the device interfaces. This
command displays the IP address, the interface status, and other information.
The show ip interface brief command does not display any information related to Unicast RPF.
Examples The following example shows interface information on Gigabit Ethernet interface 1/0/1:
Device# show ip interface gigabitethernet 1/0/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
257
Interface and Hardware Components
show ip interface
GigabitEthernet1/0/1 is up, line protocol is up
Internet address is 10.1.1.1/16
Broadcast address is 255.255.255.255
Address determined by setup command
MTU is 1500 bytes
Helper address is not set
Directed broadcast forwarding is disabled
Outgoing access list is not set
Inbound access list is not set
Proxy ARP is enabled
Local Proxy ARP is disabled
Security level is default
Split horizon is enabled
ICMP redirects are always sent
ICMP unreachables are always sent
ICMP mask replies are never sent
IP fast switching is enabled
IP fast switching on the same interface is disabled
IP Flow switching is disabled
IP CEF switching is enabled
IP Feature Fast switching turbo vector
IP VPN Flow CEF switching turbo vector
IP multicast fast switching is enabled
IP multicast distributed fast switching is disabled
IP route-cache flags are Fast, CEF
Router Discovery is disabled
IP output packet accounting is disabled
IP access violation accounting is disabled
TCP/IP header compression is disabled
RTP/IP header compression is disabled
Policy routing is enabled, using route map PBR
Network address translation is disabled
BGP Policy Mapping is disabled
IP Multi-Processor Forwarding is enabled
IP Input features, "PBR",
are not supported by MPF and are IGNORED
IP Output features, "NetFlow",
are not supported by MPF and are IGNORED
The following example shows how to display the usability status for a specific VLAN:
Device# show ip interface vlan 1
Vlan1 is up, line protocol is up
Internet address is 10.0.0.4/24
Broadcast address is 255.255.255.255
Address determined by non-volatile memory
MTU is 1500 bytes
Helper address is not set
Directed broadcast forwarding is disabled
Outgoing access list is not set
Inbound access list is not set
Proxy ARP is enabled
Local Proxy ARP is disabled
Security level is default
Split horizon is enabled
ICMP redirects are always sent
ICMP unreachables are always sent
ICMP mask replies are never sent
IP fast switching is enabled
IP fast switching on the same interface is disabled
IP Flow switching is disabled
IP CEF switching is enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
258
Interface and Hardware Components
show ip interface
IP Fast switching turbo vector
IP Normal CEF switching turbo vector
IP multicast fast switching is enabled
IP multicast distributed fast switching is disabled
IP route-cache flags are Fast, CEF
Router Discovery is disabled
IP output packet accounting is disabled
IP access violation accounting is disabled
TCP/IP header compression is disabled
RTP/IP header compression is disabled
Probe proxy name replies are disabled
Policy routing is disabled
Network address translation is disabled
WCCP Redirect outbound is disabled
WCCP Redirect inbound is disabled
WCCP Redirect exclude is disabled
BGP Policy Mapping is disabled
Sampled Netflow is disabled
IP multicast multilayer switching is disabled
Netflow Data Export (hardware) is enabled
The table below describes the significant fields shown in the display.
Table 16: show ip interface Field Descriptions
Field Description
Broadcast address is Broadcast address.
Peer address is Peer address.
MTU is MTU value set on the interface, in bytes.
Helper address Helper address, if one is set.
Directed broadcast forwarding Shows whether directed broadcast forwarding is enabled.
Outgoing access list Shows whether the interface has an outgoing access list set.
Inbound access list Shows whether the interface has an incoming access list set.
Proxy ARP Shows whether Proxy Address Resolution Protocol (ARP) is enabled
for the interface.
Security level IP Security Option (IPSO) security level set for this interface.
Split horizon Shows whether split horizon is enabled.
ICMP redirects Shows whether redirect messages will be sent on this interface.
ICMP unreachables Shows whether unreachable messages will be sent on this interface.
ICMP mask replies Shows whether mask replies will be sent on this interface.
IP fast switching Shows whether fast switching is enabled for this interface. It is
generally enabled on serial interfaces, such as this one.
IP Flow switching Shows whether Flow switching is enabled for this interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
259
Interface and Hardware Components
show ip interface
Field Description
IP CEF switching Shows whether Cisco Express Forwarding switching is enabled for
the interface.
IP multicast fast switching Shows whether multicast fast switching is enabled for the interface.
IP route-cache flags are Fast Shows whether NetFlow is enabled on an interface. Displays "Flow
init" to specify that NetFlow is enabled on the interface. Displays
"Ingress Flow" to specify that NetFlow is enabled on a subinterface
using the ip flow ingresscommand. Shows "Flow" to specify that
NetFlow is enabled on a main interface using the ip route-cache flow
command.
Router Discovery Shows whether the discovery process is enabled for this interface. It
is generally disabled on serial interfaces.
IP output packet accounting Shows whether IP accounting is enabled for this interface and what
the threshold (maximum number of entries) is.
TCP/IP header compression Shows whether compression is enabled.
WCCP Redirect outbound is disabled Shows the status of whether packets received on an interface are
redirected to a cache engine. Displays "enabled" or "disabled."
WCCP Redirect exclude is disabled Shows the status of whether packets targeted for an interface will be
excluded from being redirected to a cache engine. Displays "enabled"
or "disabled."
Netflow Data Export (hardware) is NetFlow Data Expert (NDE) hardware flow status on the interface.
enabled
The following example shows how to display a summary of the usability status information for each
interface:
Device# show ip interface brief
Interface IP-Address OK? Method Status Protocol
Vlan1 unassigned YES NVRAM administratively down down
GigabitEthernet0/0 unassigned YES NVRAM down down
GigabitEthernet1/0/1 unassigned YES NVRAM down down
GigabitEthernet1/0/2 unassigned YES unset down down
GigabitEthernet1/0/3 unassigned YES unset down down
GigabitEthernet1/0/4 unassigned YES unset down down
GigabitEthernet1/0/5 unassigned YES unset down down
GigabitEthernet1/0/6 unassigned YES unset down down
GigabitEthernet1/0/7 unassigned YES unset down down
<output truncated>
Table 17: show ip interface brief Field Descriptions
Field Description
Interface Type of interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
260
Interface and Hardware Components
show ip interface
Field Description
IP-Address IP address assigned to the interface.
OK? "Yes" means that the IP Address is valid. "No" means that the IP Address is not valid.
Method The Method field has the following possible values:
• RARP or SLARP: Reverse Address Resolution Protocol (RARP) or Serial Line Address
Resolution Protocol (SLARP) request.
• BOOTP: Bootstrap protocol.
• TFTP: Configuration file obtained from the TFTP server.
• manual: Manually changed by the command-line interface.
• NVRAM: Configuration file in NVRAM.
• IPCP: ip address negotiated command.
• DHCP: ip address dhcp command.
• unset: Unset.
• other: Unknown.
Status Shows the status of the interface. Valid values and their meanings are:
• up: Interface is up.
• down: Interface is down.
• administratively down: Interface is administratively down.
Protocol Shows the operational status of the routing protocol on this interface.
Related Commands Command Description
ip interface Configures a virtual gateway IP interface on a Secure Socket Layer Virtual Private
Network (SSL VPN) gateway
show interface status Displays the status of the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
261
Interface and Hardware Components
show interfaces
show interfaces
To display the administrative and operational status of all interfaces or for a specified interface, use the show
interfaces command in the EXEC mode.
show interfaces [{ interface-id | vlan vlan-id }] [{ accounting | capabilities [ module number
] | description | etherchannel | flowcontrol | link [ module number ] | private-vlan mapping | pruning
| stats | status [{ err-disabled | inactive }] | trunk }]
Syntax Description interface-id (Optional) ID of the interface. Valid interfaces include physical
ports (including type, stack member for stacking-capable switches,
module, and port number) and port channels.
The port channel range is 1 to 128.
vlan vlan-id (Optional) VLAN identification. The range is 1 to 4094.
accounting (Optional) Displays accounting information on the interface,
including active protocols and input and output packets and octets.
Note The display shows only packets processed in
software; hardware-switched packets do not appear.
capabilities (Optional) Displays the capabilities of all interfaces or the specified
interface, including the features and options that you can configure
on the interface. Though visible in the command line help, this
option is not available for VLAN IDs.
module number (Optional) Displays capabilities of all interfaces on the switch or
specified stack member.
The range is 1 to 9.
This option is not available if you entered a specific interface ID.
description (Optional) Displays the administrative status and description set
for interfaces.
Note The output of the show interfaces description
command displays information of all the available
interfaces whether or not the corresponding network
module for these interfaces are connected. These
interfaces can be configured if the network module
is connected. Run the show interface status
command to see which network modules are
connected.
etherchannel (Optional) Displays interface EtherChannel information.
flowcontrol (Optional) Displays interface flow control information.
link [modulenumber] (Optional) Displays the up time and down time of the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
262
Interface and Hardware Components
show interfaces
private-vlan mapping (Optional) Displays private-VLAN mapping information for the
VLAN switch virtual interfaces (SVIs). This keyword is not
available if the switch is running the LAN base feature set.
pruning (Optional) Displays trunk VTP pruning information for the
interface.
stats (Optional) Displays the input and output packets by switching the
path for the interface.
status (Optional) Displays the status of the interface. A status of
unsupported in the Type field means that a non-Cisco small
form-factor pluggable (SFP) module is inserted in the module slot.
err-disabled (Optional) Displays interfaces in an error-disabled state.
inactive (Optional) Displays interfaces in an inactive state.
trunk (Optional) Displays interface trunk information. If you do not
specify an interface, only information for active trunking ports
appears.
Note Though visible in the command-line help strings, the crb, fair-queue, irb, mac-accounting, precedence,
random-detect, rate-limit, and shape keywords are not supported.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.12.1 The link keyword was introduced.
Usage Guidelines The show interfaces capabilities command with different keywords has these results:
• Use the show interface capabilities module number command to display the capabilities of all interfaces
on that switch in the stack. If there is no switch with that module number in the stack, there is no output.
• Use the show interfaces interface-id capabilities to display the capabilities of the specified interface.
• Use the show interfaces capabilities (with no module number or interface ID) to display the capabilities
of all interfaces in the stack.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
263
Interface and Hardware Components
show interfaces
Note The field Last Input displayed in the command output indicates the number of hours, minutes, and seconds
since the last packet was successfully received by an interface and processed by the CPU on the device. This
information can be used to know when a dead interface failed.
Last Input is not updated by fast-switched traffic.
The field output displayed in the command output indicates the number of hours, minutes, and seconds since
the last packet was successfully transmitted by the interface. The information provided by this field can useful
for knowing when a dead interface failed.
The show interfaces link command with different keywords has these results:
• Use the show interface link module number command to display the up time and down time of all
interfaces on that switch in the stack. If there is no switch with that module number in the stack, there is
no output.
Note On a standalone switch, the module number refers to the slot number.
• Use the show interfaces interface-id link to display the up time and down time of the specified interface.
• Use the show interfaces link (with no module number or interface ID) to display the up time and down
time of all interfaces in the stack.
• If the interface is up, the up time displays the time (hours, minutes, and seconds) and the down time
displays 00:00:00.
• If the interface is down, only the down time displays the time (hours, minutes, and seconds).
Examples This is an example of output from the show interfaces command for an interface on stack member
3:
Device# show interfaces gigabitethernet3/0/2
GigabitEthernet3/0/2 is down, line protocol is down (notconnect)
Hardware is Gigabit Ethernet, address is 2037.064d.4381 (bia 2037.064d.4381)
MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Auto-duplex, Auto-speed, media type is 10/100/1000BaseTX
input flow-control is off, output flow-control is unsupported
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts (0 multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 watchdog, 0 multicast, 0 pause input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
264
Interface and Hardware Components
show interfaces
0 input packets with dribble condition detected
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 collisions, 1 interface resets
0 unknown protocol drops
0 babbles, 0 late collision, 0 deferred
0 lost carrier, 0 no carrier, 0 pause output
0 output buffer failures, 0 output buffers swapped out
Device# show interfaces accounting
Vlan1
Protocol Pkts In Chars In Pkts Out Chars Out
IP 0 0 6 378
Vlan200
Protocol Pkts In Chars In Pkts Out Chars Out
No traffic sent or received on this interface.
GigabitEthernet0/0
Protocol Pkts In Chars In Pkts Out Chars Out
Other 165476 11417844 0 0
Spanning Tree 1240284 64494768 0 0
ARP 7096 425760 0 0
CDP 41368 18781072 82908 35318808
GigabitEthernet1/0/1
Protocol Pkts In Chars In Pkts Out Chars Out
No traffic sent or received on this interface.
GigabitEthernet1/0/2
Protocol Pkts In Chars In Pkts Out Chars Out
No traffic sent or received on this interface.
<output truncated>
This is an example of output from the show interfaces interface description command when the
interface has been described as Connects to Marketing by using the description interface configuration
command:
Device# show interfaces gigabitethernet1/0/2 description
Interface Status Protocol Description
Gi1/0/2 up down Connects to Marketing
Device# show interfaces etherchannel
----
Port-channel34:
Age of the Port-channel = 28d:18h:51m:46s
Logical slot/port = 12/34 Number of ports = 0
GC = 0x00000000 HotStandBy port = null
Passive port list =
Port state = Port-channel L3-Ag Ag-Not-Inuse
Protocol = -
Port security = Disabled
This is an example of output from the show interfaces interface-id pruning command when
pruning is enabled in the VTP domain:
Device# show interfaces gigabitethernet1/0/2 pruning
Port Vlans pruned for lack of request by neighbor
Gi1/0/2 3,4
Port Vlans traffic requested of neighbor
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
265
Interface and Hardware Components
show interfaces
Gi1/0/2 1-3
This is an example of output from the show interfaces stats command for a specified VLAN interface:
Device# show interfaces vlan 1 stats
Switching path Pkts In Chars In Pkts Out Chars Out
Processor 1165354 136205310 570800 91731594
Route cache 0 0 0 0
Total 1165354 136205310 570800 91731594
This is an example of output from the show interfaces status err-disabled command. It displays
the status of interfaces in the error-disabled state:
Device# show interfaces status err-disabled
Port Name Status Reason
Gi1/0/2 err-disabled gbic-invalid
Gi2/0/3 err-disabled dtp-flap
This is an example of output from the show interfaces interface-id pruning command:
Device# show interfaces gigabitethernet1/0/2 pruning
Port Vlans pruned for lack of request by neighbor
Device# show interfaces gigabitethernet1/0/1 trunk
Port Mode Encapsulation Status Native vlan
Gi1/0/1 on 802.1q other 10
Port Vlans allowed on trunk
Gi1/0/1 none
Port Vlans allowed and active in management domain
Gi1/0/1 none
Port Vlans in spanning tree forwarding state and not pruned
Gi1/0/1 none
This is an example of output from the show interfaces description command:
Device# show interfaces description
Interface Status Protocol Description
Vl1 admin down down
Gi0/0 down down
Gi1/0/1 down down
Gi1/0/2 down down
Gi1/0/3 down down
Gi1/0/4 down down
Gi1/0/5 down down
Gi1/0/6 down down
Gi1/0/7 down down
<output truncated>
The following is a sample output of the show interfaces link command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
266
Interface and Hardware Components
show interfaces
Device> enable
Device# show interfaces link
Port Name Down Time Up Time
Gi1/0/1 6w0d
Gi1/0/2 6w0d
Gi1/0/3 00:00:00 5w3d
Gi1/0/4 6w0d
Gi1/0/5 6w0d
Gi1/0/6 6w0d
Gi1/0/7 6w0d
Gi1/0/8 6w0d
Gi1/0/9 6w0d
Gi1/0/10 6w0d
Gi1/0/11 2d17h
Gi1/0/12 6w0d
Gi1/0/13 6w0d
Gi1/0/14 6w0d
Gi1/0/15 6w0d
Gi1/0/16 6w0d
Gi1/0/17 6w0d
Gi1/0/18 6w0d
Gi1/0/19 6w0d
Gi1/0/20 6w0d
Gi1/0/21 6w0d
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
267
Interface and Hardware Components
show interfaces counters
show interfaces counters
To display various counters for the switch or for a specific interface, use the show interfaces counters
command in privileged EXEC mode.
show interfaces [interface-id] counters [{errors | etherchannel | module member-number | protocol
status | trunk}]
Syntax Description interface-id (Optional) ID of the physical interface, including type, stack member
(stacking-capable switches only) module, and port number.
errors (Optional) Displays error counters.
etherchannel (Optional) Displays EtherChannel counters, including octets, broadcast packets,
multicast packets, and unicast packets received and sent.
module member-number (Optional) Displays counters for the specified member.
The range is 1 to 9.
Note In this command, the module keyword refers to the stack member
number. The module number that is part of the interface ID is
always zero.
protocol status (Optional) Displays the status of protocols enabled on interfaces.
trunk (Optional) Displays trunk counters.
Note Though visible in the command-line help string, the vlan vlan-id keyword is not supported.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not enter any keywords, all counters for all interfaces are included.
This is an example of partial output from the show interfaces counters command. It displays all
counters for the switch.
Device# show interfaces counters
Port InOctets InUcastPkts InMcastPkts InBcastPkts
Gi1/0/1 0 0 0 0
Gi1/0/2 0 0 0 0
Gi1/0/3 95285341 43115 1178430 1950
Gi1/0/4 0 0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
268
Interface and Hardware Components
show interfaces counters
<output truncated>
This is an example of partial output from the show interfaces counters module command for module
2. It displays all counters for the specified switch in the module.
Device# show interfaces counters module 2
Port InOctets InUcastPkts InMcastPkts InBcastPkts
Gi1/0/1 520 2 0 0
Gi1/0/2 520 2 0 0
Gi1/0/3 520 2 0 0
Gi1/0/4 520 2 0 0
<output truncated>
This is an example of partial output from the show interfaces counters protocol status command
for all interfaces:
Device# show interfaces counters protocol status
Protocols allocated:
Vlan1: Other, IP
Vlan20: Other, IP, ARP
Vlan30: Other, IP, ARP
Vlan40: Other, IP, ARP
Vlan50: Other, IP, ARP
Vlan60: Other, IP, ARP
Vlan70: Other, IP, ARP
Vlan80: Other, IP, ARP
Vlan90: Other, IP, ARP
Vlan900: Other, IP, ARP
Vlan3000: Other, IP
Vlan3500: Other, IP
GigabitEthernet1/0/1: Other, IP, ARP, CDP
GigabitEthernet1/0/2: Other, IP
GigabitEthernet1/0/3: Other, IP
GigabitEthernet1/0/4: Other, IP
GigabitEthernet1/0/5: Other, IP
GigabitEthernet1/0/6: Other, IP
GigabitEthernet1/0/7: Other, IP
GigabitEthernet1/0/8: Other, IP
GigabitEthernet1/0/9: Other, IP
GigabitEthernet1/0/10: Other, IP, CDP
<output truncated>
This is an example of output from the show interfaces counters trunk command. It displays trunk
counters for all interfaces.
Device# show interfaces counters trunk
Port TrunkFramesTx TrunkFramesRx WrongEncap
Gi1/0/1 0 0 0
Gi1/0/2 0 0 0
Gi1/0/3 80678 0 0
Gi1/0/4 82320 0 0
Gi1/0/5 0 0 0
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
269
Interface and Hardware Components
show interfaces switchport
show interfaces switchport
To display the administrative and operational status of a switching (nonrouting) port, including port blocking
and port protection settings, use the show interfaces switchport command in privileged EXEC mode.
show interfaces [interface-id] switchport [{module number}]
Syntax Description interface-id (Optional) ID of the interface. Valid interfaces include physical ports (including type,
stack member for stacking-capable switches, module, and port number) and port channels.
The port channel range is 1 to 48.
module number (Optional) Displays switchport configuration of all interfaces on the switch or specified
stack member.
The range is 1 to 9.
This option is not available if you entered a specific interface ID.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show interface switchport module number command to display the switch port characteristics of
all interfaces on that switch in the stack. If there is no switch with that module number in the stack, there is
no output.
This is an example of output from the show interfaces switchport command for a port. The table
that follows describes the fields in the display.
Device# show interfaces gigabitethernet1/0/1 switchport
Name: Gi1/0/1
Switchport: Enabled
Administrative Mode: trunk
Operational Mode: down
Administrative Trunking Encapsulation: dot1q
Negotiation of Trunking: On
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 10 (VLAN0010)
Administrative Native VLAN tagging: enabled
Voice VLAN: none
Administrative private-vlan host-association: none
Administrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: none
Administrative private-vlan trunk Native VLAN tagging: enabled
Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: none
Administrative private-vlan trunk associations: none
Administrative private-vlan trunk mappings: none
Operational private-vlan: none
Trunking VLANs Enabled: 11-20
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
270
Interface and Hardware Components
show interfaces switchport
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled
Capture VLANs Allowed: ALL
Protected: false
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Field Description
Name Displays the port name.
Switchport Displays the administrative and operational status of
the port. In this display, the port is in switchport mode.
Administrative Mode Displays the administrative and operational modes.
Operational Mode
Administrative Trunking Encapsulation Displays the administrative and operational
encapsulation method and whether trunking
Operational Trunking Encapsulation
negotiation is enabled.
Negotiation of Trunking
Access Mode VLAN Displays the VLAN ID to which the port is
configured.
Trunking Native Mode VLAN Lists the VLAN ID of the trunk that is in native mode.
Lists the allowed VLANs on the trunk. Lists the active
Trunking VLANs Enabled
VLANs on the trunk.
Trunking VLANs Active
Pruning VLANs Enabled Lists the VLANs that are pruning-eligible.
Protected Displays whether or not protected port is enabled
(True) or disabled (False) on the interface.
Unknown unicast blocked Displays whether or not unknown multicast and
unknown unicast traffic is blocked on the interface.
Unknown multicast blocked
Voice VLAN Displays the VLAN ID on which voice VLAN is
enabled.
Appliance trust Displays the class of service (CoS) setting of the data
packets of the IP phone.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
271
Interface and Hardware Components
show interfaces transceiver
show interfaces transceiver
To display the physical properties of a small form-factor pluggable (SFP) module interface, use the show
interfaces transceiver command in EXEC mode.
show interfaces [interface-id] transceiver [{detail | module number | properties | supported-list |
threshold-table}]
Syntax Description interface-id (Optional) ID of the physical interface, including type, stack member (stacking-capable
switches only) module, and port number.
detail (Optional) Displays calibration properties, including high and low numbers and any alarm
information for any Digital Optical Monitoring (DoM)-capable transceiver if one is
installed in the switch.
module number (Optional) Limits display to interfaces on module on the switch.
This option is not available if you entered a specific interface ID.
properties (Optional) Displays speed, duplex, and inline power settings on an interface.
supported-list (Optional) Lists all supported transceivers.
threshold-table (Optional) Displays alarm and warning threshold table.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This is an example of output from the show interfaces interface-id transceiver properties command:
Device# show interfaces transceiver
If device is externally calibrated, only calibrated values are printed.
++ : high alarm, + : high warning, - : low warning, -- : low alarm.
NA or N/A: not applicable, Tx: transmit, Rx: receive.
mA: milliamperes, dBm: decibels (milliwatts).
Optical Optical
Temperature Voltage Current Tx Power Rx Power
Port (Celsius) (Volts) (mA) (dBm) (dBm)
--------- ----------- ------- -------- -------- --------
Gi5/1/2 42.9 3.28 22.1 -5.4 -8.1
Te5/1/3 32.0 3.28 19.8 2.4 -4.2
Device# show interfaces gigabitethernet1/1/1 transceiver properties
Name : Gi1/1/1
Administrative Speed: auto
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
272
Interface and Hardware Components
show interfaces transceiver
Operational Speed: auto
Administrative Duplex: auto
Administrative Power Inline: enable
Operational Duplex: auto
Administrative Auto-MDIX: off
Operational Auto-MDIX: off
This is an example of output from the show interfaces interface-id transceiver detail command:
Device# show interfaces gigabitethernet1/1/1 transceiver detail
ITU Channel not available (Wavelength not available),
Transceiver is internally calibrated.
mA:milliamperes, dBm:decibels (milliwatts), N/A:not applicable.
++:high alarm, +:high warning, -:low warning, -- :low alarm.
A2D readouts (if they differ), are reported in parentheses.
The threshold values are uncalibrated.
High Alarm High Warn Low Warn Low Alarm
Temperature Threshold Threshold Threshold Threshold
Port (Celsius) (Celsius) (Celsius) (Celsius) (Celsius)
------- ----------------- ---------- --------- --------- ---------
Gi1/1/1 29.9 74.0 70.0 0.0 -4.0
High Alarm High Warn Low Warn Low Alarm
Voltage Threshold Threshold Threshold Threshold
Port (Volts) (Volts) (Volts) (Volts) (Volts)
------- --------------- ---------- --------- --------- ---------
Gi1/1/1 3.28 3.60 3.50 3.10 3.00
Optical High Alarm High Warn Low Warn Low Alarm
Transmit Power Threshold Threshold Threshold Threshold
Port (dBm) (dBm) (dBm) (dBm) (dBm)
------- ----------------- ---------- --------- --------- ---------
Gi1/1/1 1.8 7.9 3.9 0.0 -4.0
Optical High Alarm High Warn Low Warn Low Alarm
Receive Power Threshold Threshold Threshold Threshold
Port (dBm) (dBm) (dBm) (dBm) (dBm)
------- ----------------- ---------- --------- --------- ---------
Gi1/1/1 -23.5 -5.0 -9.0 -28.2 -32.2
Device# show interfaces transceiver supported-list
Transceiver Type Cisco p/n min version
supporting DOM
------------------ -------------------------
DWDM GBIC ALL
DWDM SFP ALL
RX only WDM GBIC ALL
DWDM XENPAK ALL
DWDM X2 ALL
DWDM XFP ALL
CWDM GBIC NONE
CWDM X2 ALL
CWDM XFP ALL
XENPAK ZR ALL
X2 ZR ALL
XFP ZR ALL
Rx_only_WDM_XENPAK ALL
XENPAK_ER 10-1888-04
X2_ER ALL
XFP_ER ALL
XENPAK_LR 10-1838-04
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
273
Interface and Hardware Components
show interfaces transceiver
X2_LR ALL
XFP_LR ALL
XENPAK_LW ALL
X2_LW ALL
XFP_LW NONE
XENPAK SR NONE
X2 SR ALL
XFP SR ALL
XENPAK LX4 NONE
X2 LX4 NONE
XFP LX4 NONE
XENPAK CX4 NONE
X2 CX4 NONE
XFP CX4 NONE
SX GBIC NONE
LX GBIC NONE
ZX GBIC NONE
CWDM_SFP ALL
Rx_only_WDM_SFP NONE
SX_SFP ALL
LX_SFP ALL
ZX_SFP ALL
EX_SFP ALL
SX SFP NONE
LX SFP NONE
ZX SFP NONE
GIgE BX U SFP NONE
GigE BX D SFP ALL
X2 LRM ALL
SR_SFPP ALL
LR_SFPP ALL
LRM_SFPP ALL
ER_SFPP ALL
ZR_SFPP ALL
DWDM_SFPP ALL
GIgE BX 40U SFP ALL
GigE BX 40D SFP ALL
GigE BX 40DA SFP ALL
GIgE BX 80U SFP ALL
GigE BX 80D SFP ALL
GIG BXU_SFPP ALL
GIG BXD_SFPP ALL
GIG BX40U_SFPP ALL
GIG BX40D_SFPP ALL
GigE Dual Rate LX SFP ALL
CWDM_SFPP ALL
CPAK_SR10 ALL
CPAK_LR4 ALL
QSFP_LR ALL
QSFP_SR ALL
This is an example of output from the show interfaces transceiver threshold-table command:
Device# show interfaces transceiver threshold-table
Optical Tx Optical Rx Temp Laser Bias Voltage
current
------------- ------------- ------ ------------ ---------
DWDM GBIC
Min1 -4.00 -32.00 -4 N/A 4.65
Min2 0.00 -28.00 0 N/A 4.75
Max2 4.00 -9.00 70 N/A 5.25
Max1 7.00 -5.00 74 N/A 5.40
DWDM SFP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
274
Interface and Hardware Components
show interfaces transceiver
Min1 -4.00 -32.00 -4 N/A 3.00
Min2 0.00 -28.00 0 N/A 3.10
Max2 4.00 -9.00 70 N/A 3.50
Max1 8.00 -5.00 74 N/A 3.60
RX only WDM GBIC
Min1 N/A -32.00 -4 N/A 4.65
Min2 N/A -28.30 0 N/A 4.75
Max2 N/A -9.00 70 N/A 5.25
Max1 N/A -5.00 74 N/A 5.40
DWDM XENPAK
Min1 -5.00 -28.00 -4 N/A N/A
Min2 -1.00 -24.00 0 N/A N/A
Max2 3.00 -7.00 70 N/A N/A
Max1 7.00 -3.00 74 N/A N/A
DWDM X2
Min1 -5.00 -28.00 -4 N/A N/A
Min2 -1.00 -24.00 0 N/A N/A
Max2 3.00 -7.00 70 N/A N/A
Max1 7.00 -3.00 74 N/A N/A
DWDM XFP
Min1 -5.00 -28.00 -4 N/A N/A
Min2 -1.00 -24.00 0 N/A N/A
Max2 3.00 -7.00 70 N/A N/A
Max1 7.00 -3.00 74 N/A N/A
CWDM X2
Min1 N/A N/A 0 N/A N/A
Min2 N/A N/A 0 N/A N/A
Max2 N/A N/A 0 N/A N/A
Max1 N/A N/A 0 N/A N/A
<output truncated>
Related Commands Command Description
transceiver type all Enters the transceiver type configuration mode.
monitoring Enables digital optical monitoring.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
275
Interface and Hardware Components
show inventory
show inventory
To display the product inventory listing of all Cisco products installed in the networking device, use the show
inventory command in user EXEC or privileged EXEC mode.
show inventory {fru | oid | raw} [entity]
fru (Optional) Retrieves information about all Field Replaceable Units (FRUs) installed in the Cisco
networking device.
oid (Optional) Retrieves information about the vendor specific hardware registration identifier referred
to as object identifier (OID).
The OID identifies the MIB object’s location in the MIB hierarchy, and provides a means of accessing
the MIB object in a network of managed devices
raw (Optional) Retrieves information about all Cisco products referred to as entities installed in the Cisco
networking device, even if the entities do not have a product ID (PID) value, a unique device identifier
(UDI), or other physical identification.
entity (Optional) Name of a Cisco entity (for example, chassis, backplane, module, or slot). A quoted string
may be used to display very specific UDI information; for example “sfslot 1” will display the UDI
information for slot 1 of an entity named sfslot.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Cisco IOS XE Everest 16.6.3 This command was enhanced to display the serial number
for the chassis.
Usage Guidelines The show inventory command retrieves and displays inventory information about each Cisco product in the
form of a UDI. The UDI is a combination of three separate data elements: a product identifier (PID), a version
identifier (VID), and the serial number (SN).
The PID is the name by which the product can be ordered; it has been historically called the “Product Name”
or “Part Number.” This is the identifier that one would use to order an exact replacement part.
The VID is the version of the product. Whenever a product has been revised, the VID will be incremented.
The VID is incremented according to a rigorous process derived from Telcordia GR-209-CORE, an industry
guideline that governs product change notices.
The SN is the vendor-unique serialization of the product. Each manufactured product will carry a unique serial
number assigned at the factory, which cannot be changed in the field. This is the means by which to identify
an individual, specific instance of a product.
The UDI refers to each product as an entity. Some entities, such as a chassis, will have subentities like slots.
Each entity will display on a separate line in a logically ordered presentation that is arranged hierarchically
by Cisco entities.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
276
Interface and Hardware Components
show inventory
Use the show inventory command without options to display a list of Cisco entities installed in the networking
device that are assigned a PID.
The following is sample output from the show inventory command:
Device#show inventory
NAME: "c93xx Stack", DESCR: "c93xx Stack"
PID: C9300-48UXM , VID: P2B , SN: FCW2117G00C
NAME: "Switch 2", DESCR: "C9300-48UXM"
PID: C9300-48UXM , VID: P2B , SN: FCW2117G00C
NAME: "Switch 2 - Power Supply A", DESCR: "Switch 2 - Power Supply A"
PID: PWR-C1-1100WAC , VID: V02 , SN: LIT211227NZ
NAME: "Switch 2 FRU Uplink Module 1", DESCR: "8x10G Uplink Module"
PID: C3850-NM-8-10G , VID: V01 , SN: FOC20153M58
NAME: "Te2/1/1", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H0SU
NAME: "Te2/1/3", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H0A8
NAME: "Te2/1/5", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H1G8
NAME: "usbflash1", DESCR: "usbflash1"
PID: SSD-120G , VID: STP21460FNA, SN: V01
Table 18: show inventory Field Descriptions
Field Description
NAME Physical name (text string) assigned to the Cisco entity. For example, console or a simple component
number (port or module number), such as “1,” depending on the physical component naming syntax
of the device.
DESCR Physical description of the Cisco entity that characterizes the object. The physical description
includes the hardware serial number and the hardware revision.
PID Entity product identifier. Equivalent to the entPhysicalModelName MIB variable in RFC 2737.
VID Entity version identifier. Equivalent to the entPhysicalHardwareRev MIB variable in RFC 2737.
SN Entity serial number. Equivalent to the entPhysicalSerialNum MIB variable in RFC 2737.
For diagnostic purposes, the show inventorycommand can be used with the raw keyword to display
every RFC 2737 entity including those without a PID, UDI, or other physical identification.
Note The raw keyword option is primarily intended for troubleshooting problems with the show inventory
command itself.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
277
Interface and Hardware Components
show inventory
Enter the show inventory command with an entity argument value to display the UDI information
for a specific type of Cisco entity installed in the networking device. In this example, a list of Cisco
entities that match the sfslot argument string is displayed.
Device#show inventory "c93xx Stack"
NAME: "c93xx Stack", DESCR: "c93xx Stack"
PID: C9300-48UXM , VID: P2B , SN: FCW2117G00C
NAME: "Switch 2", DESCR: "C9300-48UXM"
PID: C9300-48UXM , VID: P2B , SN: FCW2117G00C
NAME: "Switch 2 - Power Supply A", DESCR: "Switch 2 - Power Supply A"
PID: PWR-C1-1100WAC , VID: V02 , SN: LIT211227NZ
NAME: "Switch 2 FRU Uplink Module 1", DESCR: "8x10G Uplink Module"
PID: C3850-NM-8-10G , VID: V01 , SN: FOC20153M58
NAME: "Te2/1/1", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H0SU
NAME: "Te2/1/3", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H0A8
NAME: "Te2/1/5", DESCR: "SFP-10GBase-CX1"
PID: SFP-H10GB-CU2M , VID: V02 , SN: TED2132H1G8
NAME: "usbflash1", DESCR: "usbflash1"
PID: SSD-120G , VID: STP21460FNA, SN: V01
You can request even more specific UDI information with the entity argument value enclosed in
quotation marks.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
278
Interface and Hardware Components
show macro auto
show macro auto
To display Auto Smartports macro information, use the show macro auto command in user EXEC mode.
show macro auto {address-group address-group-name | device [access-point] [ip-camera]
[lightweight-ap] [media-player] [phone] [router] [switch] | global [event_trigger] | interface
[interface_id]}
Syntax Description address-group [address-group-name] Displays address-group information.
(Optional) address-group-name—Displays
information for the specified address group.
device [access-point] [ip-camera] [lightweight-ap] Displays device information about one or more
[media-player] [phone] [router] [switch] devices.
• (Optional) access-point—Autonomous
access point
• (Optional) ip-camera—Cisco IP video
surveillance camera
• (Optional) lightweight-ap—Lightweight
access point
• (Optional) media-player—Digital media
player
• (Optional) phone—Cisco IP phone
• (Optional) router—Cisco router
• (Optional) switch—Cisco switch
global [event_trigger] Displays Auto Smartports information about
the switch.
(Optional) event_trigger—Displays
information about the specified event trigger.
interface [interface_id] Displays interface status.
(Optional) interface_id—isplays information
about the specified interface.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
279
Interface and Hardware Components
show macro auto
Usage Guidelines Use this command to display the Auto SmartPorts information for the switch. Use the show macro auto
device command to display the configurable parameters for a device.
Example
This example shows how to use the show macro auto device to view the configuration on the switch:
Device# show macro auto device
Device:lightweight-ap
Default Macro:CISCO_LWAP_AUTO_SMARTPORT
Current Macro:CISCO_LWAP_AUTO_SMARTPORT
Configurable Parameters:ACCESS_VLAN
Defaults Parameters:ACCESS_VLAN=1
Current Parameters:ACCESS_VLAN=1
Device:access-point
Default Macro:CISCO_AP_AUTO_SMARTPORT
Current Macro:CISCO_AP_AUTO_SMARTPORT
Configurable Parameters:NATIVE_VLAN
Defaults Parameters:NATIVE_VLAN=1
Current Parameters:NATIVE_VLAN=1
Device:phone
Default Macro:CISCO_PHONE_AUTO_SMARTPORT
Current Macro:CISCO_PHONE_AUTO_SMARTPORT
Configurable Parameters:ACCESS_VLAN VOICE_VLAN
Defaults Parameters:ACCESS_VLAN=1 VOICE_VLAN=2
Current Parameters:ACCESS_VLAN=1 VOICE_VLAN=2
Device:router
Default Macro:CISCO_ROUTER_AUTO_SMARTPORT
Current Macro:CISCO_ROUTER_AUTO_SMARTPORT
Configurable Parameters:NATIVE_VLAN
Defaults Parameters:NATIVE_VLAN=1
Current Parameters:NATIVE_VLAN=1
Device:switch
Default Macro:CISCO_SWITCH_AUTO_SMARTPORT
Current Macro:CISCO_SWITCH_AUTO_SMARTPORT
Configurable Parameters:NATIVE_VLAN
Defaults Parameters:NATIVE_VLAN=1
Current Parameters:NATIVE_VLAN=1
Device:ip-camera
Default Macro:CISCO_IP_CAMERA_AUTO_SMARTPORT
Current Macro:CISCO_IP_CAMERA_AUTO_SMARTPORT
Configurable Parameters:ACCESS_VLAN
Defaults Parameters:ACCESS_VLAN=1
Current Parameters:ACCESS_VLAN=1
Device:media-player
Default Macro:CISCO_DMP_AUTO_SMARTPORT
Current Macro:CISCO_DMP_AUTO_SMARTPORT
Configurable Parameters:ACCESS_VLAN
Defaults Parameters:ACCESS_VLAN=1
Current Parameters:ACCESS_VLAN=1
This example shows how to use the show macro auto address-group name command to view the
TEST3 address group configuration on the switch:
Device# show macro auto address-group TEST3MAC Address Group Configuration:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
280
Interface and Hardware Components
show macro auto
Group Name OUI MAC ADDRESS
--------------------------------------------------------------
TEST3 2233.33 0022.0022.0022
2233.34
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
281
Interface and Hardware Components
show memory platform
show memory platform
To display memory statistics of a platform, use the show memory platform command in privileged EXEC
mode.
show memory platform [{compressed-swap | information | page-merging}]
Syntax Description compressed-swap (Optional) Displays platform memory compressed-swap information.
information (Optional) Displays general information about the platform.
page-merging (Optional) Displays platform memory page-merging information.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Free memory is accurately computed and displayed in the Free Memory field of the command output.
Examples The following is sample output from the show memory platform command:
Switch# show memory platform
Virtual memory : 12874653696
Pages resident : 627041
Major page faults: 2220
Minor page faults: 2348631
Architecture : mips64
Memory (kB)
Physical : 3976852
Total : 3976852
Used : 2761276
Free : 1215576
Active : 2128196
Inactive : 1581856
Inact-dirty : 0
Inact-clean : 0
Dirty : 0
AnonPages : 1294984
Bounce : 0
Cached : 1978168
Commit Limit : 1988424
Committed As : 3343324
High Total : 0
High Free : 0
Low Total : 3976852
Low Free : 1215576
Mapped : 516316
NFS Unstable : 0
Page Tables : 17124
Slab : 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
282
Interface and Hardware Components
show memory platform
VMmalloc Chunk : 1069542588
VMmalloc Total : 1069547512
VMmalloc Used : 2588
Writeback : 0
HugePages Total: 0
HugePages Free : 0
HugePages Rsvd : 0
HugePage Size : 2048
Swap (kB)
Total : 0
Used : 0
Free : 0
Cached : 0
Buffers (kB) : 437136
Load Average
1-Min : 1.04
5-Min : 1.16
15-Min : 0.94
The following is sample output from the show memory platform information command:
Device# show memory platform information
Virtual memory : 12870438912
Pages resident : 626833
Major page faults: 2222
Minor page faults: 2362455
Architecture : mips64
Memory (kB)
Physical : 3976852
Total : 3976852
Used : 2761224
Free : 1215628
Active : 2128060
Inactive : 1584444
Inact-dirty : 0
Inact-clean : 0
Dirty : 284
AnonPages : 1294656
Bounce : 0
Cached : 1979644
Commit Limit : 1988424
Committed As : 3342184
High Total : 0
High Free : 0
Low Total : 3976852
Low Free : 1215628
Mapped : 516212
NFS Unstable : 0
Page Tables : 17096
Slab : 0
VMmalloc Chunk : 1069542588
VMmalloc Total : 1069547512
VMmalloc Used : 2588
Writeback : 0
HugePages Total: 0
HugePages Free : 0
HugePages Rsvd : 0
HugePage Size : 2048
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
283
Interface and Hardware Components
show memory platform
Swap (kB)
Total : 0
Used : 0
Free : 0
Cached : 0
Buffers (kB) : 438228
Load Average
1-Min : 1.54
5-Min : 1.27
15-Min : 0.99
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
284
Interface and Hardware Components
show module
show module
To display module information such as switch number, model number, serial number, hardware revision
number, software version, MAC address and so on, use this command in user EXEC or privileged EXEC
mode.
show module [{switch-num}]
Syntax Description switch-num (Optional) Number of the switch.
Command Default None
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Entering the show module command without the switch-num argument is the same as entering the show
module all command.
The following example displays information for all modules on a Cisco Catalyst 9300 Series Switch:
Device# show module
Switch Ports Model Serial No. MAC address Hw Ver. Sw Ver.
------ ----- --------- ----------- -------------- ------- --------
1 40 C9300-24T FOC2147Q02D b4a8.b9c1.4100 V01 16.10.1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
285
Interface and Hardware Components
show mgmt-infra trace messages ilpower
show mgmt-infra trace messages ilpower
To display inline power messages within a trace buffer, use the show mgmt-infra trace messages ilpower
command in privileged EXEC mode.
show mgmt-infra trace messages ilpower [switch stack-member-number]
Syntax Description switch stack-member-number (Optional) Specifies the stack member number for which to display inline
power messages within a trace buffer.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an output example from the show mgmt-infra trace messages ilpower command:
Device# show mgmt-infra trace messages ilpower
[10/23/12 14:05:10.984 UTC 1 3] Initialized inline power system configuration fo
r slot 1.
[10/23/12 14:05:10.984 UTC 2 3] Initialized inline power system configuration fo
r slot 2.
[10/23/12 14:05:10.984 UTC 3 3] Initialized inline power system configuration fo
r slot 3.
[10/23/12 14:05:10.984 UTC 4 3] Initialized inline power system configuration fo
r slot 4.
[10/23/12 14:05:10.984 UTC 5 3] Initialized inline power system configuration fo
r slot 5.
[10/23/12 14:05:10.984 UTC 6 3] Initialized inline power system configuration fo
r slot 6.
[10/23/12 14:05:10.984 UTC 7 3] Initialized inline power system configuration fo
r slot 7.
[10/23/12 14:05:10.984 UTC 8 3] Initialized inline power system configuration fo
r slot 8.
[10/23/12 14:05:10.984 UTC 9 3] Initialized inline power system configuration fo
r slot 9.
[10/23/12 14:05:10.984 UTC a 3] Inline power subsystem initialized.
[10/23/12 14:05:18.908 UTC b 264] Create new power pool for slot 1
[10/23/12 14:05:18.909 UTC c 264] Set total inline power to 450 for slot 1
[10/23/12 14:05:20.273 UTC d 3] PoE is not supported on .
[10/23/12 14:05:20.288 UTC e 3] PoE is not supported on .
[10/23/12 14:05:20.299 UTC f 3] PoE is not supported on .
[10/23/12 14:05:20.311 UTC 10 3] PoE is not supported on .
[10/23/12 14:05:20.373 UTC 11 98] Inline power process post for switch 1
[10/23/12 14:05:20.373 UTC 12 98] PoE post passed on switch 1
[10/23/12 14:05:20.379 UTC 13 3] Slot #1: PoE initialization for board id 16387
[10/23/12 14:05:20.379 UTC 14 3] Set total inline power to 450 for slot 1
[10/23/12 14:05:20.379 UTC 15 3] Gi1/0/1 port config Initialized
[10/23/12 14:05:20.379 UTC 16 3] Interface Gi1/0/1 initialization done.
[10/23/12 14:05:20.380 UTC 17 3] Gi1/0/24 port config Initialized
[10/23/12 14:05:20.380 UTC 18 3] Interface Gi1/0/24 initialization done.
[10/23/12 14:05:20.380 UTC 19 3] Slot #1: initialization done.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
286
Interface and Hardware Components
show mgmt-infra trace messages ilpower
[10/23/12 14:05:50.440 UTC 1a 3] Slot #1: PoE initialization for board id 16387
[10/23/12 14:05:50.440 UTC 1b 3] Duplicate init event
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
287
Interface and Hardware Components
show mgmt-infra trace messages ilpower-ha
show mgmt-infra trace messages ilpower-ha
To display inline power high availability messages within a trace buffer, use the show mgmt-infra trace
messages ilpower-ha command in privileged EXEC mode.
show mgmt-infra trace messages ilpower-ha [switch stack-member-number]
Syntax Description switch stack-member-number (Optional) Specifies the stack member number for which to display inline
power messages within a trace buffer.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an output example from the show mgmt-infra trace messages ilpower-ha command:
Device# show mgmt-infra trace messages ilpower-ha
[10/23/12 14:04:48.087 UTC 1 3] NG3K_ILPOWER_HA: Created NGWC ILP CF client succ
essfully.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
288
Interface and Hardware Components
show mgmt-infra trace messages platform-mgr-poe
show mgmt-infra trace messages platform-mgr-poe
To display platform manager Power over Ethernet (PoE) messages within a trace buffer, use the show
mgmt-infra trace messages platform-mgr-poe privileged EXEC command.
show mgmt-infra trace messages platform-mgr-poe [switch stack-member-number]
Syntax Description switch stack-member-number (Optional) Specifies the stack member number for which to display messages
within a trace buffer.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of partial output from the show mgmt-infra trace messages platform-mgr-poe
command:
Device# show mgmt-infra trace messages platform-mgr-poe
[10/23/12 14:04:06.431 UTC 1 5495] PoE Info: get power controller param sent:
[10/23/12 14:04:06.431 UTC 2 5495] PoE Info: POE_SHUT sent for port 1 (0:0)
[10/23/12 14:04:06.431 UTC 3 5495] PoE Info: POE_SHUT sent for port 2 (0:1)
[10/23/12 14:04:06.431 UTC 4 5495] PoE Info: POE_SHUT sent for port 3 (0:2)
[10/23/12 14:04:06.431 UTC 5 5495] PoE Info: POE_SHUT sent for port 4 (0:3)
[10/23/12 14:04:06.431 UTC 6 5495] PoE Info: POE_SHUT sent for port 5 (0:4)
[10/23/12 14:04:06.431 UTC 7 5495] PoE Info: POE_SHUT sent for port 6 (0:5)
[10/23/12 14:04:06.431 UTC 8 5495] PoE Info: POE_SHUT sent for port 7 (0:6)
[10/23/12 14:04:06.431 UTC 9 5495] PoE Info: POE_SHUT sent for port 8 (0:7)
[10/23/12 14:04:06.431 UTC a 5495] PoE Info: POE_SHUT sent for port 9 (0:8)
[10/23/12 14:04:06.431 UTC b 5495] PoE Info: POE_SHUT sent for port 10 (0:9)
[10/23/12 14:04:06.431 UTC c 5495] PoE Info: POE_SHUT sent for port 11 (0:10)
[10/23/12 14:04:06.431 UTC d 5495] PoE Info: POE_SHUT sent for port 12 (0:11)
[10/23/12 14:04:06.431 UTC e 5495] PoE Info: POE_SHUT sent for port 13 (e:0)
[10/23/12 14:04:06.431 UTC f 5495] PoE Info: POE_SHUT sent for port 14 (e:1)
[10/23/12 14:04:06.431 UTC 10 5495] PoE Info: POE_SHUT sent for port 15 (e:2)
[10/23/12 14:04:06.431 UTC 11 5495] PoE Info: POE_SHUT sent for port 16 (e:3)
[10/23/12 14:04:06.431 UTC 12 5495] PoE Info: POE_SHUT sent for port 17 (e:4)
[10/23/12 14:04:06.431 UTC 13 5495] PoE Info: POE_SHUT sent for port 18 (e:5)
[10/23/12 14:04:06.431 UTC 14 5495] PoE Info: POE_SHUT sent for port 19 (e:6)
[10/23/12 14:04:06.431 UTC 15 5495] PoE Info: POE_SHUT sent for port 20 (e:7)
[10/23/12 14:04:06.431 UTC 16 5495] PoE Info: POE_SHUT sent for port 21 (e:8)
[10/23/12 14:04:06.431 UTC 17 5495] PoE Info: POE_SHUT sent for port 22 (e:9)
[10/23/12 14:04:06.431 UTC 18 5495] PoE Info: POE_SHUT sent for port 23 (e:10)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
289
Interface and Hardware Components
show network-policy profile
show network-policy profile
To display the network-policy profiles, use the show network policy profile command in privileged EXEC
mode.
show network-policy profile [profile-number] [detail]
Syntax Description profile-number (Optional) Displays the network-policy profile number. If no profile is entered, all
network-policy profiles appear.
detail (Optional) Displays detailed status and statistics information.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of output from the show network-policy profile command:
Device# show network-policy profile
Network Policy Profile 10
voice vlan 17 cos 4
Interface:
none
Network Policy Profile 30
voice vlan 30 cos 5
Interface:
none
Network Policy Profile 36
voice vlan 4 cos 3
Interface:
Interface_id
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
290
Interface and Hardware Components
show parser macro
show parser macro
To display the parameters for all configured macros or for one macro on the switch, use the show parser
macro command in user EXEC mode.
show parser macro {brief | description [interface interface-id] | name macro-name}
Syntax Description brief (Optional) Displays the name of each macro.
description [interface interface-id] (Optional) Displays all macro descriptions or the
description of a specific interface.
name macro-name (Optional) Displays information about a single
macro identified by the macro name.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
This is a partial output example from the show parser macro command. The output for the
Cisco-default macros varies depending on the switch platform and the software image running on
the switch:
Device# show parser macro
Total number of macros = 6
--------------------------------------------------------------
Macro name : cisco-global
Macro type : default global
# Enable dynamic port error recovery for link state
# failures
errdisable recovery cause link-flap
errdisable recovery interval 60
<output truncated>
--------------------------------------------------------------
Macro name : cisco-desktop
Macro type : default interface
# macro keywords $AVID
# Basic interface - Enable data VLAN only
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID
switchport mode access
<output truncated>
--------------------------------------------------------------
Macro name : cisco-phone
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
291
Interface and Hardware Components
show parser macro
Macro type : default interface
# Cisco IP phone + desktop template
# macro keywords $AVID $VVID
# VoIP enabled interface - Enable data VLAN
# and voice VLAN (VVID)
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID
switchport mode access
<output truncated>
--------------------------------------------------------------
Macro name : cisco-switch
Macro type : default interface
# macro keywords $NVID
# Access Uplink to Distribution
# Do not apply to EtherChannel/Port Group
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID
<output truncated>
--------------------------------------------------------------
Macro name : cisco-router
Macro type : default interface
# macro keywords $NVID
# Access Uplink to Distribution
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID
<output truncated>
--------------------------------------------------------------
Macro name : snmp
Macro type : customizable
#enable port security, linkup, and linkdown traps
snmp-server enable traps port-security
snmp-server enable traps linkup
snmp-server enable traps linkdown
#set snmp-server host
snmp-server host ADDRESS
#set SNMP trap notifications precedence
snmp-server ip precedence VALUE
--------------------------------------------------------------
This example shows the output from the show parser macro name command:
Device# show parser macro name standard-switch10
Macro name : standard-switch10
Macro type : customizable
macro description standard-switch10
# Trust QoS settings on VOIP packets
auto qos voip trust
# Allow port channels to be automatically formed
channel-protocol pagp
This example shows the output from the show parser macro brief command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
292
Interface and Hardware Components
show parser macro
Device# show parser macro brief
default global : cisco-global
default interface: cisco-desktop
default interface: cisco-phone
default interface: cisco-switch
default interface: cisco-router
customizable : snmp
This exampe shows the output from the show parser macro description command:
Device# show parser macro description
Global Macro(s): cisco-global
Interface Macro Description(s)
--------------------------------------------------------------
Gi1/0/1 standard-switch10
Gi1/0/2 this is test macro
--------------------------------------------------------------
This example shows the output from the show parser macro description interface command:
Device# show parser macro description interface gigabitethernet1/0/2
Interface Macro Description
--------------------------------------------------------------
Gi1/0/2 this is test macro
--------------------------------------------------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
293
Interface and Hardware Components
show platform hardware bluetooth
show platform hardware bluetooth
To display information about Bluetooth interface, use the show platform hardware bluetooth command in
privileged EXEC mode.
show platform hardware bluetooth
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines The show platform hardware bluetooth command is to be used when an external USB Bluetooth dongle is
connected on the device.
Examples This example shows how to display the information of the Bluetooth interface using the show
platform hardware bluetooth command.
Device> enable
Device# show platform hardware bluetooth
Controller: 0:1a:7d:da:71:13
Type: Primary
Bus: USB
State: DOWN
Name:
HCI Version:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
294
Interface and Hardware Components
show platform hardware fed switch forward
show platform hardware fed switch forward
To display device-specific hardware information, use the show platform hardware fed switch switch_number
command.
This topic elaborates only the forwarding-specific options, that is, the options available with the show platform
hardware fed switch {switch_num | active | standby } forward summary command.
The output of the show platform hardware fed switch switch_number forward summary displays all the
details about the forwarding decision taken for the packet.
show platform hardware fed switch {switch_num | active | standby} forward summary
Syntax Description switch {switch_num | The switch for which you want to display information. You have the following
active | standby } options :
• switch_num—ID of the switch.
• active—Displays information relating to the active switch.
• standby—Displays information relating to the standby switch, if
available.
forward summary Displays packet forwarding information.
Note Support for the keyword summary has been discontinued in
the Cisco IOS XE Everest 16.6.1 release and later releases.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Everest 16.6.1 and later releases Supprort for the keyword summary
was discontinued.
Usage Guidelines Do not use this command unless a technical support representative asks you to. Use this command only when
you are working directly with a technical support representative while troubleshooting a problem.
Fields displayed in the command output are explained below.
• Station Index : The Station Index is the result of the layer 2 lookup and points to a station descriptor
which provides the following:
• Destination Index : Determines the egress port(s) to which the packets should be sent to. Global
Port Number(GPN) can be used as the destination index. A destination index with15 down to 12
bits set indicates the GPN to be used. For example, destination index - 0xF04E corresponds to GPN
- 78 (0x4e).
• Rewrite Index : Determines what needs to be done with the packets. For layer 2 switching, this is
typically a bridging action
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
295
Interface and Hardware Components
show platform hardware fed switch forward
• Flexible Lookup Pipeline Stages(FPS) : Indicates the forwarding decision that was taken for the
packet - routing or bridging
• Replication Bit Map : Determines if the packets should be sent to CPU or stack
• Local Data Copy = 1
• Remote Data copy = 0
• Local CPU Copy = 0
• Remote CPU Copy = 0
Example
This is an example of output from the show platform hardware fed switch {switch_num | active
| standby } forward summary command.
Device#show platform hardware fed switch 1 forward summary
Time: Fri Sep 16 08:25:00 PDT 2016
Incomming Packet Details:
###[ Ethernet ]###
dst = 00:51:0f:f2:0e:11
src = 00:1d:01:85:ba:22
type = ARP
###[ ARP ]###
hwtype = 0x1
ptype = IPv4
hwlen = 6
plen = 4
op = is-at
hwsrc = 00:1d:01:85:ba:22
psrc = 10.10.1.33
hwdst = 00:51:0f:f2:0e:11
pdst = 10.10.1.1
Ingress:
Switch : 1
Port : GigabitEthernet1/0/1
Global Port Number : 1
Local Port Number : 1
Asic Port Number : 21
ASIC Number : 0
STP state :
blkLrn31to0: 0xffdfffdf
blkFwd31to0: 0xffdfffdf
Vlan : 1
Station Descriptor : 170
DestIndex : 0xF009
DestModIndex : 2
RewriteIndex : 2
Forwarding Decision: FPS 2A L2 Destination
Replication Bitmap:
Local CPU copy : 0
Local Data copy : 1
Remote CPU copy : 0
Remote Data copy : 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
296
Interface and Hardware Components
show platform hardware fed switch forward
Egress:
Switch : 1
Outgoing Port : GigabitEthernet1/0/9
Global Port Number : 9
ASIC Number : 0
Vlan : 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
297
Interface and Hardware Components
show platform hardware fed switch forward interface
show platform hardware fed switch forward interface
To debug forwarding information and to trace the packet path in the hardware forwarding plane, use the show
platform hardware fed switch switch_number forward interface command. This command simulates a
user-defined packet and retrieves the forwarding information from the hardware forwarding plane. A packet
is generated on the ingress port based on the packet parameters that you have specified in this command. You
can also provide a complete packet from the captured packets stored in a PCAP file.
This topic elaborates only the interface forwarding-specific options, that is, the options available with the
show platform hardware fed switch {switch_num | active | standby } forward interface command.
show platform hardware fed switch {switch_num | active | standby} forward interface interface-type
interface-number source-mac-address destination-mac-address{protocol-number | arp | cos | ipv4 | ipv6
| mpls}
show platform hardware fed switch {switch_num | active | standby} forward interface interface-type
interface-number pcap pcap-file-name number packet-number data
show platform hardware fed switch {switch_num | active | standby} forward interface interface-type
interface-number vlan vlan-id source-mac-address destination-mac-address{protocol-number | arp |
cos | ipv4 | ipv6 | mpls}
Syntax Description switch {switch_num | active The switch on which packet tracing has to be scheduled. The input port
| standby } should be available on this switch. You have the following options :
• switch_num—ID of the switch on which the ingress port is present.
• active—indicates the active switch on which the the ingress port is
present.
• standby—indicates the standby switch on which the ingress port is
present.
Note This keyword is not supported.
interface interface-type The input interface on which packet trace is simulated.
interface-number
source-mac-address The source MAC address of the packet you want to simulate.
destination-mac-address The MAC address of the destination interface in hexadecimal format.
protocol-number The number assigned to any L3 protocol.
arp The Address Resolution Protocol (ARP) parameters.
ipv4 The IPv4 packet parameters.
ipv6 The IPv6 packet parameters.
mpls The Multiprotocol Label Switching (MPLS) label parameters.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
298
Interface and Hardware Components
show platform hardware fed switch forward interface
cos The class of service (CoS) number from 0 to 7 to set priority.
pcap pcap-file-name Name of the pcap file in internal flash (flash:).
Ensure that the file already exists in flash:.
number packet-number Specifies the packet number in the pcap file.
vlan vlan-id VLAN id of the dot1q header in the simulated packet. The range is 1 to
4096.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Fuji 16.9.1 The command was enhanced to
support MPLS/ARP/VxLAN
packet parameters and trace packets
captured in a PCAP file.
Cisco IOS XE Gibraltar 16.10.1 The command was enhanced to
support data capture across a stack.
Usage Guidelines Do not use this command unless a technical support representative asks you to. Use this command only when
you are working directly with a technical support representative while troubleshooting a problem.
This command supports the following packet types:
• Non-IP packets with any L3 protocol
• ARP packets
• IPv4 packets with any L4 protocol
• IPv4 packets with TCP/UDP/IGMP/ICMP/SCTP payload
• VxLAN packets
• MPLS packets with up to 3 Labels and meta data
• MPLS packets with IPv4/IPv6 payload
• IPv6 packets with TCP/UDP/IGMP/ICMP/SCTP payload
In a stack environment, you can trace packets across the stack irrespective of the number of stack members
and topology. The show platform hardware fed switch switch-number forward interface interface-type
interface-number command consolidates packet-forwarding information of all the stack members on the
ingress switch. To achieve this, ensure that the switch number specified in the switch_num and interface-number
arguments are of the input switch and that the number matches.
To trace any particular packet from the captured packets stored in a PCAP file, use the show platform
hardware fed switch forward interface interface-type interface-number pcap pcap-file-name number
packet-number data command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
299
Interface and Hardware Components
show platform hardware fed switch forward interface
Example
This is an example of output from the show platform hardware fed switch {switch_num | active
| standby } forward interface command.
Device#show platform hardware fed switch active forward interface gigabitEthernet 1/0/35
0000.0022.0055 0000.0055.0066 ipv4 44.44.0.2 55.55.0.2 udp 1222 3333
Show forward is running in the background. After completion, syslog will be generated.
*Sep 24 05:57:36.614: %SHFWD-6-PACKET_TRACE_DONE: Switch 1 R0/0: fed: Packet Trace Complete:
Execute (show platform hardware fed switch <> forward last summary|detail)
*Sep 24 05:57:36.614: %SHFWD-6-PACKET_TRACE_FLOW_ID: Switch 1 R0/0: fed: Packet Trace Flow
id is 150323855361
Related Commands Command Description
monitor capture interface Configures monitor capture points specifying an
attachment point and the packet flow direction.
monitor capture start Starts the capture of packet data at a traffic trace point
into a buffer.
monitor capture stop Stops the capture of packet data at a traffic trace point.
monitor capture export Saves the captured packets in the buffer.
Use this command to export the monitor capture buffer
to a pcap file in flash: that you can use as an input in
the show forward with pcap.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
300
Interface and Hardware Components
show platform hardware fed switch forward last summary
show platform hardware fed switch forward last summary
To display a summary of packet tracing data from a switch or switches in a stack, use the show platform
hardware fed switch switch_number forward last summary command.
The output of the show platform hardware fed switch switch_number forward last summary command
displays all the details about the forwarding decision taken for the packet from the last time the show forward
command was run.
show platform hardware fed switch {switch_number | active | standby} forward last summary
Syntax Description switch {switch_number | The switch on which you want to schedule a packet capture for a port. You
active | standby } have the following options :
• switch_num—ID of the switch on which the ingress port is present.
• active—indicates the active switch on which the the ingress port is
present.
• standby—indicates the standby switch on which the ingress port is
present.
Note This keyword is not supported.
forward last summary Displays packet forwarding information.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Everest 16.6.1 and later releases Support for the keyword summary
was discontinued.
Cisco IOS XE Fuji 16.9.1 Support for keywords last and
summary is introduced.
Cisco IOS XE Gibraltar 16.10.1 The output of the command was
enhanced to display the details
about all the copies of the packets
and the corresponding outgoing
ports.
Usage Guidelines Do not use this command unless a technical support representative asks you to. Use this command only when
you are working directly with a technical support representative while troubleshooting a problem.
With Cisco IOS XE Gibraltar 16.10.1, show platform hardware fed switch forward last summary command
is enhanced to:
• Inject the debug packets from the CPU to simulate the incoming port and packets
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
301
Interface and Hardware Components
show platform hardware fed switch forward last summary
• Use the debug packets to trace the packet in hardware data-path to provide forwarding details such as
lookup, adjacency, rewrite information, drop decision, outgoing port and so on
• Drop the original packets at egress so as not to transmit the packet to the outgoing port
• Send a copy of all the packets to the CPU and display the details in the packet tracing output
Example
This is an example of output from the show platform hardware fed switch {switch_number |
active | standby } forward last summary command.
Device#show platform hardware fed switch active forward last summary
Input Packet Details:
###[ Ethernet ]###
dst = 01:00:5e:01:01:02
src = 00:00:00:03:00:05
type = 0x0
###[ Raw ]###
load = '00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00'
Ingress:
Port : GigabitEthernet1/0/11
Global Port Number : 11
Local Port Number : 11
Asic Port Number : 10
Asic Instance : 1
Vlan : 20
Mapped Vlan ID : 6
STP Instance : 4
BlockForward : 0
BlockLearn : 0
L3 Interface : 39
IPv4 Routing : enabled
IPv6 Routing : enabled
Vrf Id : 0
Adjacency:
Station Index : 3 [SI_DIET_L2]
Destination Index : 18
Rewrite Index : 2
Replication Bit Map : 0x15 ['localData', 'remoteData', 'coreData']
Decision:
Destination Index : 24 [DI_DIET_L2]
Rewrite Index : 2 [RI_L2]
Dest Mod Index : 9 [DMI_IGMP_CTRL_Q]
CPU Map Index : 0 [CMI_NULL]
Forwarding Mode : 0 [Bridging]
Replication Bit Map : ['localData', 'remoteData', 'coreData']
Winner : L2DESTMACVLAN LOOKUP
Qos Label : 65
SGT : 0
DGTID : 0
Egress:
Possible Replication :
Port : GigabitEthernet1/0/11
Port : GigabitEthernet1/0/22
Port : GigabitEthernet2/0/1
Output Port Data :
Port : GigabitEthernet1/0/22
Global Port Number : 22
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
302
Interface and Hardware Components
show platform hardware fed switch forward last summary
Local Port Number : 22
Asic Port Number : 21
Asic Instance : 0
Unique RI : 2
Rewrite Type : 1 [L2_BRIDGE]
Mapped Rewrite Type : 1 [L2_BRIDGE]
Vlan : 20
Mapped Vlan ID : 6
Port : GigabitEthernet2/0/1
Global Port Number : 97
Local Port Number : 1
Asic Port Number : 0
Asic Instance : 1
Unique RI : 2
Rewrite Type : 1 [L2_BRIDGE]
Mapped Rewrite Type : 1 [L2_BRIDGE]
Vlan : 20
Mapped Vlan ID : 6
Output Packet Details:
Port : GigabitEthernet1/0/22
###[ Ethernet ]###
dst = 01:00:5e:01:01:02
src = 00:00:00:03:00:05
type = 0x0
###[ Raw ]###
load = '00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00'
Port : GigabitEthernet2/0/1
###[ Ethernet ]###
dst = 01:00:5e:01:01:02
src = 00:00:00:03:00:05
type = 0x0
###[ Raw ]###
load = '00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00'
********************************************************************************
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
303
Interface and Hardware Components
show platform hardware fed switch fwd-asic counters tla
show platform hardware fed switch fwd-asic counters tla
To display the register information of a counter from the forwarding ASIC, use the show platform hardware
fed switch fwd-asic counters tla command in the Privileged EXEC mode.
show platform hardware fed switch {switch_num | active | standby} fwd-asic counters tla
tla_counter{detail | drop | statistics}[asic asic_num]output location:filename
Syntax Description switch {switch_num The switch for which you want to display information. You have the following
| active | standby options :
}
• switch_num: ID of the switch.
• active: Displays information relating to the active switch.
• standby: Displays information relating to the standby switch, if available.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
304
Interface and Hardware Components
show platform hardware fed switch fwd-asic counters tla
tlatla_counter tla_counter can be any of the following Three Letter Acronym (TLA) counters:
• AQM Active Queue Management
• ASE ACL Search Engine
• DPP DopplerE Point to Point
• EGR Egress Global Resolution
• EPF Egress Port FIFO
• ESM Egress Scheduler Module
• EQC Egress Queue Controller
• FPE Flexible Parser
• FPS Flexible Pipe Stage
• FSE Fib Search Engine
• IGR Ingress Global Resolution
• IPF Ingress Port FIFO
• IQS Ingress Queues and Scheduler
• MSC Macsec Engine
• NFL Netflow
• NIF Network Interface
• PBC Packet Buffer Complex
• PIM Protocol Independent Multicast
• PLC Policer
• RMU Recirculation Multiplexer Unit
• RRE Reassembly Engine
• RWE Rewrite Engine
• SEC Security Engine
• SIF Stack Interface
• SPQ Supervisor Packet Queuing Engine
• SQS Stack Queues And Scheduler
• SUP Supervisor Interface
detail Displays the contents of the registers of all non-zero counters.
drop Displays the contents of the registers of all non-zero drop counters.
statistics Displays the contents of the registers of all non-zero statistical counters.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
305
Interface and Hardware Components
show platform hardware fed switch fwd-asic counters tla
asci asic_num (Optional) Specifies the ASIC.
output Specifies an output file to which the contents of the counters registers are to be
location:filename dumped.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Amsterdam 17.3.1 The command output was modified
to be presented in a readable tabular
format. The size of the output file
was also reduced by not printing
fields that had zero values.
The change keyword was
deprecated.
Usage Guidelines Do not use this command unless a technical support representative asks you to. Use this command only when
you are working directly with a technical support representative while troubleshooting a problem.
Note Some TLAs may not have any registers to display as part of drop or statistics options because of the lack of
these drop or statistics registers for them. In such a case, a message, No <detail|drop|statistics>
counters to display for tla <TLA_NAME> is displayed and no output file is generated.
Example
This is an example output from the show platform hardware fed active fwd-asic counters tla aqm
command.
Device#show platform hardware fed active fwd-asic counters tla aqm detail output flash:aqm
command to get counters for tla AQM succeeded
Device#
Device# more flash:aqm
=============================================================================================
asic | core | Register Name | Fields | value
=============================================================================================
0 0 AqmRepTransitUsageCnt[0][0]
totalCntHighMark : 0x4
transitWait4DoneHighMark : 0x2
0 1 AqmRepTransitUsageCnt[0][0]
totalCntHighMark : 0x2
transitWait4DoneHighMark : 0x2
=============================================================================================
asic | core | Register Name | Fields | value
============================================================================================
0 0 AqmGlobalHardBufCnt[0][0]
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
306
Interface and Hardware Components
show platform hardware fed switch fwd-asic counters tla
highWaterMark : 0x3
=============================================================================================
asic | core | Register Name | Fields | value
=============================================================================================
0 0 AqmRedQueueStats[0][673]
acceptByteCnt2 : 0x4e44e
acceptFrameCnt2 : 0x5e1
0 0 AqmRedQueueStats[0][674]
acceptByteCnt1 : 0x88
acceptByteCnt2 : 0xa7c
acceptFrameCnt1 : 0x2
acceptFrameCnt2 : 0x16
0 0 AqmRedQueueStats[0][676]
acceptByteCnt2 : 0xfbf06
acceptFrameCnt2 : 0x2440
0 0 AqmRedQueueStats[0][677]
acceptByteCnt2 : 0xcc
acceptFrameCnt2 : 0x3
0 0 AqmRedQueueStats[0][687]
acceptByteCnt2 : 0x2caea0
acceptFrameCnt2 : 0xa836
0 0 AqmRedQueueStats[0][691]
acceptByteCnt2 : 0x2dc
acceptFrameCnt2 : 0x6
0 0 AqmRedQueueStats[0][692]
acceptByteCnt2 : 0xc518
acceptFrameCnt2 : 0x2e6
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
307
Interface and Hardware Components
show platform hardware fed active fwd-asic resource tcam utilization
show platform hardware fed active fwd-asic resource tcam
utilization
To display hardware information about the Ternary Content Addressable Memory (TCAM) usage, use the
show platform hardware fed active fwd-asic resource tcam utilization command in privileged EXEC
mode.
show platform hardware fed active fwd-asic resource tcam utilization[{asic-number }]
Syntax Description asic-number ASIC number. Valid values are from
0 to 7.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced in a release prior to Cisco
IOS XE Amsterdam 17.2.1 .
Usage Guidelines On stackable switches, this command has the switch keyword, show platform hardware fed switch active
fwd-asic resource tcam utilization. On non-stackable switches, the switch keyword is not available.
Example
The following is sample output from the show platform hardware fed active fwd-asic resource
tcam utilization command:
Device# show platform hardware fed active fwd-asic resource tcam utilization
Codes: EM - Exact_Match, I - Input, O - Output, IO - Input & Output, NA - Not Applicable
CAM Utilization for ASIC [0]
Table Subtype Dir Max Used %Used V4 V6
MPLS Other
------------------------------------------------------------------------------------------------------
OPENFLOW Table0 TCAM I 5000 5 0% 3 0
0 2
OPENFLOW Table0 Ext. EM I 8192 3 0% 0 0
0 3
OPENFLOW Table1 TCAM I 3600 1 0% 1 0
0 0
OPENFLOW Table1 Ext. EM I 8192 1 0% 0 0
0 1
OPENFLOW Table2 TCAM I 3500 1 0% 1 0
0 0
OPENFLOW Table2 Ext. EM I 8192 1 0% 0 0
0 1
OPENFLOW Table3 Ext. EM I 8192 0 0% 0 0
0 0
OPENFLOW Table4 Ext. EM I 8192 0 0% 0 0
0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
308
Interface and Hardware Components
show platform hardware fed active fwd-asic resource tcam utilization
OPENFLOW Table5 Ext. EM I 8192 0 0% 0 0
0 0
OPENFLOW Table6 Ext. EM I 8192 0 0% 0 0
0 0
OPENFLOW Table7 Ext. EM I 8192 0 0% 0 0
0 0
The table below lists the significant fields shown in the display.
Table 19: show platform hardware fed active fwd-asic resource tcam utilization Field Descriptions
Field Description
Table OpenFlow table numbers.
Subtype What are the different subtypes available?
Dir
Max
Used
%Used
V4
V6
MPLS
Other
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
309
Interface and Hardware Components
show platform resources
show platform resources
To display platform resource information, use the show platform reources command in privileged EXEC
mode.
show platform resources
This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The output of this command displays the used memory, which is total memory minus the accurate free memory.
Example
The following is sample output from the show platform resources command:
Switch# show platform resources
**State Acronym: H - Healthy, W - Warning, C - Critical
Resource Usage Max Warning Critical
State
----------------------------------------------------------------------------------------------------
Control Processor 7.20% 100% 90% 95%
H
DRAM 2701MB(69%) 3883MB 90% 95%
H
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
310
Interface and Hardware Components
show platform software audit
show platform software audit
To display the SE Linux Audit logs, use the show platform software audit command in privileged EXEC
mode.
show platform software audit {all | summary | [switch {switch-number | active | standby}]
{0 | F0 | R0 | {FP | RP} {active}}}
Syntax Description all Shows the audit log from all the slots.
summary Shows the audit log summary count from all the slots.
switch Shows the audit logs for a slot on a specific switch.
switch-number Selects the switch with the specified switch number.
switch active Selects the active instance of the switch.
standby Selects the standby instance of the switch.
0 Shows the audit log for the SPA-Inter-Processor slot
0.
F0 Shows the audit log for the
Embedded-Service-Processor slot 0.
R0 Shows the audit log for the Route-Processor slot 0.
FP active Shows the audit log for the active
Embedded-Service-Processor slot.
RP active Shows the audit log for the active Route-Processor
slot.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines This command was introduced in the Cisco IOS XE Gibraltar 16.10.1 as a part of the SELinux Permissive
Mode feature. The show platform software audit command displays the system logs containing the access
violation events.
In Cisco IOS XE Gibraltar 16.10.1, operation in a permissive mode is available - with the intent of confining
specific components (process or application) of the IOS-XE platform. In the permissive mode, access violation
events are detected and system logs are generated, but the event or operation itself is not blocked. The solution
operates mainly in an access violation detection mode.
The following is a sample output of the show software platform software audit summary command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
311
Interface and Hardware Components
show platform software audit
Device# show platform software audit summary
===================================
AUDIT LOG ON switch 1
-----------------------------------
AVC Denial count: 58
===================================
The following is a sample output of the show software platform software audit all command:
Device# show platform software audit all
===================================
AUDIT LOG ON switch 1
-----------------------------------
========== START ============
type=AVC msg=audit(1539222292.584:100): avc: denied { read } for pid=14017
comm="mcp_trace_filte" name="crashinfo" dev="rootfs" ino=13667
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_disk_crashinfo_t:s0 tclass=lnk_file permissive=1
type=AVC msg=audit(1539222292.584:100): avc: denied { getattr } for pid=14017
comm="mcp_trace_filte" path="/mnt/sd1" dev="sda1" ino=2
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_disk_crashinfo_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539222292.586:101): avc: denied { getattr } for pid=14028 comm="ls"
path="/tmp/ufs/crashinfo" dev="tmpfs" ino=58407
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_ncd_tmp_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539222292.586:102): avc: denied { read } for pid=14028 comm="ls"
name="crashinfo" dev="tmpfs" ino=58407 scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_ncd_tmp_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539438600.896:119): avc: denied { execute } for pid=8300 comm="sh"
name="id" dev="loop0" ino=6982 scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:bin_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438600.897:120): avc: denied { execute_no_trans } for pid=8300
comm="sh"
path="/tmp/sw/mount/cat9k-rpbase.2018-10-02_00.13_mhungund.SSA.pkg/nyquist/usr/bin/id"
dev="loop0" ino=6982 scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:bin_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438615.535:121): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539438624.916:122): avc: denied { execute_no_trans } for pid=8600
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438648.936:123): avc: denied { execute_no_trans } for pid=9307
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438678.649:124): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539438696.969:125): avc: denied { execute_no_trans } for pid=10057
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438732.973:126): avc: denied { execute_no_trans } for pid=10858
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438778.008:127): avc: denied { execute_no_trans } for pid=11579
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
312
Interface and Hardware Components
show platform software audit
type=AVC msg=audit(1539438800.156:128): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539438834.099:129): avc: denied { execute_no_trans } for pid=12451
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539440246.697:149): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539440299.119:150): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
========== END ============
===================================
The following is a sample output of the show software platform software audit switch command:
Device# show platform software audit switch active R0
========== START ============
type=AVC msg=audit(1539222292.584:100): avc: denied { read } for pid=14017
comm="mcp_trace_filte" name="crashinfo" dev="rootfs" ino=13667
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_disk_crashinfo_t:s0 tclass=lnk_file permissive=1
type=AVC msg=audit(1539222292.584:100): avc: denied { getattr } for pid=14017
comm="mcp_trace_filte" path="/mnt/sd1" dev="sda1" ino=2
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_disk_crashinfo_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539222292.586:101): avc: denied { getattr } for pid=14028 comm="ls"
path="/tmp/ufs/crashinfo" dev="tmpfs" ino=58407
scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_ncd_tmp_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539222292.586:102): avc: denied { read } for pid=14028 comm="ls"
name="crashinfo" dev="tmpfs" ino=58407 scontext=system_u:system_r:polaris_trace_filter_t:s0
tcontext=system_u:object_r:polaris_ncd_tmp_t:s0 tclass=dir permissive=1
type=AVC msg=audit(1539438624.916:122): avc: denied { execute_no_trans } for pid=8600
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438648.936:123): avc: denied { execute_no_trans } for pid=9307
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438678.649:124): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539438696.969:125): avc: denied { execute_no_trans } for pid=10057
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438732.973:126): avc: denied { execute_no_trans } for pid=10858
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438778.008:127): avc: denied { execute_no_trans } for pid=11579
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438800.156:128): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
type=AVC msg=audit(1539438834.099:129): avc: denied { execute_no_trans } for pid=12451
comm="auto_upgrade_se" path="/bin/bash" dev="rootfs" ino=7276
scontext=system_u:system_r:polaris_auto_upgrade_server_rp_t:s0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
313
Interface and Hardware Components
show platform software audit
tcontext=system_u:object_r:shell_exec_t:s0 tclass=file permissive=1
type=AVC msg=audit(1539438860.907:130): avc: denied { name_connect } for pid=26421
comm="nginx" dest=8098 scontext=system_u:system_r:polaris_nginx_t:s0
tcontext=system_u:object_r:polaris_caf_api_port_t:s0 tclass=tcp_socket permissive=1
========== END ============
===================================
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
314
Interface and Hardware Components
show platform software fed switch punt cpuq rates
show platform software fed switch punt cpuq rates
To display the rate at which packets are punted, including the drops in the punted path, use the show platform
software fed switch punt cpuq rates command in privileged EXEC mode.
show platform software fed switch {switch-number | active | standby} punt cpuq rates
Syntax Description switch{switch-number | active | standby} Displays information about the switch. You have
the following options:
• switch-number.
• active —Displays information relating to the
active switch.
• standby—Displays information relating to
the standby switch, if available.
Note This keyword is not supported.
punt Specifies the punt informtion.
cpuq Specifies information about CPU receive queue.
rates Specifies the rate at which the packets are punted.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Example
The following is sample output from the show platform software fed switch active punt cpuq
rates command.
The output of this command displays the rate in packets per second at intervals of 10 seconds, 1
minute and 5 minutes.
Device#show platform software fed switch active punt cpuq rates
Punt Rate CPU Q Statistics
Packets per second averaged over 10 seconds, 1 min and 5 mins
======================================================================================
Q | Queue | Rx | Rx | Rx | Drop | Drop | Drop
no | Name | 10s | 1min | 5min | 10s | 1min | 5min
======================================================================================
0 CPU_Q_DOT1X_AUTH 0 0 0 0 0 0
1 CPU_Q_L2_CONTROL 0 0 0 0 0 0
2 CPU_Q_FORUS_TRAFFIC 336 266 320 0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
315
Interface and Hardware Components
show platform software fed switch punt cpuq rates
3 CPU_Q_ICMP_GEN 0 0 0 0 0 0
4 CPU_Q_ROUTING_CONTROL 0 0 0 0 0 0
5 CPU_Q_FORUS_ADDR_RESOLUTION 0 0 0 0 0 0
6 CPU_Q_ICMP_REDIRECT 0 0 0 0 0 0
7 CPU_Q_INTER_FED_TRAFFIC 0 0 0 0 0 0
8 CPU_Q_L2LVX_CONTROL_PKT 0 0 0 0 0 0
9 CPU_Q_EWLC_CONTROL 0 0 0 0 0 0
10 CPU_Q_EWLC_DATA 0 0 0 0 0 0
11 CPU_Q_L2LVX_DATA_PKT 0 0 0 0 0 0
12 CPU_Q_BROADCAST 0 0 0 0 0 0
13 CPU_Q_LEARNING_CACHE_OVFL 0 0 0 0 0 0
14 CPU_Q_SW_FORWARDING 0 0 0 0 0 0
15 CPU_Q_TOPOLOGY_CONTROL 0 0 0 0 0 0
16 CPU_Q_PROTO_SNOOPING 0 0 0 0 0 0
17 CPU_Q_DHCP_SNOOPING 0 0 0 0 0 0
18 CPU_Q_TRANSIT_TRAFFIC 0 0 0 0 0 0
19 CPU_Q_RPF_FAILED 0 0 0 0 0 0
20 CPU_Q_MCAST_END_STATION_SERVICE 0 0 0 0 0 0
21 CPU_Q_LOGGING 0 0 0 0 0 0
22 CPU_Q_PUNT_WEBAUTH 0 0 0 0 0 0
23 CPU_Q_HIGH_RATE_APP 0 0 0 0 0 0
24 CPU_Q_EXCEPTION 0 0 0 0 0 0
25 CPU_Q_SYSTEM_CRITICAL 0 0 0 0 0 0
26 CPU_Q_NFL_SAMPLED_DATA 0 0 0 0 0 0
27 CPU_Q_LOW_LATENCY 0 0 0 0 0 0
28 CPU_Q_EGR_EXCEPTION 0 0 0 0 0 0
29 CPU_Q_FSS 0 0 0 0 0 0
30 CPU_Q_MCAST_DATA 0 0 0 0 0 0
31 CPU_Q_GOLD_PKT 0 0 0 0 0 0
-------------------------------------------------------------------------------------
The table below describes the significant fields shown in the display.
Table 20: show platform software fed switch active punt cpuq rates Field Descriptions
Field Description
Queue Name of the queue.
Name
Rx The rate at which the packets are received per second in 10s, 1 minute and 5 minutes.
Drop The rate at which the packets are dropped per second in 10s, 1 minute and 5 minutes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
316
Interface and Hardware Components
show platform software fed switch punt packet-capture display
show platform software fed switch punt packet-capture display
To display packet capture information during high CPU utilization, use the show platform software fed
switch active punt packet-capture display command in privileged EXEC mode.
show platform software fed switch active punt packet-capture display { detailed | hexdump}
Syntax Description switch{switch-number|active|standby} Displays information about a switch. You have
the following options:
• active —Displays information relating to the
active switch.
• standby—Displays information relating to
the standby switch, if available.
Note The standby keyword is not
supported.
punt Specifies punt information.
packet-capture display Specifies information about the captured packet.
detailed Specifies detailed information about the captured
packet.
hex-dump Specifies information about the captured packet,
in hex format.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The output of this command displays the periodic and persistent logs of CPU-bound packets, inband CPU
traffic rates, and running CPU processes when the CPU passes a high CPU utilization threshold.
Examples The following is a sample output from the show platform software fed switch active punt
packet-capture display detailed command:
Device# show platform software fed switch active punt packet-capture display detailed
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 101 packets. Capture capacity : 4096 packets
------ Packet Number: 1, Timestamp: 2018/09/04 23:22:10.179 ------
interface : GigabitEthernet2/0/2 [if-id: 0x00000032] (physical)
ether hdr : dest mac: 0100.0ccc.cccd, src mac: 2c36.f8fc.4884
ether hdr : ethertype: 0x0032
Doppler Frame Descriptor :
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
317
Interface and Hardware Components
show platform software fed switch punt packet-capture display
0000000044004E04 C00F402D94510000 0000000000000100 0000400401000000
0000000001000050 000000006D000100 0000000025836200 0000000000000000
Packet Data Dump (length: 68 bytes) :
01000CCCCCCD2C36 F8FC48840032AAAA 0300000C010B0000 00000080012C36F8
FC48800000000080 012C36F8FC488080 040000140002000F 0071000000020001
244E733E
------ Packet Number: 2, Timestamp: 2018/09/04 23:22:10.179 ------
interface : GigabitEthernet2/0/2 [if-id: 0x00000032] (physical)
ether hdr : dest mac: 0180.c200.0000, src mac: 2c36.f8fc.4884
ether hdr : ethertype: 0x0026
!
!
!
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
318
Interface and Hardware Components
show platform software fed switch punt packet-capture cpu-top-talker
show platform software fed switch punt packet-capture
cpu-top-talker
To display the occurrences of an attribute of a packet capture, use the show platform softwarefed switch
punt packet-capture cpu-top-talker command in privileged EXEC mode.
show platform software fed switch { switch number | active | standby } punt packet-capture
cpu-top-talker { cause-code | dst_ipv4 | dst_ipv6 | dst_l4 | dst_mac | eth_type | incoming-interface
| ipv6_hoplt | protocol | src_dst_port | src_ipv4 | src_ipv6 | src_l4 | src_mac | summary | ttl |
vlan }
Syntax Description switch{switch-number|active|standby} Displays information about a switch. You have the following
options:
• active —Displays information relating to the active switch.
• standby—Displays information relating to the standby
switch, if available.
Note The standbykeyword is not supported.
Note The switchkeyword is not supported on nonstackable
devices and on the devices that do not support
StackWise Virtual.
cause-code Displays the occurrences of cause-code.
dst_ipv4 Displays the occurrences on the destination IPv4 interface.
dst_ipv6 Displays the occurrences on the destination IPv6 interface.
dst_l4 Displays the occurrences of the Layer 4 destination port.
dst_mac Displays the occurrences of the destination MAC address.
eth_type Displays the occurrences of the Ethernet frame type.
incoming-interface Displays the occurrences of incoming-interfaces.
ipv6_hoplt Displays the occurrences of the hop limit on IPv6.
protocol Displays the occurrences of the Layer 4 protocol.
src_dst_port Displays the occurrences of the Layer 4 source destination port.
src_ipv4 Displays the occurrences on the source IPv4 interface.
src_ipv6 Displays the occurrences on the source IPv6 interface.
src_l4 Displays the occurrences on the Layer 4 source.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
319
Interface and Hardware Components
show platform software fed switch punt packet-capture cpu-top-talker
src_mac Displays the occurrences of the source MAC address.
summary Displays the summary of the occurrences of all the attributes.
ttl Displays the occurrences on IPv4 Time to Live (TTL).
vlan Displays the occurrences of VLAN.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.1 This command was introduced.
Usage Guidelines Ensure to start and stop debugging of the packets from the active switch to obtain the occurrences of the packet
capture attributes.
Examples The following is a sample out of the debugplatform software fed switch active punt packet-capture
startcommand:
Device# debug platform software fed active punt packet-capture start
Punt packet capturing started.
Device#
*Jan 28 12:51:14.978: %FED_PUNJECT-6-PKT_CAPTURE_FULL: F0/0: fed: Punject pkt capture buffer
is full. Use show command to display the punted packets
The following is a sample out of the debugplatform software fed switch active punt packet-capture
stopcommand:
Device# debug platform software fed active punt packet-capture stop
Punt packet capturing stopped. Captured 4096 packet(s)
These commands provide a maximum of ten unique values in descending order for each of the
attributes.
The following is a sample output of the show platform software fed switch active punt
packet-capture cpu-top-talkercause-code command:
Device# show platform software fed switch active punt packet-capture cpu-top-talker cause-code
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 4096 packets. Capture capacity : 4096 packets
Sr.no. Value/Key Occurrence
1 Layer2 control protocols 4096
The following is a sample output of the show platform software fed switch active punt
packet-capture cpu-top-talkerdst_mac command:
Device# show platform software fed switch active punt packet-capture cpu-top-talker dst_mac
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 4096 packets. Capture capacity : 4096 packets
Sr.no. Value/Key Occurrence
1 01:80:c2:00:00:00 4096
The following is a sample output of the show platform software fed switch active punt
packet-capture cpu-top-talkerincoming-interface command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
320
Interface and Hardware Components
show platform software fed switch punt packet-capture cpu-top-talker
Device# show platform software fed switch active punt packet-capture cpu-top-talker
incoming-interface
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 4096 packets. Capture capacity : 4096 packets
Sr.no. Value/Key Occurrence
1 TwentyFiveGigE1/0/1 1366
2 TwentyFiveGigE1/0/16 1365
3 TwentyFiveGigE1/0/18 1365
The following is a sample output of the show platform software fed switch activepunt
packet-capture cpu-top-talkersrc_mac command:
Device# show platform software fed switch active punt packet-capture cpu-top-talker src_mac
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 4096 packets. Capture capacity : 4096 packets
Sr.no. Value/Key Occurrence
1 70:b3:17:1e:9e:8f 1366
2 70:b3:17:1e:9e:90 1365
3 70:b3:17:1e:9e:91 1365
The following is a sample output of the show platform software fed switch activepunt
packet-capture cpu-top-talkersummary command. This command will provide one highest output
for each of the attributes.
Device# show platform software fed switch active punt packet-capture cpu-top-talker summary
Punt packet capturing: disabled. Buffer wrapping: disabled
Total captured so far: 4096 packets. Capture capacity : 4096 packets
L2 Top Talkers:
1366 Source mac 70:b3:17:1e:9e:8f
4096 Dest mac 01:80:c2:00:00:00
L3 Top Talkers:
L4 Top Talkers:
Internal Top Talkers:
1366 Interface TwentyFiveGigE1/0/1
4096 CPU Queue Layer2 control protocols
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
321
Interface and Hardware Components
show platform software fed switch punt rates interfaces
show platform software fed switch punt rates interfaces
To display the overall statistics of punt rate for all the interfaces, use the show platform software fed switch
punt rates interfaces command in privileged EXEC mode.
show platform software fed switch {switch-number | active | standby} punt rates
interfaces[interface-id]
Syntax Description switch{switch-number|active|standby} Displays information about the switch. You have
the following options:
• switch-number.
• active —Displays information relating to the
active switch.
• standby—Displays information relating to
the standby switch, if available.
Note This keyword is not supported.
punt Specifies the punt informtion.
rates Specifies the rate at which the packets are punted.
interfaces[interface-id] (Optional) Displays the overall statistics for an
interface and also the per-queue configuration for
the interface at an interval of 10 seconds.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The output displays the punt rates in packets per second at intervals of 10 seconds, 1 minute and 5 minutes.
Example
The following is sample output from the show platform software fed switch active punt rates
interfaces command for all the interfaces.
Device#show plataform software fed switch active punt rates interfaces
Punt Rate on Interfaces Statistics
Packets per second averaged over 10 seconds, 1 min and 5 mins
===========================================================================================
| | Rx | Rx | Rx | Drop | Drop | Drop
Interface Name | IF_ID | 10s | 1min | 5min | 10s | 1min | 5min
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
322
Interface and Hardware Components
show platform software fed switch punt rates interfaces
===========================================================================================
Vlan3 0x00000034 1000 1000 520 0 0 0
-------------------------------------------------------------------------------------------
The table below describes the significant fields shown in the display.
Table 21: show platform software fed switch active punt rates interfaces Field Descriptions
Field Description
Interface Name of the physical interface.
Name
IF_ID ID of the physical interface.
Rx The per second rate at which the packets are received in 10s, 1 minute and 5 minutes.
Drop The per second rate at which the packets are dropped in 10s, 1 minute and 5 minutes.
The following is sample output from the show platform software fed switch active punt rates
interfaces interface-id command for a specific interface.
Device#show platform software fed switch active punt rates interfaces 0x31
Punt Rate on Single Interfaces Statistics
Interface : Port-channel1 [if_id: 0x31]
Received Dropped
-------- -------
Total : 29617 Total : 0
10 sec average : 0 10 sec average : 0
1 min average : 0 1 min average : 0
5 min average : 0 5 min average : 0
Per CPUQ punt stats on the interface (rate averaged over 10s interval)
==========================================================================
Q | Queue | Recv | Recv | Drop | Drop |
no | Name | Total | Rate | Total | Rate |
==========================================================================
0 CPU_Q_DOT1X_AUTH 0 0 0 0
1 CPU_Q_L2_CONTROL 29519 0 0 0
2 CPU_Q_FORUS_TRAFFIC 0 0 0 0
3 CPU_Q_ICMP_GEN 0 0 0 0
4 CPU_Q_ROUTING_CONTROL 0 0 0 0
5 CPU_Q_FORUS_ADDR_RESOLUTION 0 0 0 0
6 CPU_Q_ICMP_REDIRECT 0 0 0 0
7 CPU_Q_INTER_FED_TRAFFIC 0 0 0 0
8 CPU_Q_L2LVX_CONTROL_PKT 0 0 0 0
9 CPU_Q_EWLC_CONTROL 0 0 0 0
10 CPU_Q_EWLC_DATA 0 0 0 0
11 CPU_Q_L2LVX_DATA_PKT 0 0 0 0
12 CPU_Q_BROADCAST 0 0 0 0
13 CPU_Q_LEARNING_CACHE_OVFL 0 0 0 0
14 CPU_Q_SW_FORWARDING 0 0 0 0
15 CPU_Q_TOPOLOGY_CONTROL 98 0 0 0
16 CPU_Q_PROTO_SNOOPING 0 0 0 0
17 CPU_Q_DHCP_SNOOPING 0 0 0 0
18 CPU_Q_TRANSIT_TRAFFIC 0 0 0 0
19 CPU_Q_RPF_FAILED 0 0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
323
Interface and Hardware Components
show platform software fed switch punt rates interfaces
20 CPU_Q_MCAST_END_STATION_SERVICE 0 0 0 0
21 CPU_Q_LOGGING 0 0 0 0
22 CPU_Q_PUNT_WEBAUTH 0 0 0 0
23 CPU_Q_HIGH_RATE_APP 0 0 0 0
24 CPU_Q_EXCEPTION 0 0 0 0
25 CPU_Q_SYSTEM_CRITICAL 0 0 0 0
26 CPU_Q_NFL_SAMPLED_DATA 0 0 0 0
27 CPU_Q_LOW_LATENCY 0 0 0 0
28 CPU_Q_EGR_EXCEPTION 0 0 0 0
29 CPU_Q_FSS 0 0 0 0
30 CPU_Q_MCAST_DATA 0 0 0 0
31 CPU_Q_GOLD_PKT 0 0 0 0
--------------------------------------------------------------------------
The table below describes the significant fields shown in the display.
Table 22: show platform software fed switch punt rates interfaces interface-id Field Descriptions
Field Description
Queue Name of the queue.
Name
Recv Total Total number of packets received.
Recv Rate Per second rate at which the packets are received.
Drop Total Total number of packets dropped.
Drop Rate Per second rate at which the packets are dropped.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
324
Interface and Hardware Components
show platform software ilpower
show platform software ilpower
To display the inline power details of all the PoE ports on the device, use the show platform software ilpower
command in privileged EXEC mode.
show platform software ilpower {details | port {GigabitEthernet interface-number } | system
slot-number }
Syntax Description details Displays inline power details for all the interfaces.
port Displays inline power port configuration.
GigabitEthernet interface-number The GigabitEthernet interface number. Values range from 0 to 9.
system slot-number Displays inline power system configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a The command was introduced.
Examples The following is sample output from the show platform software ilpower details command:
Device# show platform software ilpower details
ILP Port Configuration for interface Gi1/0/1
Initialization Done: Yes
ILP Supported: Yes
ILP Enabled: Yes
POST: Yes
Detect On: No
Powered Device Detected No
Powered Device Class Done No
Cisco Powered Device: No
Power is On: No
Power Denied: No
Powered Device Type: Null
Powerd Device Class: Null
Power State: NULL
Current State: NGWC_ILP_DETECTING_S
Previous State: NGWC_ILP_SHUT_OFF_S
Requested Power in milli watts: 0
Short Circuit Detected: 0
Short Circuit Count: 0
Cisco Powerd Device Detect Count: 0
Spare Pair mode: 0
IEEE Detect: Stopped
IEEE Short: Stopped
Link Down: Stopped
Voltage sense: Stopped
Spare Pair Architecture: 1
Signal Pair Power allocation in milli watts: 0
Spare Pair Power On: 0
Powered Device power state: 0
Timer:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
325
Interface and Hardware Components
show platform software ilpower
Power Good: Stopped
Power Denied: Stopped
Cisco Powered Device Detect: Stopped
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
326
Interface and Hardware Components
show platform software memory
show platform software memory
To display memory information for a specified switch, use the show platform software memory command
in privileged EXEC mode.
show platform software memory [{chunk | database | messaging}] process slot
Syntax Description
Syntax Description chunk (Optional) Displays chunk memory information for the specified process.
database (Optional) Displays database memory information for the specified process.
messaging (Optional) Displays messaging memory information for the specified process.
The information displayed is for internal debugging purposes only.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
327
Interface and Hardware Components
show platform software memory
process
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
328
Interface and Hardware Components
show platform software memory
Level that is being set. Options include:
• bt-logger—The Binary-Tracing Logger process.
• btrace-manager—The Btrace Manager process.
• chassis-manager—The Chassis Manager process.
• cli-agent—The CLI Agent process.
• cmm—The CMM process.
• dbm—The Database Manager process.
• dmiauthd—The DMI Authentication Daemon process.
• emd—The Environmental Monitoring process.
• fed—The Forwarding Engine Driver process.
• forwarding-manager—The Forwarding Manager process.
• geo—The Geo Manager process.
• gnmi—The GNMI process.
• host-manager—The Host Manager process.
• interface-manager—The Interface Manager process.
• iomd—The Input/Output Module daemon (IOMd) process.
• ios—The IOS process.
• iox-manager—The IOx Manager process.
• license-manager—The License Manager process.
• logger—The Logging Manager process.
• mdt-pubd—The Model Defined Telemetry Publisher process.
• ndbman—The Netconf DataBase Manager process.
• nesd—The Network Element Synchronizer Daemon process.
• nginx—The Nginx Webserver process.
• nif_mgr—The NIF Manager process.
• platform-mgr—The Platform Manager process.
• pluggable-services—The Pluggable Services process.
• replication-mgr—The Replication Manager process.
• shell-manager—The Shell Manager process.
• sif—The Stack Interface (SIF) Manager process.
• smd—The Session Manager process.
• stack-mgr—The Stack Manager process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
329
Interface and Hardware Components
show platform software memory
• syncfd—The SyncmDaemon process.
• table-manager—The Table Manager Server.
• thread-test—The Multithread Manager process.
• virt-manager—The Virtualization Manager process.
slot Hardware slot where the process for which the level is set, is running. Options
include:
• number—Number of the SIP slot of the hardware module where the level is
set. For instance, if you want to specify the SIP in SIP slot 2 of the switch,
enter 2.
• SIP-slot / SPA-bay—Number of the SIP switch slot and the number of the
shared port adapter (SPA) bay of that SIP. For instance, if you want to specify
the SPA in bay 2 of the SIP in switch slot 3, enter 3/2.
• F0—The Embedded Service Processor slot 0.
• FP active—The active Embedded Service Processor.
• R0—The route processor in slot 0.
• RP active—The active route processor.
• RP standby—The standby route processor.
• switch <number> —The switch, with its number specified.
Command Default No default behavior or values.
Command Modes Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command
The following is a sample output displaying the abbreviated (brief keyword) memory information
for the Forwarding Manager process for Cisco Catalyst 9000 Series ESP slot 0:
Device# show platform software memory forwarding-manager switch 1 fp active brief
module allocated requested allocs frees
------------------------------------------------------------------------------
Summary 5702540 5619788 121888 116716
AOM object 1920374 1920310 4 0
AOM links array 880379 880315 4 0
smc_message 819575 819511 4 0
AOM update state 640380 640316 4 0
dpidb-config 208776 203544 351 24
fman-infra-avl 178016 153680 1521 0
AOM batch 152373 152309 4 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
330
Interface and Hardware Components
show platform software memory
AOM asynchronous conte 128388 128324 4 0
AOM basic data 124824 124760 5 1
eventutil 118939 118299 50 10
AOM tree node 96465 96385 5 0
AOM tree root 72377 72313 4 0
acl 36090 31914 504 243
fman-infra-ipc 35326 24366 115097 114412
AOM uplink update node 32386 32322 4 0
unknown 30528 23808 424 4
uipeer 27232 27152 5 0
fman-infra-qos 26872 24712 164 29
cce-class 19427 15411 251 0
l2 control protocol 15472 12896 325 164
fman-infra-cce 15272 13576 106 0
smc_channel 15223 15159 4 0
unknown 14208 8736 447 105
chunk 12513 12033 33 3
cce-bind 8496 7552 82 23
MATM mac entry 8040 5928 544 412
adj 7064 6312 157 110
route-pfx 6116 5412 157 113
Filter_rules 4912 4896 1 0
fman-infra-dpidb 4130 2338 112 0
SMC Buffer 3794 3202 43 6
urpf-list 3028 2100 85 27
lookup 2480 2160 30 10
MATM mac table 2432 1600 148 96
cdllib 1688 1672 1 0
route-tbl 1600 1264 21 0
FNF Flowdef 1492 1460 3 1
acl-ref 1120 1024 8 2
cgm-lib 1120 880 410 395
pbr_if_cfg 1088 976 205 198
FNF Monitor 1048 1032 1 0
pbr_routemap 960 864 18 12
!
!
!
The following table describes the significant fields shown in the display.
Table 23: show platform software memory brief Field Descriptions
Field Description
module Name of submodule.
allocated Memory, allocated in bytes.
requested Number of bytes requested by application.
allocs Number of discrete allocation event attempts.
frees Number of free events.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
331
Interface and Hardware Components
show platform software process list
show platform software process list
To display the list of running processes on a platform, use the show platform software process list command
in privileged EXEC mode.
show platform software process list switch {switch-number | active | standby} {0 | F0 | R0}
[{name process-name | process-id process-ID | sort memory | summary}]
Syntax Description switch switch-number Displays information about the switch. Valid values for switch-number argument
are from 0 to 9.
active Displays information about the active instance of the switch.
standby Displays information about the standby instance of the switch.
0 Displays information about the shared port adapters (SPA) Interface Processor slot
0.
F0 Displays information about the Embedded Service Processor (ESP) slot 0.
R0 Displays information about the Route Processor (RP) slot 0.
name process-name (Optional) Displays information about the specified process. Enter the process name.
process-id process-ID (Optional) Displays information about the specified process ID. Enter the process
ID.
sort (Optional) Displays information sorted according to processes.
memory (Optional) Displays information sorted according to memory.
summary (Optional) Displays a summary of the process memory of the host device.
Command Modes Privileged EXE (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 The Size column in the output was modified to display Resident Set Size
(RSS) in KB.
Cisco IOS XE Everest 16.5.1a The command was introduced.
Examples The following is sample output from the show platform software process list switch active R0
command:
Switch# show platform software process list switch active R0 summary
Total number of processes: 278
Running : 2
Sleeping : 276
Disk sleeping : 0
Zombies : 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
332
Interface and Hardware Components
show platform software process list
Stopped : 0
Paging : 0
Up time : 8318
Idle time : 0
User time : 216809
Kernel time : 78931
Virtual memory : 12933324800
Pages resident : 634061
Major page faults: 2228
Minor page faults: 3491744
Architecture : mips64
Memory (kB)
Physical : 3976852
Total : 3976852
Used : 2766952
Free : 1209900
Active : 2141344
Inactive : 1589672
Inact-dirty : 0
Inact-clean : 0
Dirty : 4
AnonPages : 1306800
Bounce : 0
Cached : 1984688
Commit Limit : 1988424
Committed As : 3358528
High Total : 0
High Free : 0
Low Total : 3976852
Low Free : 1209900
Mapped : 520528
NFS Unstable : 0
Page Tables : 17328
Slab : 0
VMmalloc Chunk : 1069542588
VMmalloc Total : 1069547512
VMmalloc Used : 2588
Writeback : 0
HugePages Total: 0
HugePages Free : 0
HugePages Rsvd : 0
HugePage Size : 2048
Swap (kB)
Total : 0
Used : 0
Free : 0
Cached : 0
Buffers (kB) : 439528
Load Average
1-Min : 1.13
5-Min : 1.18
15-Min : 0.92
The following is sample output from the show platform software process list switch active R0
command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
333
Interface and Hardware Components
show platform software process list
# show platform software process list switch active R0
Name Pid PPid Group Id Status Priority Size
------------------------------------------------------------------------------
systemd 1 0 1 S 20 7892
kthreadd 2 0 0 S 20 0
ksoftirqd/0 3 2 0 S 20 0
kworker/0:0H 5 2 0 S 0 0
rcu_sched 7 2 0 S 20 0
rcu_bh 8 2 0 S 20 0
migration/0 9 2 0 S 4294967196 0
migration/1 10 2 0 S 4294967196 0
ksoftirqd/1 11 2 0 S 20 0
kworker/1:0H 13 2 0 S 0 0
migration/2 14 2 0 S 4294967196 0
ksoftirqd/2 15 2 0 S 20 0
kworker/2:0H 17 2 0 S 0 0
systemd-journal 221 1 221 S 20 4460
kworker/1:3 246 2 0 S 20 0
systemd-udevd 253 1 253 S 20 5648
kvm-irqfd-clean 617 2 0 S 0 0
scsi_eh_6 620 2 0 S 20 0
scsi_tmf_6 621 2 0 S 0 0
usb-storage 622 2 0 S 20 0
scsi_eh_7 625 2 0 S 20 0
scsi_tmf_7 626 2 0 S 0 0
usb-storage 627 2 0 S 20 0
kworker/7:1 630 2 0 S 20 0
bioset 631 2 0 S 0 0
kworker/3:1H 648 2 0 S 0 0
kworker/0:1H 667 2 0 S 0 0
kworker/1:1H 668 2 0 S 0 0
bioset 669 2 0 S 0 0
kworker/6:2 698 2 0 S 20 0
kworker/2:2 699 2 0 S 20 0
kworker/2:1H 703 2 0 S 0 0
kworker/7:1H 748 2 0 S 0 0
kworker/5:1H 749 2 0 S 0 0
kworker/6:1H 754 2 0 S 0 0
kworker/7:2 779 2 0 S 20 0
auditd 838 1 838 S 16 2564
.
.
.
The table below describes the significant fields shown in the displays.
Table 24: show platform software process list Field Descriptions
Field Description
Name Displays the command name associated with the
process. Different threads in the same process may
have different command values.
Pid Displays the process ID that is used by the operating
system to identify and keep track of the processes.
PPid Displays process ID of the parent process.
Group Id Displays the group ID
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
334
Interface and Hardware Components
show platform software process list
Field Description
Status Displays the process status in human readable form.
Priority Displays the negated scheduling priority.
Size Prior to Cisco IOS XE Gibraltar 16.10.1:
Displays Virtual Memory size.
From Cisco IOS XE Gibraltar 16.10.1 onwards:
Displays the Resident Set Size (RSS) that shows how
much memory is allocated to that process in the RAM.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
335
Interface and Hardware Components
show platform software process memory
show platform software process memory
To display the amount of memory used by each system process, use the show platform software process
memory command in privileged EXEC mode.
show platform process memory
switch{switch-number|active|standby}{0|F0|FP|R0}{all[sorted|virtual[sorted]]|name
process-name{maps|smaps[summary]}|process-id process-id{maps|smaps[summary]}}
Syntax Description switch switch-number Displays information about the switch. Enter the
switch number.
active Specifies the active instance of the device.
standby Specifies the standby instance of the device.
0 Specifies the Shared Port Adapter (SPA) Interface
Processor slot 0.
F0 Specifies the Embedded Service Processor (ESP) slot
0.
FP Specifies the Embedded Service Processor (ESP).
R0 Specifies the Route Processor (RP) slot 0.
all Lists all processes.
sorted (Optional) Sorts the output based on Resident Set Size
(RSS).
virtual (Optional) Specifies virtual memory.
name process-name Specifies a process name.
maps Specifies the memory maps of a process.
smaps summary Specifies the smaps summary of a process.
process-id process-id Specifies a process identifier.
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Command Modes Privileged EXEC(#)
Examples:
The following is a sample output from the show platform software process memory active R0 all command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
336
Interface and Hardware Components
show platform software process memory
Device# show platform software process memory switch active R0 all
Pid RSS PSS Heap Shared Private Name
--------------------------------------------------------------------------
1 4876 3229 1064 1808 3068 systemd
118 3184 1327 132 2352 832 systemd-journal
159 3008 1191 396 1996 1012 systemd-udevd
407 3192 1262 132 2196 996 dbus-daemon
3406 4772 3064 264 1940 2832 virtlogd
3411 5712 3474 2964 2344 3368 droputil.sh
3416 2588 358 132 2336 252 libvirtd.sh
3420 5708 3484 2976 2308 3400 reflector.sh
3424 1804 263 132 1632 172 xinetd
3425 964 118 132 872 92 sleep
3434 3060 844 528 2304 756 oom.sh
3442 2068 606 132 1604 464 rpcbind
3485 2380 845 132 1636 744 rpc.statd
3486 1632 338 132 1348 284 boothelper_evt.
3493 1136 156 132 1004 132 inotifywait
3504 2048 753 132 1372 676 rpc.mountd
3584 2868 620 36 2384 484 rotee
3649 1032 116 132 944 88 sleep
3705 2784 613 36 2296 488 rotee
3718 2856 610 36 2376 480 rotee
3759 1292 184 132 1136 156 inotifywait
3787 4256 2040 1640 2300 1956 iptbl.sh
3894 2948 637 36 2460 488 rotee
4017 1380 175 132 1236 144 inotifywait
4866 1820 287 132 1624 196 xinetd
5887 1692 257 132 1508 184 xinetd
5891 7248 4984 4584 2348 4900 rollback_timer.
5893 1764 257 132 1588 176 xinetd
6031 2804 601 36 2332 472 rotee
6037 1228 163 132 1092 136 inotifywait
6077 4736 3389 2992 1368 3368 psvp.sh
6115 1620 476 36 1152 468 rotee
6122 624 149 132 480 144 inotifywait
6127 5440 4077 3680 1384 4056 pvp.sh
6165 1736 592 36 1152 584 rotee
6245 624 149 132 480 144 inotifywait
6353 2592 1260 924 1352 1240 pman.sh
6470 1632 488 36 1152 480 rotee
6499 2588 1262 924 1348 1240 pman.sh
6666 1640 496 36 1152 488 rotee
6718 2584 1258 800 1348 1236 pman.sh
6736 8360 7020 6640 1360 7000 auto_upgrade_cl
6909 1636 492 36 1152 484 rotee
6955 2588 1262 928 1348 1240 pman.sh
7029 2196 679 40 1552 644 auto_upgrade_se
7149 1636 492 36 1152 484 rotee
7224 13200 4595 48 9368 3832 bt_logger
7295 2588 1262 800 1348 1240 pman.sh
.
.
.
The table below describes the significant fields shown in the displays.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
337
Interface and Hardware Components
show platform software process memory
Table 25: show platform software process memory Field Descriptions
Field Description
PID Displays the process ID that is used by the operating
system to identify and keep track of the processes.
RSS Displays the Resident Set Size (in kilobytes (KB))
that shows how much memory is allocated to that
process in the RAM.
PSS Displays the Proportional Set Size of a process. This
is the count of pages it has in memory, where each
page is divided by the number of processes sharing
it.
Heap Displays where all user-allocated memory is located.
Shared Shared clean + Shared dirty
Private Private clean + Private dirty
Name Displays the command name associated with the
process. Different threads in the same process may
have different command values.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
338
Interface and Hardware Components
show platform software process slot switch
show platform software process slot switch
To display platform software process switch information, use the show platform software process slot switch
command in privileged EXEC mode.
show platform software process slot switch {switch-number | active | standby} {0 | F0 | R0}
monitor [{cycles no-of-times [{interval delay [{lines number}]}]}]
Syntax Description switch-number Switch number.
active Specifies the active instance.
standby Specifies the standby instance.
0 Specifies the shared port adapter (SPA) interface
processor slot 0.
F0 Specifies the Embedded Service Processor (ESP)
slot 0.
R0 Specifies the Route Processor (RP) slot 0.
monitor Monitors the running processes.
cycles no-of-tmes (Optional) Sets the number of times to run monitor
command. Valid values are from 1 to 4294967295.
The default is 5.
interval delay (Optional) Sets a delay after each . Valid values
are from 0 to 300. The default is 3.
lines number (Optional) Sets the number of lines of output
displayed. Valid values are from 0 to 512. The
default is 0.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The output of the show platform software process slot switch and show processes cpu platform monitor
location commands display the output of the Linux top command. The output of these commands display
Free memory and Used memory as displayed by the Linux top command. The values displayed for the Free
memory and Used memory by these commands do not match the values displayed by the output of other
platform-memory related CLIs.
Examples The following is sample output from the show platform software process slot monitor command:
Switch# show platform software process slot switch active R0 monitor
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
339
Interface and Hardware Components
show platform software process slot switch
top - 00:01:52 up 1 day, 11:20, 0 users, load average: 0.50, 0.68, 0.83
Tasks: 311 total, 2 running, 309 sleeping, 0 stopped, 0 zombie
Cpu(s): 7.4%us, 3.3%sy, 0.0%ni, 89.2%id, 0.0%wa, 0.0%hi, 0.1%si, 0.0%st
Mem: 3976844k total, 3955036k used, 21808k free, 419312k buffers
Swap: 0k total, 0k used, 0k free, 1946764k cached
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
5693 root 20 0 3448 1368 912 R 7 0.0 0:00.07 top
17546 root 20 0 2044m 244m 79m S 7 6.3 186:49.08 fed main event
18662 root 20 0 1806m 678m 263m S 5 17.5 215:32.38 linux_iosd-imag
30276 root 20 0 171m 42m 33m S 5 1.1 125:06.77 repm
17835 root 20 0 935m 74m 63m S 4 1.9 82:28.31 sif_mgr
18534 root 20 0 182m 150m 10m S 2 3.9 8:12.08 smand
1 root 20 0 8440 4740 2184 S 0 0.1 0:09.52 systemd
2 root 20 0 0 0 0 S 0 0.0 0:00.00 kthreadd
3 root 20 0 0 0 0 S 0 0.0 0:02.86 ksoftirqd/0
5 root 0 -20 0 0 0 S 0 0.0 0:00.00 kworker/0:0H
7 root RT 0 0 0 0 S 0 0.0 0:01.44 migration/0
8 root 20 0 0 0 0 S 0 0.0 0:00.00 rcu_bh
9 root 20 0 0 0 0 S 0 0.0 0:23.08 rcu_sched
10 root 20 0 0 0 0 S 0 0.0 0:58.04 rcuc/0
11 root 20 0 0 0 0 S 0 0.0 21:35.60 rcuc/1
12 root RT 0 0 0 0 S 0 0.0 0:01.33 migration/1
Related Commands Command Description
show processes cpu platform monitor location Displays information about the CPU utilization of the
IOS-XE processes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
340
Interface and Hardware Components
show platform software status control-processor
show platform software status control-processor
To display platform software control-processor status, use the show platform software status
control-processor command in privileged EXEC mode.
show platform software status control-processor [{brief}]
Syntax Description brief (Optional) Displays a summary of the platform control-processor status.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is sample output from the show platform memory software status control-processor
command:
Switch# show platform software status control-processor
2-RP0: online, statistics updated 7 seconds ago
Load Average: healthy
1-Min: 1.00, status: healthy, under 5.00
5-Min: 1.21, status: healthy, under 5.00
15-Min: 0.90, status: healthy, under 5.00
Memory (kb): healthy
Total: 3976852
Used: 2766284 (70%), status: healthy
Free: 1210568 (30%)
Committed: 3358008 (84%), under 95%
Per-core Statistics
CPU0: CPU Utilization (percentage of time spent)
User: 4.40, System: 1.70, Nice: 0.00, Idle: 93.80
IRQ: 0.00, SIRQ: 0.10, IOwait: 0.00
CPU1: CPU Utilization (percentage of time spent)
User: 3.80, System: 1.20, Nice: 0.00, Idle: 94.90
IRQ: 0.00, SIRQ: 0.10, IOwait: 0.00
CPU2: CPU Utilization (percentage of time spent)
User: 7.00, System: 1.10, Nice: 0.00, Idle: 91.89
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU3: CPU Utilization (percentage of time spent)
User: 4.49, System: 0.69, Nice: 0.00, Idle: 94.80
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
3-RP0: unknown, statistics updated 2 seconds ago
Load Average: healthy
1-Min: 0.24, status: healthy, under 5.00
5-Min: 0.27, status: healthy, under 5.00
15-Min: 0.32, status: healthy, under 5.00
Memory (kb): healthy
Total: 3976852
Used: 2706768 (68%), status: healthy
Free: 1270084 (32%)
Committed: 3299332 (83%), under 95%
Per-core Statistics
CPU0: CPU Utilization (percentage of time spent)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
341
Interface and Hardware Components
show platform software status control-processor
User: 4.50, System: 1.20, Nice: 0.00, Idle: 94.20
IRQ: 0.00, SIRQ: 0.10, IOwait: 0.00
CPU1: CPU Utilization (percentage of time spent)
User: 5.20, System: 0.50, Nice: 0.00, Idle: 94.29
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU2: CPU Utilization (percentage of time spent)
User: 3.60, System: 0.70, Nice: 0.00, Idle: 95.69
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU3: CPU Utilization (percentage of time spent)
User: 3.00, System: 0.60, Nice: 0.00, Idle: 96.39
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
4-RP0: unknown, statistics updated 2 seconds ago
Load Average: healthy
1-Min: 0.21, status: healthy, under 5.00
5-Min: 0.24, status: healthy, under 5.00
15-Min: 0.24, status: healthy, under 5.00
Memory (kb): healthy
Total: 3976852
Used: 1452404 (37%), status: healthy
Free: 2524448 (63%)
Committed: 1675120 (42%), under 95%
Per-core Statistics
CPU0: CPU Utilization (percentage of time spent)
User: 2.30, System: 0.40, Nice: 0.00, Idle: 97.30
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU1: CPU Utilization (percentage of time spent)
User: 4.19, System: 0.69, Nice: 0.00, Idle: 95.10
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU2: CPU Utilization (percentage of time spent)
User: 4.79, System: 0.79, Nice: 0.00, Idle: 94.40
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU3: CPU Utilization (percentage of time spent)
User: 2.10, System: 0.40, Nice: 0.00, Idle: 97.50
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
9-RP0: unknown, statistics updated 4 seconds ago
Load Average: healthy
1-Min: 0.20, status: healthy, under 5.00
5-Min: 0.35, status: healthy, under 5.00
15-Min: 0.35, status: healthy, under 5.00
Memory (kb): healthy
Total: 3976852
Used: 1451328 (36%), status: healthy
Free: 2525524 (64%)
Committed: 1675932 (42%), under 95%
Per-core Statistics
CPU0: CPU Utilization (percentage of time spent)
User: 1.90, System: 0.50, Nice: 0.00, Idle: 97.60
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU1: CPU Utilization (percentage of time spent)
User: 4.39, System: 0.19, Nice: 0.00, Idle: 95.40
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU2: CPU Utilization (percentage of time spent)
User: 5.70, System: 1.00, Nice: 0.00, Idle: 93.30
IRQ: 0.00, SIRQ: 0.00, IOwait: 0.00
CPU3: CPU Utilization (percentage of time spent)
User: 1.30, System: 0.60, Nice: 0.00, Idle: 98.00
IRQ: 0.00, SIRQ: 0.10, IOwait: 0.00
The following is sample output from the show platform memory software status control-processor
brief command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
342
Interface and Hardware Components
show platform software status control-processor
Switch# show platform software status control-processor brief
Load Average
Slot Status 1-Min 5-Min 15-Min
2-RP0 Healthy 1.10 1.21 0.91
3-RP0 Healthy 0.23 0.27 0.31
4-RP0 Healthy 0.11 0.21 0.22
9-RP0 Healthy 0.10 0.30 0.34
Memory (kB)
Slot Status Total Used (Pct) Free (Pct) Committed (Pct)
2-RP0 Healthy 3976852 2766956 (70%) 1209896 (30%) 3358352 (84%)
3-RP0 Healthy 3976852 2706824 (68%) 1270028 (32%) 3299276 (83%)
4-RP0 Healthy 3976852 1451888 (37%) 2524964 (63%) 1675076 (42%)
9-RP0 Healthy 3976852 1451580 (37%) 2525272 (63%) 1675952 (42%)
CPU Utilization
Slot CPU User System Nice Idle IRQ SIRQ IOwait
2-RP0 0 4.10 2.00 0.00 93.80 0.00 0.10 0.00
1 4.60 1.00 0.00 94.30 0.00 0.10 0.00
2 6.50 1.10 0.00 92.40 0.00 0.00 0.00
3 5.59 1.19 0.00 93.20 0.00 0.00 0.00
3-RP0 0 2.80 1.20 0.00 95.90 0.00 0.10 0.00
1 4.49 1.29 0.00 94.20 0.00 0.00 0.00
2 5.30 1.60 0.00 93.10 0.00 0.00 0.00
3 5.80 1.20 0.00 93.00 0.00 0.00 0.00
4-RP0 0 1.30 0.80 0.00 97.89 0.00 0.00 0.00
1 1.30 0.20 0.00 98.50 0.00 0.00 0.00
2 5.60 0.80 0.00 93.59 0.00 0.00 0.00
3 5.09 0.19 0.00 94.70 0.00 0.00 0.00
9-RP0 0 3.99 0.69 0.00 95.30 0.00 0.00 0.00
1 2.60 0.70 0.00 96.70 0.00 0.00 0.00
2 4.49 0.89 0.00 94.60 0.00 0.00 0.00
3 2.60 0.20 0.00 97.20 0.00 0.00 0.00
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
343
Interface and Hardware Components
show platform software thread list
show platform software thread list
To display the list of threads on a platform, use the show platform software thread list command in privileged
EXEC mode.
show platform software thread list switch{switch-number|active|standby}{0|F0|FP
active|R0}pname{cdman|vidman|all}tname{main|pktio|rt|all}
Syntax Description switch switch-number Displays information about the switch. Enter the
switch number.
active Specifies the active instance of the device.
standby Specifies standby instance of the device.
0 Specifies the Shared Port Adapter (SPA) Interface
Processor slot 0.
F0 Specifies the Embedded Service Processor (ESP) slot
0.
FP active Specifies the active instance of Embedded Service
Processor (ESP).
R0 Specifies the Route Processor (RP) slot 0.
pname Specifies a process name. The possible values are
cdman, vidman, and all.
tname Specifies a thread name. The possible values are main,
pktio, rt, and all.
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Command Modes Privileged EXEC(#)
Examples:
The following is sample output from the show platform software thread list switch active R0 pname cdman
tname all command:
Device# show platform software thread list switch active R0 pname cdman tname all
Name Tid PPid Group Id Core Vcswch Nvcswch Status Priority
TIME+ Size
----------------------------------------------------------------------------------------------------------
cdman 8407 7295 8407 1 0 0 S 20
12309 36976
The table below describes the significant fields shown in the displays.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
344
Interface and Hardware Components
show platform software thread list
Table 26: show platform software thread list Field Descriptions
Field Description
Name Displays the command name associated with the
process. Different threads in the same process may
have different command values.
Tid Displays the process ID.
PPid Displays the process ID of the parent process.
Group Id Displays the group ID.
Core Displays processor information.
Vcswch Displays the number of voluntary context switches.
Nvcswch Displays the number of non-voluntary context
switches.
Status Displays the process status in human readable form.
Priority Displays the negated scheduling priority.
TIME+ Displays the time since the start of the process.
Size Displays the Resident Set Size (in kilobytes (KB))
that shows how much memory is allocated to that
process in the RAM.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
345
Interface and Hardware Components
show platform usb status
show platform usb status
To display the status of the USB ports on a device, use the show platform usb status command in Privileged
EXEC mode.
show platform usb status
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show platform usb status command:
Device> enable
Device# show platform usb status
USB Disabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
346
Interface and Hardware Components
show processes cpu platform
show processes cpu platform
To display information about the CPU utilization of the IOS-XE processes, use the show processes cpu
platform command in privileged EXEC mode.
show processes cpu platform [[ sorted[1min|5min|5sec]]location
switch{switch-number|active|standby}{F0|FP active|R0|RP active}]
Syntax Description sorted (Optional) Displays output sorted based on percentage of CPU usage on a platform.
1min (Optional) Sorts based on 1 minute intervals.
5min (Optional) Sorts based on 5 minute intervals.
5sec (Optional) Sorts based on 5 second intervals.
location Specifies the Field Replaceable Unit (FRU) location.
switch Displays information about the switch. Enter the switch number.
switch-number
active Specifies the active instance of the device.
standby Specifies the standby instance of the device.
F0 Specifies the Embedded Service Processor (ESP) slot 0.
FP active Specifies active instances on the Embedded Service Processor (ESP).
R0 Specifies the Route Processor (RP) slot 0.
RP active Specifies active instances on the Route Processor (RP).
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Command Modes Privileged EXEC (#)
Examples:
The following is sample output from the show processes cpu platform command:
Device# show processes cpu platform
CPU utilization for five seconds: 1%, one minute: 3%, five minutes: 2%
Core 0: CPU utilization for five seconds: 2%, one minute: 2%, five minutes: 2%
Core 1: CPU utilization for five seconds: 2%, one minute: 1%, five minutes: 1%
Core 2: CPU utilization for five seconds: 3%, one minute: 1%, five minutes: 1%
Core 3: CPU utilization for five seconds: 2%, one minute: 5%, five minutes: 2%
Pid PPid 5Sec 1Min 5Min Status Size Name
--------------------------------------------------------------------------------
1 0 0% 0% 0% S 4876 systemd
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
347
Interface and Hardware Components
show processes cpu platform
2 0 0% 0% 0% S 0 kthreadd
3 2 0% 0% 0% S 0 ksoftirqd/0
5 2 0% 0% 0% S 0 kworker/0:0H
7 2 0% 0% 0% S 0 rcu_sched
8 2 0% 0% 0% S 0 rcu_bh
9 2 0% 0% 0% S 0 migration/0
10 2 0% 0% 0% S 0 watchdog/0
11 2 0% 0% 0% S 0 watchdog/1
12 2 0% 0% 0% S 0 migration/1
13 2 0% 0% 0% S 0 ksoftirqd/1
15 2 0% 0% 0% S 0 kworker/1:0H
16 2 0% 0% 0% S 0 watchdog/2
17 2 0% 0% 0% S 0 migration/2
18 2 0% 0% 0% S 0 ksoftirqd/2
20 2 0% 0% 0% S 0 kworker/2:0H
21 2 0% 0% 0% S 0 watchdog/3
22 2 0% 0% 0% S 0 migration/3
23 2 0% 0% 0% S 0 ksoftirqd/3
24 2 0% 0% 0% S 0 kworker/3:0
25 2 0% 0% 0% S 0 kworker/3:0H
26 2 0% 0% 0% S 0 kdevtmpfs
27 2 0% 0% 0% S 0 netns
28 2 0% 0% 0% S 0 perf
29 2 0% 0% 0% S 0 khungtaskd
30 2 0% 0% 0% S 0 writeback
31 2 7% 8% 8% S 0 ksmd
32 2 0% 0% 0% S 0 khugepaged
33 2 0% 0% 0% S 0 crypto
34 2 0% 0% 0% S 0 bioset
35 2 0% 0% 0% S 0 kblockd
36 2 0% 0% 0% S 0 ata_sff
37 2 0% 0% 0% S 0 rpciod
63 2 0% 0% 0% S 0 kswapd0
64 2 0% 0% 0% S 0 vmstat
65 2 0% 0% 0% S 0 fsnotify_mark
.
.
.
The following is sample output from the show processes cpu platform sorted 5min location switch 5 R0
Device# show processes cpu platform sorted 5min location switch 5 R0
CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 0: CPU utilization for five seconds: 1%, one minute: 1%, five minutes: 1%
Core 1: CPU utilization for five seconds: 1%, one minute: 1%, five minutes: 1%
Core 2: CPU utilization for five seconds: 1%, one minute: 1%, five minutes: 1%
Core 3: CPU utilization for five seconds: 2%, one minute: 2%, five minutes: 1%
Core 4: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 5: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 6: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 7: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Pid PPid 5Sec 1Min 5Min Status Size Name
--------------------------------------------------------------------------------
16358 15516 4% 4% 4% S 221376 fed main event
14062 12756 1% 1% 1% S 52140 sif_mgr
32105 8618 0% 0% 0% S 260 inotifywait
31396 31393 0% 0% 0% S 36516 python2.7
31393 31271 0% 0% 0% S 2744 rdope.sh
31319 1 0% 0% 0% S 2648 rotee
31271 1 0% 0% 0% S 3852 pman.sh
29671 2 0% 0% 0% S 0 kworker/u16:0
29341 29329 0% 0% 0% S 1780 sntp
29329 1 0% 0% 0% S 2788 stack_sntp.sh
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
348
Interface and Hardware Components
show processes cpu platform
.
.
The following is sample output from the show processes cpu platform location switch 7 R0 command:
Device# show processes cpu platform location switch 7 R0
CPU utilization for five seconds: 3%, one minute: 3%, five minutes: 3%
Core 0: CPU utilization for five seconds: 1%, one minute: 5%, five minutes: 5%
Core 1: CPU utilization for five seconds: 1%, one minute: 11%, five minutes: 5%
Core 2: CPU utilization for five seconds: 22%, one minute: 7%, five minutes: 6%
Core 3: CPU utilization for five seconds: 5%, one minute: 6%, five minutes: 6%
Core 4: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 5: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 6: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 0%
Core 7: CPU utilization for five seconds: 0%, one minute: 0%, five minutes: 6%
Pid PPid 5Sec 1Min 5Min Status Size Name
--------------------------------------------------------------------------------
1 0 0% 0% 0% S 8044 systemd
2 0 0% 0% 0% S 0 kthreadd
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
349
Interface and Hardware Components
show processes cpu platform history
show processes cpu platform history
To display information about the CPU usage history of a system, use the show processes cpu platform
history command.
show processes cpu platform history[1min|5min|5sec|60min]location
switch{switch-number|active|standby}{0|F0|FP active|R0}
1min (Optional) Displays CPU utilization history with 1
minute intervals.
5min (Optional) Displays CPU utilization history with 5
minute intervals.
5sec (Optional) Displays CPU utilization history with 5
second intervals.
60min (Optional) Displays CPU utilization history with 60
minute intervals.
location Specifies the Field Replaceable Unit (FRU) location.
switch switch-number Displays information about the switch. Enter the
switch number.
active Specifies the active instance of the device.
standby Specifies the standby instance of the device.
0 Specifies the Shared Port Adapter (SPA) Interface
Processor slot 0.
F0 Specifies the Embedded Service Processor (ESP) slot
0.
FP active Specifies active instances on the Embedded Service
Processor (ESP).
R0 Specifies the Route Processor (RP) slot 0.
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Command Modes Privileged EXEC (#)
Examples:
The following is sample output from the show processes cpu platform command:
Device# show processes cpu platform
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
350
Interface and Hardware Components
show processes cpu platform history
CPU utilization for five seconds: 1%, one minute: 3%, five minutes: 2%
Core 0: CPU utilization for five seconds: 2%, one minute: 2%, five minutes: 2%
Core 1: CPU utilization for five seconds: 2%, one minute: 1%, five minutes: 1%
Core 2: CPU utilization for five seconds: 3%, one minute: 1%, five minutes: 1%
Core 3: CPU utilization for five seconds: 2%, one minute: 5%, five minutes: 2%
Pid PPid 5Sec 1Min 5Min Status Size Name
--------------------------------------------------------------------------------
1 0 0% 0% 0% S 4876 systemd
2 0 0% 0% 0% S 0 kthreadd
3 2 0% 0% 0% S 0 ksoftirqd/0
5 2 0% 0% 0% S 0 kworker/0:0H
7 2 0% 0% 0% S 0 rcu_sched
8 2 0% 0% 0% S 0 rcu_bh
9 2 0% 0% 0% S 0 migration/0
10 2 0% 0% 0% S 0 watchdog/0
11 2 0% 0% 0% S 0 watchdog/1
12 2 0% 0% 0% S 0 migration/1
13 2 0% 0% 0% S 0 ksoftirqd/1
15 2 0% 0% 0% S 0 kworker/1:0H
16 2 0% 0% 0% S 0 watchdog/2
17 2 0% 0% 0% S 0 migration/2
18 2 0% 0% 0% S 0 ksoftirqd/2
20 2 0% 0% 0% S 0 kworker/2:0H
21 2 0% 0% 0% S 0 watchdog/3
22 2 0% 0% 0% S 0 migration/3
23 2 0% 0% 0% S 0 ksoftirqd/3
24 2 0% 0% 0% S 0 kworker/3:0
25 2 0% 0% 0% S 0 kworker/3:0H
26 2 0% 0% 0% S 0 kdevtmpfs
27 2 0% 0% 0% S 0 netns
28 2 0% 0% 0% S 0 perf
29 2 0% 0% 0% S 0 khungtaskd
30 2 0% 0% 0% S 0 writeback
31 2 7% 8% 8% S 0 ksmd
32 2 0% 0% 0% S 0 khugepaged
33 2 0% 0% 0% S 0 crypto
34 2 0% 0% 0% S 0 bioset
35 2 0% 0% 0% S 0 kblockd
36 2 0% 0% 0% S 0 ata_sff
37 2 0% 0% 0% S 0 rpciod
63 2 0% 0% 0% S 0 kswapd0
64 2 0% 0% 0% S 0 vmstat
65 2 0% 0% 0% S 0 fsnotify_mark
.
.
.
The following is sample output from the show processes cpu platform history 5sec command:
Device# show processes cpu platform history 5sec
5 seconds ago, CPU utilization: 0%
10 seconds ago, CPU utilization: 0%
15 seconds ago, CPU utilization: 0%
20 seconds ago, CPU utilization: 0%
25 seconds ago, CPU utilization: 0%
30 seconds ago, CPU utilization: 0%
35 seconds ago, CPU utilization: 0%
40 seconds ago, CPU utilization: 0%
45 seconds ago, CPU utilization: 0%
50 seconds ago, CPU utilization: 0%
55 seconds ago, CPU utilization: 0%
60 seconds ago, CPU utilization: 0%
65 seconds ago, CPU utilization: 0%
70 seconds ago, CPU utilization: 0%
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
351
Interface and Hardware Components
show processes cpu platform history
75 seconds ago, CPU utilization: 0%
80 seconds ago, CPU utilization: 0%
85 seconds ago, CPU utilization: 0%
90 seconds ago, CPU utilization: 0%
95 seconds ago, CPU utilization: 0%
100 seconds ago, CPU utilization: 0%
105 seconds ago, CPU utilization: 0%
110 seconds ago, CPU utilization: 0%
115 seconds ago, CPU utilization: 0%
120 seconds ago, CPU utilization: 0%
125 seconds ago, CPU utilization: 0%
130 seconds ago, CPU utilization: 0%
135 seconds ago, CPU utilization: 0%
140 seconds ago, CPU utilization: 0%
145 seconds ago, CPU utilization: 1%
150 seconds ago, CPU utilization: 0%
155 seconds ago, CPU utilization: 0%
160 seconds ago, CPU utilization: 0%
165 seconds ago, CPU utilization: 0%
170 seconds ago, CPU utilization: 0%
175 seconds ago, CPU utilization: 0%
180 seconds ago, CPU utilization: 0%
185 seconds ago, CPU utilization: 0%
190 seconds ago, CPU utilization: 0%
195 seconds ago, CPU utilization: 0%
200 seconds ago, CPU utilization: 0%
205 seconds ago, CPU utilization: 0%
210 seconds ago, CPU utilization: 0%
215 seconds ago, CPU utilization: 0%
220 seconds ago, CPU utilization: 0%
225 seconds ago, CPU utilization: 0%
230 seconds ago, CPU utilization: 0%
235 seconds ago, CPU utilization: 0%
240 seconds ago, CPU utilization: 0%
245 seconds ago, CPU utilization: 0%
250 seconds ago, CPU utilization: 0%
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
352
Interface and Hardware Components
show processes cpu platform monitor
show processes cpu platform monitor
To displays information about the CPU utilization of the IOS-XE processes, use the show processes cpu
platform monitor command in privileged EXEC mode.
show processes cpu platform monitor location switch {switch-number | active | standby} {0 | F0 |
R0}
Syntax Description location Displays information about the Field Replaceable Unit (FRU) location.
switch Specifies the switch.
switch-number Switch number.
active Specifies the active instance.
standby Specifies the standby instance.
0 Specifies the shared port adapter (SPA) interface processor slot 0.
F0 Specifies the Embedded Service Processor (ESP) slot 0.
R0 Specifies the Route Processor (RP) slot 0.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The output of the show platform software process slot switch and show processes cpu platform monitor
location commands display the output of the Linux top command. The output of these commands display
Free memory and Used memory as displayed by the Linux top command. The values displayed for the Free
memory and Used memory by these commands do not match the values displayed by the output of other
platform-memory related CLIs.
Examples The following is sample output from the show processes cpu monitor location switch active R0
command:
Switch# show processes cpu platform monitor location switch active R0
top - 00:04:21 up 1 day, 11:22, 0 users, load average: 0.42, 0.60, 0.78
Tasks: 312 total, 4 running, 308 sleeping, 0 stopped, 0 zombie
Cpu(s): 7.4%us, 3.3%sy, 0.0%ni, 89.2%id, 0.0%wa, 0.0%hi, 0.1%si, 0.0%st
Mem: 3976844k total, 3956928k used, 19916k free, 419312k buffers
Swap: 0k total, 0k used, 0k free, 1947036k cached
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
6294 root 20 0 3448 1368 912 R 9 0.0 0:00.07 top
17546 root 20 0 2044m 244m 79m S 7 6.3 187:02.07 fed main event
30276 root 20 0 171m 42m 33m S 7 1.1 125:15.54 repm
16 root 20 0 0 0 0 S 5 0.0 22:07.92 rcuc/2
21 root 20 0 0 0 0 R 5 0.0 22:13.24 rcuc/3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
353
Interface and Hardware Components
show processes cpu platform monitor
18662 root 20 0 1806m 678m 263m R 5 17.5 215:47.59 linux_iosd-imag
11 root 20 0 0 0 0 S 4 0.0 21:37.41 rcuc/1
10333 root 20 0 6420 3916 1492 S 4 0.1 4:47.03 btrace_rotate.s
10 root 20 0 0 0 0 S 2 0.0 0:58.13 rcuc/0
6304 root 20 0 776 12 0 R 2 0.0 0:00.01 ls
17835 root 20 0 935m 74m 63m S 2 1.9 82:34.07 sif_mgr
1 root 20 0 8440 4740 2184 S 0 0.1 0:09.52 systemd
2 root 20 0 0 0 0 S 0 0.0 0:00.00 kthreadd
3 root 20 0 0 0 0 S 0 0.0 0:02.86 ksoftirqd/0
5 root 0 -20 0 0 0 S 0 0.0 0:00.00 kworker/0:0H
7 root RT 0 0 0 0 S 0 0.0 0:01.44 migration/0
Related Commands Command Description
show platform software process slot switch Displays platform software process switch information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
354
Interface and Hardware Components
show processes memory
show processes memory
To display the amount of memory used by each system process, use the show processes memory command
in privileged EXEC mode.
show processes memory [{ process-id | sorted [{ allocated | getbufs | holding }] }]
Syntax Description process-id (Optional) Process ID (PID) of a specific process. When you specify a process ID, only details
for the specified process will be shown.
sorted (Optional) Displays memory data sorted by the Allocated, Get Buffers, or Holding column. If
the sorted keyword is used by itself, data is sorted by the Holding column by default.
allocated (Optional) Displays memory data sorted by the Allocated column.
getbufs (Optional) Displays memory data sorted by the Getbufs (Get Buffers) column.
holding (Optional) Displays memory data sorted by the Holding column. This keyword is the default.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show processes memory command and the show processes memory sorted command displays a
summary of total, used, and free memory, followed by a list of processes and their memory impact.
If the standard show processes memory process-id command is used, processes are sorted by their PID. If
the show processes memory sorted command is used, the default sorting is by the Holding value.
Note Holding memory of a particular process can be allocated by other processes also, and so it can be greater than
the allocated memory.
The following is sample output from the show processes memory command:
Device# show processes memory
Processor Pool Total: 25954228 Used: 8368640 Free: 17585588
PID TTY Allocated Freed Holding Getbufs Retbufs Process
0 0 8629528 689900 6751716 0 0 *Init*
0 0 24048 12928 24048 0 0 *Sched*
0 0 260 328 68 350080 0 *Dead*
1 0 0 0 12928 0 0 Chunk Manager
2 0 192 192 6928 0 0 Load Meter
3 0 214664 304 227288 0 0 Exec
4 0 0 0 12928 0 0 Check heaps
5 0 0 0 12928 0 0 Pool Manager
6 0 192 192 12928 0 0 Timers
7 0 192 192 12928 0 0 Serial Backgroun
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
355
Interface and Hardware Components
show processes memory
8 0 192 192 12928 0 0 AAA high-capacit
9 0 0 0 24928 0 0 Policy Manager
10 0 0 0 12928 0 0 ARP Input
11 0 192 192 12928 0 0 DDR Timers
12 0 0 0 12928 0 0 Entity MIB API
13 0 0 0 12928 0 0 MPLS HC Counter
14 0 0 0 12928 0 0 SERIAL A'detect
.
.
.
78 0 0 0 12992 0 0 DHCPD Timer
79 0 160 0 13088 0 0 DHCPD Database
8329440 Total
The table below describes the significant fields shown in the display.
Table 27: show processes memory Field Descriptions
Field Description
Processor Pool Total Total amount of memory, in kilobytes (KB), held for the Processor memory pool.
Used Total amount of used memory, in KB, in the Processor memory pool.
Free Total amount of free memory, in KB, in the Processor memory pool.
PID Process ID.
TTY Terminal that controls the process.
Allocated Bytes of memory allocated by the process.
Freed Bytes of memory freed by the process, regardless of who originally allocated it.
Holding Amount of memory, in KB, currently allocated to the process. This includes memory
allocated by the process and assigned to the process.
Getbufs Number of times the process has requested a packet buffer.
Retbufs Number of times the process has relinquished a packet buffer.
Process Process name.
*Init* System initialization process.
*Sched* The scheduler process.
*Dead* Processes as a group that are now dead.
<value> Total Total amount of memory, in KB, held by all processes (sum of the “Holding” column).
The following is sample output from the show processes memory command when the sorted
keyword is used. In this case, the output is sorted by the Holding column, from largest to smallest.
Device# show processes memory sorted
Processor Pool Total: 25954228 Used: 8371280 Free: 17582948
PID TTY Allocated Freed Holding Getbufs Retbufs Process
0 0 8629528 689900 6751716 0 0 *Init*
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
356
Interface and Hardware Components
show processes memory
3 0 217304 304 229928 0 0 Exec
53 0 109248 192 96064 0 0 DHCPD Receive
56 0 0 0 32928 0 0 COPS
19 0 39048 0 25192 0 0 Net Background
42 0 0 0 24960 0 0 L2X Data Daemon
58 0 192 192 24928 0 0 X.25 Background
43 0 192 192 24928 0 0 PPP IP Route
49 0 0 0 24928 0 0 TCP Protocols
48 0 0 0 24928 0 0 TCP Timer
17 0 192 192 24928 0 0 XML Proxy Client
9 0 0 0 24928 0 0 Policy Manager
40 0 0 0 24928 0 0 L2X SSS manager
29 0 0 0 24928 0 0 IP Input
44 0 192 192 24928 0 0 PPP IPCP
32 0 192 192 24928 0 0 PPP Hooks
34 0 0 0 24928 0 0 SSS Manager
41 0 192 192 24928 0 0 L2TP mgmt daemon
16 0 192 192 24928 0 0 Dialer event
35 0 0 0 24928 0 0 SSS Test Client
--More--
The following is sample output from the show processes memory command when a process ID
(process-id) is specified:
Device# show processes memory 1
Process ID: 1
Process Name: Chunk Manager
Total Memory Held: 8428 bytes
Processor memory holding = 8428 bytes
pc = 0x60790654, size = 6044, count = 1
pc = 0x607A5084, size = 1544, count = 1
pc = 0x6076DBC4, size = 652, count = 1
pc = 0x6076FF18, size = 188, count = 1
I/O memory holding = 0 bytes
Device# show processes memory 2
Process ID: 2
Process Name: Load Meter
Total Memory Held: 3884 bytes
Processor memory holding = 3884 bytes
pc = 0x60790654, size = 3044, count = 1
pc = 0x6076DBC4, size = 652, count = 1
pc = 0x6076FF18, size = 188, count = 1
I/O memory holding = 0 bytes
Related Commands Command Description
show memory Displays statistics about memory, including memory-free pool statistics.
show processes Displays information about the active processes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
357
Interface and Hardware Components
show processes memory platform
show processes memory platform
To display memory usage for each Cisco IOS XE process, use the show processes memory platform command
in privileged EXEC mode.
show processes memory platform [ [ detailed { name process-name | process-id process-ID } [
location | maps [ location ] | smaps [ location ] ] | location | sorted [ location ] ] switch
{ switch-number | active | standby } { 0 | F0 | R0 } | accounting ]
Syntax Description accounting (Optional) Displays the top memory allocators for
each Cisco IOS XE process.
detailed (Optional) Displays detailed memory information for
a specified Cisco IOS XE process.
name process-name (Optional) Displays the Cisco IOS XE process name.
Enter the process name.
process-id process-ID (Optional) Displayss the Cisco IOS XE process ID.
Enter the process ID.
location (Optional) Displays information about the Field
Replaceable Unit (FRU) location.
maps (Optional) Displays memory maps of a process.
smaps (Optional) Displays static memory maps of a process.
sorted (Optional) Displays the sorted output based on the
Resident Set Size (RSS) memory used by Cisco IOS
XE process.
switch switch-number Displays information about the device.
active Displays information about the active instance of the
device.
standby Displays information about the standby instance of
the device.
0 Displays information about Shared Port Adapter
(SPA)-Inter-Processor slot 0.
F0 Displays information about Embedded Service
Processor (ESP) slot 0.
R0 Displays information about Route Processor (RP) slot
0.
Command Modes Privileged EXEC (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
358
Interface and Hardware Components
show processes memory platform
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.10.1 This command was modified. The
keyword accounting was added.
The Total column was deleted from
the output.
Examples The following is a sample output from the show processes memory platform command:
device# show processes memory platform
System memory: 3976852K total, 2761580K used, 1215272K free,
Lowest: 1215272K
Pid Text Data Stack Dynamic RSS Name
----------------------------------------------------------------------------
1 1246 4400 132 1308 4400 systemd
96 233 2796 132 132 2796 systemd-journal
105 284 1796 132 176 1796 systemd-udevd
707 52 2660 132 172 2660 in.telnetd
744 968 3264 132 1700 3264 brelay.sh
835 52 2660 132 172 2660 in.telnetd
863 968 3264 132 1700 3264 brelay.sh
928 968 3996 132 2312 3996 reflector.sh
933 968 3976 132 2312 3976 droputil.sh
934 968 2140 132 528 2140 oom.sh
936 173 936 132 132 936 xinetd
945 968 1472 132 132 1472 libvirtd.sh
947 592 43164 132 3096 43164 repm
954 45 932 132 132 932 rpcbind
986 482 3476 132 132 3476 libvirtd
988 66 940 132 132 940 rpc.statd
993 968 928 132 132 928 boothelper_evt.
1017 21 640 132 132 640 inotifywait
1089 102 1200 132 132 1200 rpc.mountd
1328 9 2940 132 148 2940 rotee
1353 39 532 132 132 532 sleep
!
!
!
The following is a sample output from the show processes memory platform accounting command:
device# show processes memory platform accounting
Hourly Stats
process callsite_ID(bytes) max_diff_bytes callsite_ID(calls)
max_diff_calls tracekey timestamp(UTC)
------------------------------------------------------------------------------------------------------------------------------------------------------------
smand_rp_0 3624155137 172389 3624155138 50
1#a3e0e4361082c702e5bf1afbd90e6313 2018-09-04 14:23
linux_iosd-imag_rp_0 3626295305 49188 3624155138 12
1#545420bd869d25eb5ab826182ee5d9ce 2018-09-04 12:03
btman_rp_0 3624737792 17080 2953915394 64
1#d6888bd9564a3c4fcf049c31ba07a036 2018-09-04 22:29
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
359
Interface and Hardware Components
show processes memory platform
fman_fp_image_fp_0 3624059905 16960 4027402242 298
1#921ba4d9df5b0a6e946a3b270bd6592d 2018-09-04 22:55
fed_main_event_fp_0 3626295305 16396 4027402242 32
1#27083f7bf3985d892505806cae2bfb0d 2018-09-04 12:03
dbm_rp_0 3626295305 16396 4027402242 3
1#2b878f802bd7703c5298d37e7a4e8ac3 2018-09-04 12:02
tamd_proc_rp_0 3895208962 12632 3624667171 7
1#5b0ed8f88ef5f873abcaf8a744037a44 2018-09-04 18:47
btman_fp_0 3624233985 12288 3624737792 9
1#d6888bd9564a3c4fcf049c31ba07a036 2018-09-04 15:23
sif_mgr_rp_0 3624059907 8216 4027402242 4
1#de2a951a8a7bae83ca2c04c56810eb72 2018-09-04 14:21
python2.7_fp_0 2954560513 8000 2954560513 1
2018-09-04 12:16
nginx_rp_0 3357041665 4608 4027402242 4
1#32e56bb09e0509c5fa5ac32093631206 2018-09-04 16:18
rotee_FRU_SLOT_NUM 3624667169 4097 3624667169 1
1#ff68e5150a698cd59fa259828614995b 2018-09-04 10:43
hman_rp_0 3893617664 1488 3893617664 1
1#1c4aadada30083c5d6f66dc8ca8cd4cb 2018-09-04 10:42
tams_proc_rp_0 3895096320 1024 3895096320 1
1#a36a3afa9884c8dc4d40af1e80cacd26 2018-09-04 10:42
stack_mgr_rp_0 4027402242 904 4027402242 4
1#ca902eab11a18ab056b16554f49871e8 2018-09-04 14:21
sessmgrd_rp_0 3491618816 848 3624155138 8
1#720239fc8bddcabc059768c55a1640ed 2018-09-04 14:32
psd_rp_0 4027402242 696 4027402242 4
1#98cf04e0ddd78c2400b3ca3b5f298594 2018-09-04 14:21
lman_rp_0 4027402242 592 4027402242 4
1#dc8ed9e428d36477a617d56c51d5caf2 2018-09-04 14:21
bt_logger_rp_0 4027402242 592 4027402242 4
1#ba882be1ed783e72575e97cc0908e0e8 2018-09-04 14:21
repm_rp_0 4027402242 592 4027402242 4
1#ae461a05430efa767427f2ab40aba372 2018-09-04 14:21
fman_rp_rp_0 4027402242 592 4027402242 3
1#09def9cc1390911be9e3a7a9c89f4cf7 2018-09-04 12:16
epc_ws_liaison_fp_0 4027402242 592 4027402242 4
1#41451626dcce9d1478b22e2ebbbdcf54 2018-09-04 14:21
cli_agent_rp_0 4027402242 592 4027402242 4
1#92d3882919daf3a9e210807c61de0552 2018-09-04 14:21
cmm_rp_0 4027402242 592 4027402242 4
1#15ed1d79e96874b1e0621c42c3de6166 2018-09-04 14:21
tms_rp_0 4027402242 352 4027402242 4
1#5c6efe2e21f15aa16318576d3ec9153c 2018-09-04 12:03
plogd_rp_0 4027402242 48 4027402242 1
1#2d7f2ef57206f4fa763d7f2f5400bf1b 2018-09-04 10:43
cmand_rp_0 3624155137 17 3624155137 1
1#f1f41f61c44d73014023db5d8a46ecf5 2018-09-04 10:42
!
!
!
The following is a sample output from the show processes memory platform sorted command:
device# show processes memory platform sorted
System memory: 3976852K total, 2762884K used, 1213968K free,
Lowest: 1213968K
Pid Text Data Stack Dynamic RSS Name
--------------------------------------------------------------------------
7885 149848 684864 136 80 684864 linux_iosd-imag
9655 3787 264964 136 18004 264964 wcm
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
360
Interface and Hardware Components
show processes memory platform
17261 324 248588 132 103908 248588 fed main event
4268 391 102084 136 5596 102084 cli_agent
4856 357 93388 132 3680 93388 dbm
17067 1087 77912 136 1796 77912 platform_mgr
!
!
!
The following is sample output from the show processes memory platform sorted location switch
active R0 command:
device# show processes memory platform sorted location switch active R0
System memory: 3976852K total, 2762884K used, 1213968K free,
Lowest: 1213968K
Pid Text Data Stack Dynamic RSS Name
--------------------------------------------------------------------------
7885 149848 684864 136 80 684864 linux_iosd-imag
9655 3787 264964 136 18004 264964 wcm
17261 324 248588 132 103908 248588 fed main event
4268 391 102084 136 5596 102084 cli_agent
4856 357 93388 132 3680 93388 dbm
17067 1087 77912 136 1796 77912 platform_mgr
!
!
!
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
361
Interface and Hardware Components
show processes platform
show processes platform
To display information about the IOS-XE processes running on a platform, use the show processes platform
command in privileged EXEC mode.
show processes platform[detailed name process-name][location
switch{switch-number|active|standby}{0|F0|FP active|R0}]
detailed (Optional) Displays detailed information of the specified IOS-XE process.
name process-name (Optional) Specifies the process name.
location (Optional) Specifies the Field Replaceable Unit (FRU) location.
switch (Optional) Displays information about the switch.
switch-number
active (Optional) Specifies the active instance of the device.
standby (Optional) Specifies standby instance of the device.
0 Specifies the Shared Port Adapter (SPA) Interface Processor slot 0.
F0 Specifies the Embedded Service Processor (ESP) slot 0.
FP active Specifies the active instance in the Embedded Service Processor (ESP).
R0 Specifies the Route Processor (RP) slot 0.
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Command Modes Privileged EXEC(#)
Examples:
The following is sample output from the show processes platform command:
Device# show processes platform
CPU utilization for five seconds: 1%, one minute: 2%, five minutes: 1%
Pid PPid Status Size Name
--------------------------------------------------------
1 0 S 4876 systemd
2 0 S 0 kthreadd
3 2 S 0 ksoftirqd/0
5 2 S 0 kworker/0:0H
7 2 S 0 rcu_sched
8 2 S 0 rcu_bh
9 2 S 0 migration/0
10 2 S 0 watchdog/0
11 2 S 0 watchdog/1
12 2 S 0 migration/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
362
Interface and Hardware Components
show processes platform
13 2 S 0 ksoftirqd/1
15 2 S 0 kworker/1:0H
16 2 S 0 watchdog/2
17 2 S 0 migration/2
18 2 S 0 ksoftirqd/2
20 2 S 0 kworker/2:0H
21 2 S 0 watchdog/3
22 2 S 0 migration/3
23 2 S 0 ksoftirqd/3
24 2 S 0 kworker/3:0
25 2 S 0 kworker/3:0H
26 2 S 0 kdevtmpfs
27 2 S 0 netns
28 2 S 0 perf
29 2 S 0 khungtaskd
30 2 S 0 writeback
31 2 S 0 ksmd
32 2 S 0 khugepaged
33 2 S 0 crypto
34 2 S 0 bioset
35 2 S 0 kblockd
36 2 S 0 ata_sff
37 2 S 0 rpciod
63 2 S 0 kswapd0
64 2 S 0 vmstat
65 2 S 0 fsnotify_mark
66 2 S 0 nfsiod
74 2 S 0 bioset
75 2 S 0 bioset
76 2 S 0 bioset
77 2 S 0 bioset
78 2 S 0 bioset
79 2 S 0 bioset
80 2 S 0 bioset
81 2 S 0 bioset
82 2 S 0 bioset
83 2 S 0 bioset
84 2 S 0 bioset
85 2 S 0 bioset
86 2 S 0 bioset
87 2 S 0 bioset
88 2 S 0 bioset
89 2 S 0 bioset
90 2 S 0 bioset
91 2 S 0 bioset
92 2 S 0 bioset
93 2 S 0 bioset
94 2 S 0 bioset
95 2 S 0 bioset
96 2 S 0 bioset
97 2 S 0 bioset
100 2 S 0 ipv6_addrconf
102 2 S 0 deferwq
The table below describes the significant fields shown in the displays.
Table 28: show processes platform Field Descriptions
Field Description
Pid Displays the process ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
363
Interface and Hardware Components
show processes platform
Field Description
PPid Displays the process ID of the parent process.
Status Displays the process status in human readable form.
Size Displays the Resident Set Size (in kilobytes (KB))
that shows how much memory is allocated to that
process in the RAM.
Name Displays the command name associated with the
process. Different threads in the same process may
have different command values.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
364
Interface and Hardware Components
show power inline
show power inline
To display the Power over Ethernet (PoE) status for the specified PoE port, the specified stack member, or
for all PoE ports in the switch stack, use the show power inline command in EXEC mode.
show power inline [{police | priority}] [{interface-id | module stack-member-number}] [detail]
Syntax Description police (Optional) Displays the power policing information about
real-time power consumption.
priority (Optional) Displays the power inline port priority for each port.
interface-id (Optional) ID of the physical interface.
module stack-member-number (Optional) Limits the display to ports on the specified stack
member.
The range is 1 to 9.
This keyword is supported only on stacking-capable switches.
detail (Optional) Displays detailed output of the interface or module.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This is an example of output from the show power inline command. The table that follows describes
the output fields.
Device> show power inline
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
1 n/a n/a n/a
2 n/a n/a n/a
3 1440.0 15.4 1424.6
4 720.0 6.3 713.7
Interface Admin Oper Power Device Class Max
(Watts)
--------- ------ ---------- ------- ------------------- ----- ----
Gi3/0/1 auto off 0.0 n/a n/a 30.0
Gi3/0/2 auto off 0.0 n/a n/a 30.0
Gi3/0/3 auto off 0.0 n/a n/a 30.0
Gi3/0/4 auto off 0.0 n/a n/a 30.0
Gi3/0/5 auto off 0.0 n/a n/a 30.0
Gi3/0/6 auto off 0.0 n/a n/a 30.0
Gi3/0/7 auto off 0.0 n/a n/a 30.0
Gi3/0/8 auto off 0.0 n/a n/a 30.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
365
Interface and Hardware Components
show power inline
Gi3/0/9 auto off 0.0 n/a n/a 30.0
Gi3/0/10 auto off 0.0 n/a n/a 30.0
Gi3/0/11 auto off 0.0 n/a n/a 30.0
Gi3/0/12 auto off 0.0 n/a n/a 30.0
<output truncated>
This is an example of output from the show power inline interface-id command on a switch port:
Device> show power inline gigabitethernet1/0/1
Interface Admin Oper Power Device Class Max
(Watts)
--------- ------ ---------- ------- ------------------- ----- ----
Gi1/0/1 auto off 0.0 n/a n/a 30.0
This is an example of output from the show power inline module switch-number command on stack
member 3. The table that follows describes the output fields.
Device> show power inline module 3
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
3 865.0 864.0 1.0
Interface Admin Oper Power Device Class Max
(Watts)
--------- ------ ---------- ------- ------------------- ----- ----
Gi3/0/1 auto power-deny 4.0 n/a n/a 15.4
Gi3/0/2 auto off 0.0 n/a n/a 15.4
Gi3/0/3 auto off 0.0 n/a n/a 15.4
Gi3/0/4 auto off 0.0 n/a n/a 15.4
Gi3/0/5 auto off 0.0 n/a n/a 15.4
Gi3/0/6 auto off 0.0 n/a n/a 15.4
Gi3/0/7 auto off 0.0 n/a n/a 15.4
Gi3/0/8 auto off 0.0 n/a n/a 15.4
Gi3/0/9 auto off 0.0 n/a n/a 15.4
Gi3/0/10 auto off 0.0 n/a n/a 15.4
<output truncated>
Table 29: show power inline Field Descriptions
Field Description
Available The total amount of configured power1 on the PoE switch in watts (W).
Used The amount of configured power that is allocated to PoE ports in watts.
Remaining The amount of configured power in watts that is not allocated to ports in the system.
(Available – Used = Remaining)
Admin Administration mode: auto, off, static.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
366
Interface and Hardware Components
show power inline
Field Description
Oper Operating mode:
• on—The powered device is detected, and power is applied.
• off—No PoE is applied.
• faulty—Device detection or a powered device is in a faulty state.
• power-deny—A powered device is detected, but no PoE is available, or the
maximum wattage exceeds the detected powered-device maximum.
Power The maximum amount of power that is allocated to the powered device in watts. This
value is the same as the value in the Cutoff Power field in the show power inline police
command output.
Device The device type detected: n/a, unknown, Cisco powered-device, IEEE powered-device,
or the name from CDP.
Class The IEEE classification: n/a or a value from 0 to 4.
Max The maximum amount of power allocated to the powered device in watts.
AdminPowerMax The maximum amount power allocated to the powered device in watts when the switch
polices the real-time power consumption. This value is the same as the Max field value.
AdminConsumption The power consumption of the powered device in watts when the switch polices the
real-time power consumption. If policing is disabled, this value is the same as the
AdminPowerMax field value.
1
The configured power is the power that you manually specify or that the switch specifies by
using CDP power negotiation or the IEEE classification, which is different than the real-time
power that is monitored with the power sensing feature.
This is an example of output from the show power inline police command on a stacking-capable
switch:
Device> show power inline police
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
1 370.0 0.0 370.0
3 865.0 864.0 1.0
Admin Oper Admin Oper Cutoff Oper
Interface State State Police Police Power Power
--------- ------ ----------- ---------- ---------- ------ ------
Gi1/0/1 auto off none n/a n/a 0.0
Gi1/0/2 auto off log n/a 5.4 0.0
Gi1/0/3 auto off errdisable n/a 5.4 0.0
Gi1/0/4 off off none n/a n/a 0.0
Gi1/0/5 off off log n/a 5.4 0.0
Gi1/0/6 off off errdisable n/a 5.4 0.0
Gi1/0/7 auto off none n/a n/a 0.0
Gi1/0/8 auto off log n/a 5.4 0.0
Gi1/0/9 auto on none n/a n/a 5.1
Gi1/0/10 auto on log ok 5.4 4.2
Gi1/0/11 auto on log log 5.4 5.9
Gi1/0/12 auto on errdisable ok 5.4 4.2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
367
Interface and Hardware Components
show power inline
Gi1/0/13 auto errdisable errdisable n/a 5.4 0.0
<output truncated>
In the previous example:
• The Gi1/0/1 port is shut down, and policing is not configured.
• The Gi1/0/2 port is shut down, but policing is enabled with a policing action to generate a syslog
message.
• The Gi1/0/3 port is shut down, but policing is enabled with a policing action is to shut down
the port.
• Device detection is disabled on the Gi1/0/4 port, power is not applied to the port, and policing
is disabled.
• Device detection is disabled on the Gi1/0/5 port, and power is not applied to the port, but policing
is enabled with a policing action to generate a syslog message.
• Device detection is disabled on the Gi1/0/6 port, and power is not applied to the port, but policing
is enabled with a policing action to shut down the port.
• The Gi1/0/7 port is up, and policing is disabled, but the switch does not apply power to the
connected device.
• The Gi1/0/8 port is up, and policing is enabled with a policing action to generate a syslog
message, but the switch does not apply power to the powered device.
• The Gi1/0/9 port is up and connected to a powered device, and policing is disabled.
• The Gi1/0/10 port is up and connected to a powered device, and policing is enabled with a
policing action to generate a syslog message. The policing action does not take effect because
the real-time power consumption is less than the cutoff value.
• The Gi1/0/11 port is up and connected to a powered device, and policing is enabled with a
policing action to generate a syslog message.
• The Gi1/0/12 port is up and connected to a powered device, and policing is enabled with a
policing action to shut down the port. The policing action does not take effect because the
real-time power consumption is less than the cutoff value.
• The Gi1/0/13 port is up and connected to a powered device, and policing is enabled with a
policing action to shut down the port.
This is an example of output from the show power inline police interface-id command on a standalone
switch. The table that follows describes the output fields.
Device> show power inline police gigabitethernet1/0/1
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi1/0/1 auto off none n/a n/a 0.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
368
Interface and Hardware Components
show power inline
Table 30: show power inline police Field Descriptions
Field Description
Available The total amount of configured power2 on the switch in watts (W).
Used The amount of configured power allocated to PoE ports in watts.
Remaining The amount of configured power in watts that is not allocated to ports in the system. (Available
– Used = Remaining)
Admin State Administration mode: auto, off, static.
Oper State Operating mode:
Note The operating mode is the current PoE state for the specified PoE port, the
specified stack member, or for all PoE ports on the switch.
• errdisable—Policing is enabled.
• faulty—Device detection on a powered device is in a faulty state.
• off—No PoE is applied.
• on—The powered device is detected, and power is applied.
• power-deny—A powered device is detected, but no PoE is available, or the real-time
power consumption exceeds the maximum power allocation.
Admin Status of the real-time power-consumption policing feature:
Police
• errdisable—Policing is enabled, and the switch shuts down the port when the real-time
power consumption exceeds the maximum power allocation
.
• log—Policing is enabled, and the switch generates a syslog message when the real-time
power consumption exceeds the maximum power allocation.
• none—Policing is disabled.
Oper Police Policing status:
• errdisable—The real-time power consumption exceeds the maximum power allocation,
and the switch shuts down the PoE port.
• log—The real-time power consumption exceeds the maximum power allocation, and the
switch generates a syslog message.
•n
/a—Device detection is disabled, power is not applied to the PoE port, or no policing
action is configured.
• ok—Real-time power consumption is less than the maximum power allocation.
Cutoff Power The maximum power allocated on the port. When the real-time power consumption is greater
than this value, the switch takes the configured policing action.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
369
Interface and Hardware Components
show power inline
Field Description
Oper Power The real-time power consumption of the powered device.
2
The configured power is the power that you manually specify or that the switch specifies by
using CDP power negotiation or the IEEE classification, which is different than the real-time
power that is monitored with the power sensing feature.
This is an example of output from the show power inline priority command on a standalone switch.
Device> show power inline priority
Interface Admin Oper Priority
State State
---------- ------ ---------- --------
Gi1/0/1 auto off low
Gi1/0/2 auto off low
Gi1/0/3 auto off low
Gi1/0/4 auto off low
Gi1/0/5 auto off low
Gi1/0/6 auto off low
Gi1/0/7 auto off low
Gi1/0/8 auto off low
Gi1/0/9 auto off low
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
370
Interface and Hardware Components
show stack-power
show stack-power
To display information about StackPower stacks or switches in a power stack, use the show stack-power
command in EXEC mode.
Note Cisco Catalyst 9300L Series Switches do not support this command.
{show stack-power [{budgeting | detail | load-shedding | neighbors}] [order power-stack-name] |
[{stack-name [stack-id] | switch [switch-id]}]}
Syntax Description budgeting (Optional) Displays the stack power budget table.
detail (Optional) Displays the stack power stack details.
load-shedding (Optional) Displays the stack power load shedding table.
neighbors (Optional) Displays the stack power neighbor table.
order power-stack-name (Optional) Displays the load shedding priority for a power stack.
Note This keyword is available only after the load-shedding keyword.
stack-name (Optional) Displays budget table, details, or neighbors for all power stacks or the
specified power stack.
Note This keyword is not available after the load-shedding keyword.
stack-id (Optional) Power stack ID for the power stack. The stack ID must be 31 characters
or less.
switch (Optional) Displays budget table, details, load-shedding, or neighbors for all
switches or the specified switch.
switch-id (Optional) Switch ID for the switch. The switch number is from 1 to 9.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command is available only on switch stacks running the IP Base or IP Services image.
If a switch is shut down because of load shedding, the output of the show stack-power command still includes
the MAC address of the shutdown neighbor switch. The command output shows the stack power topology
even if there is not enough power to power a switch.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
371
Interface and Hardware Components
show stack-power
Examples This is an example of output from the show stack-power command:
Device# show stack-power
Power Stack Stack Stack Total Rsvd Alloc Unused Num Num
Name Mode Topolgy Pwr(W) Pwr(W) Pwr(W) Pwr(W) SW PS
-------------------- ------ ------- ------ ------ ------ ------ --- ---
Powerstack-1 SP-PS Stndaln 350 150 200 0 1 1
This is an example of output from the show stack-power budgeting command:
Device# show stack-power budgeting
Power Stack Stack Stack Total Rsvd Alloc Unused Num Num
Name Mode Topolgy Pwr(W) Pwr(W) Pwr(W) Pwr(W) SW PS
-------------------- ------ ------- ------ ------ ------ ------ --- ---
Powerstack-1 SP-PS Stndaln 350 150 200 0 1 1
Power Stack PS-A PS-B Power Alloc Avail Consumd Pwr
SW Name (W) (W) Budgt(W) Power(W) Pwr(W) Sys/PoE(W)
-- -------------------- ----- ----- -------- -------- ------ -----------
1 Powerstack-1 350 0 200 200 0 60 /0
-- -------------------- ----- ----- -------- -------- ------ -----------
Totals: 200 0 60 /0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
372
Interface and Hardware Components
show shell
show shell
To display shell information, use the show shell command in user EXEC mode.
show shell [{enviornment | functions [{brief shell_function}] | triggers}]
Syntax Description environment (Optional) Displays shell environment info
functions [brief |shell_function ] (Optional) Displays macro information.
• brief—Names of the shell functions.
• shell_function—Name of a shell func
triggers (Optional) Displays event trigger informat
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to display the shell information for the switch.
Example
This example shows how to use the show shell triggers command to view the event triggers in the
switch software:
Device# term shell
Device# show shell triggers
User defined triggers
---------------------
Built-in triggers
-----------------
Trigger Id: CISCO_CUSTOM_EVENT
Trigger description: Custom macroevent to apply user defined configuration
Trigger environment: User can define the macro
Trigger mapping function: CISCO_CUSTOM_AUTOSMARTPORT
Trigger Id: CISCO_DMP_EVENT
Trigger description: Digital media-player device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $ACCESS_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_DMP_AUTO_SMARTPORT
Trigger Id: CISCO_IPVSC_EVENT
Trigger description: IP-camera device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $ACCESS_VLAN=(1)
The value in parenthesis is a default value
Trigger mapping function: CISCO_IP_CAMERA_AUTO_SMARTPORT
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
373
Interface and Hardware Components
show shell
Trigger Id: CISCO_LAST_RESORT_EVENT
Trigger description: Last resortevent to apply port configuration
Trigger environment: Parameters that can be set in the shell - $ACCESS_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_LAST_RESORT_SMARTPORT
Trigger Id: CISCO_PHONE_EVENT
Trigger description: IP-phone device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $ACCESS_VLAN=(1)
and $VOICE_VLAN=(2), The value in the parenthesis is a default value
Trigger mapping function: CISCO_PHONE_AUTO_SMARTPORT
Trigger Id: CISCO_ROUTER_EVENT
Trigger description: Router device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $NATIVE_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_ROUTER_AUTO_SMARTPORT
Trigger Id: CISCO_SWITCH_ETHERCHANNEL_CONFIG
Trigger description: etherchannel parameter
Trigger environment: $INTERFACE_LIST=(),$PORT-CHANNEL_ID=(),
$EC_MODE=(),$EC_PROTOCOLTYPE=(),
PORT-CHANNEL_TYPE=()
Trigger mapping function: CISCO_ETHERCHANNEL_AUTOSMARTPORT
Trigger Id: CISCO_SWITCH_EVENT
Trigger description: Switch device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $NATIVE_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_SWITCH_AUTO_SMARTPORT
Trigger Id: CISCO_WIRELESS_AP_EVENT
Trigger description: Autonomous ap device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $NATIVE_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_AP_AUTO_SMARTPORT
Trigger Id: CISCO_WIRELESS_LIGHTWEIGHT_AP_EVENT
Trigger description: Lightweight-ap device event to apply port configuration
Trigger environment: Parameters that can be set in the shell - $ACCESS_VLAN=(1)
The value in the parenthesis is a default value
Trigger mapping function: CISCO_LWAP_AUTO_SMARTPORT
Trigger Id: word
Trigger description: word
Trigger environment:
Trigger mapping function:
This example shows how to use the show shell functions command to view the built-in macros in
the switch software:
Device# show shell functions
#User defined functions:
#Built-in functions:
function CISCO_AP_AUTO_SMARTPORT () {
if [[ $LINKUP == YES ]]; then
conf t
interface $INTERFACE
macro description $TRIGGER
switchport trunk encapsulation dot1q
switchport trunk native vlan $NATIVE_VLAN
switchport trunk allowed vlan ALL
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
374
Interface and Hardware Components
show shell
switchport mode trunk
switchport nonegotiate
auto qos voip trust
mls qos trust cos
if [[ $LIMIT == 0 ]]; then
default srr-queue bandwidth limit
else
srr-queue bandwidth limit $LIMIT
fi
if [[ $SW_POE == YES ]]; then
if [[ $AP125X == AP125X ]]; then
macro description AP125X
macro auto port sticky
power inline port maximum 20000
fi
fi
exit
end
fi
if [[ $LINKUP == NO ]]; then
conf t
interface $INTERFACE
no macro description
no switchport nonegotiate
no switchport trunk native vlan $NATIVE_VLAN
no switchport trunk allowed vlan ALL
no auto qos voip trust
no mls qos trust cos
default srr-queue bandwidth limit
if [[ $AUTH_ENABLED == NO ]]; then
no switchport mode
no switchport trunk encapsulation
fi
if [[ $STICKY == YES ]]; then
if [[ $SW_POE == YES ]]; then
if [[ $AP125X == AP125X ]]; then
no macro auto port sticky
no power inline port maximum
fi
fi
fi
exit
end
fi
}
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
375
Interface and Hardware Components
show system mtu
show system mtu
To display the global maximum transmission unit (MTU) or maximum packet size set for the switch, use the
show system mtu command in privileged EXEC mode.
show system mtu
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines For information about the MTU values and the stack configurations that affect the MTU values, see the system
mtu command.
Examples This is an example of output from the show system mtu command:
Device# show system mtu
Global Ethernet MTU is 1500 bytes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
376
Interface and Hardware Components
show tech-support
show tech-support
To automatically run show commands that display system information, use the show tech-support command
in the privilege EXEC mode.
show tech-support
[cef|cft|eigrp|evc|fnf||ipc|ipmulticast|ipsec|mfib|nat|nbar|onep|ospf|page|password|rsvp|subscriber|vrrp|wccp
Syntax Description cef (Optional) Displays CEF related information.
cft (Optional) Displays CFT related information.
eigrp (Optional) Displays EIGRP related information.
evc (Optional) Displays EVC related information.
fnf (Optional) Displays flexible netflow related information.
ipc (Optional) Displays IPC related information.
ipmulticast (Optional) Displays IP multicast related information.
ipsec (Optional) Displays IPSEC related information.
mfib (Optional) Displays MFIB related information.
nat (Optional) Displays NAT related information.
nbar (Optional) Displays NBAR related information.
onep (Optional) Displays ONEP related information.
ospf (Optional) Displays OSPF related information.
page (Optional) Displays the command output on a single page at a time. Use the Return key to
display the next line of output or use the space bar to display the next page of information. If
not used, the output scrolls (that is, it does not stop for page breaks).
Press the Ctrl-C keys to stop the command output.
password (Optional) Leaves passwords and other security information in the output. If not used, passwords
and other security-sensitive information in the output are replaced with the label "<removed>".
rsvp (Optional) Displays IP RSVP related information.
subscriber (Optional) Displays subscriber related information.
vrrp (Optional) Displays VRRP related information.
wccp (Optional) Displays WCCP related information.
Command Modes Privileged EXEC (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
377
Interface and Hardware Components
show tech-support
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was implemented.
Usage Guidelines The output from the show tech-support command is very long. To better manage this output, you can redirect
the output to a file (for example, show tech-support > filename ) in the local writable storage file system or
the remote file system. Redirecting the output to a file also makes sending the output to your Cisco Technical
Assistance Center (TAC) representative easier.
You can use one of the following redirection methods:
• > filename - Redirects the output to a file.
• >> filename - Redirects the output to a file in append mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
378
Interface and Hardware Components
show tech-support bgp
show tech-support bgp
To automatically run show commands that display BGP related system information, use the show tech-support
bgp command in the privileged EXEC mode.
show tech-support bgp [address-family {all | ipv4 [flowspec | multicast | unicast | [mdt
| mvpn] {all | vrf vrf-instance-name} ] |ipv6 [flowspec | multicast | mvpn {all | vrf
vrf-instance-name} | unicast] | l2vpn [evpn | vpls] | link-state [link-state] | [nsap |
rtfilter] [unicast] | [vpnv4 | vpnv6] [flowspec | multicast | unicast] {all | vrf
vrf-instance-name}}] [detail]
Syntax Description address-family (Optional) Displays the output for a specified address
family.
address-family all (Optional) Displays the output for all address families.
ipv4 (Optional) Displays the output for IPv4 address
family.
ipv6 (Optional) Displays the output for IPv6 address
family.
l2vpn (Optional) Displays the output for L2VPN address
family.
link-state (Optional) Displays the output for Link State address
family.
nsap (Optional) Displays the output for NSAP address
family.
rtfilter (Optional) Displays the output for RT Filter address
family.
vpnv4 (Optional) Displays the output for VPNv4 address
family.
vpnv6 (Optional) Displays the output for VPNv6 address
family.
flowspec (Optional) Displays the flowspec related information
for an address family.
multicast (Optional) Displays the multicast related information
for an address family.
unicast (Optional) Displays the unicast related information
for an address family.
mdt (Optional) Displays the Multicast Distribution Tree
(MDT) related information for an address family.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
379
Interface and Hardware Components
show tech-support bgp
mvpn (Optional) Displays the Multicast VPN (MVPN)
related information for an address family.
vrf Displays the information for a VPN
Routing/Forwarding instance.
evpn (Optional) Displays the Ethernet VPN (EVPN) related
information for an address family.
vpls (Optional) Displays the Virtual Private LAN Services
(VPLS) related information for an address family.
vrf-instance-name Specifies the name of the VPN Routing/Forwarding
instance.
all Displays the information about all VPN NLRIs.
detail (Optional) Displays the detailed routes information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The show tech-support bgp command is used to display the outputs of various BGP show commands and
log them to the show-tech file. The output from the show tech-support bgp command is very long. To better
manage this output, you can redirect the output to a file (for example, show tech-support > filename ) in
the local writable storage file system or the remote file system. Redirecting the output to a file also makes
sending the output to your Cisco Technical Assistance Center (TAC) representative easier.
You can use one of the following redirection methods:
• > filename - Redirects the output to a file.
• >> filename - Redirects the output to a file in append mode.
The following show commands run automatically when the show tech-support bgp command is used:
• show clock
• show version
• show running-config
• show process cpu sorted
• show process cpu history
• show process memory sorted
The following show commands for a specific address family run automnatically when the show tech-support
bgp address-familyaddress-family-name address-family-modifier command is used:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
380
Interface and Hardware Components
show tech-support bgp
• show bgp address-family-name address-family-modifier summary
• show bgp address-family-name address-family-modifier detail
• show bgp address-family-name address-family-modifier internal
• show bgp address-family-name address-family-modifier neighbors
• show bgp address-family-name address-family-modifier update-group
• show bgp address-family-name address-family-modifier replication
• show bgp address-family-name address-family-modifier community
• show bgp address-family-name address-family-modifier dampening dampened-paths
• show bgp address-family-name address-family-modifier dampening flap-statistics
• show bgp address-family-name address-family-modifier dampening parameters
• show bgp address-family-name address-family-modifier injected-paths
• show bgp address-family-name address-family-modifier cluster-ids
• show bgp address-family-name address-family-modifier cluster-ids internal
• show bgp address-family-name address-family-modifier peer-group
• show bgp address-family-name address-family-modifier pending-prefixes
• show bgp address-family-name address-family-modifier rib-failure
In addition to the above commands, the following segment routing specific show commands also run when
the show tech-support bgp command is used:
• show bgp all binding-sid
• show segment-routing client
• show segment-routing mpls state
• show segment-routing mpls gb
• show segment-routing mpls connected-prefix-sid-map protocol ipv4
• show segment-routing mpls connected-prefix-sid-map protocol backup ipv4
• show mpls traffic-eng tunnel auto-tunnel client bgp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
381
Interface and Hardware Components
show tech-support diagnostic
show tech-support diagnostic
To display diagnostic information for technical support, use the show tech-support diagnostic command in
privileged EXEC mode.
show tech-support diagnostic
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The output of this command is very long. To better manage this output, you can redirect the output to a file
(for example, show tech-support diagnostic > flash:filename ) in the local writable storage file system or
remote file system.
Note For devices that support stacking, this command is executed on every switch that is up. For devices that do
not support stacking, this command is executed only on the active switch.
The output of this command displays the output of the following commands:
• show clock
• show version
• show running-config
• show inventory
• show diagnostic bootup level
• show diagnostic status
• show diagnostic content switch all
• show diagnostic result switch all detail
• show diagnostic schedule switch all
• show diagnostic post
• show diagnostic description switch [switch number] test all
• show logging onboard switch [switch number] clilog detail
• show logging onboard switch [switch number] counter detail
• show logging onboard switch [switch number] environment detail
• show logging onboard switch [switch number] message detail
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
382
Interface and Hardware Components
show tech-support diagnostic
• show logging onboard switch [switch number] poe detail
• show logging onboard switch [switch number] status
• show logging onboard switch [switch number] temperature detail
• show logging onboard switch [switch number] uptime detail
• show logging onboard switch [switch number] voltage detail
Examples The following is a sample output from the show tech-support diagnostic command:
Device# show tech-support diagnostic
.
.
.
------------------ show diagnostic status ------------------
<BU> - Bootup Diagnostics, <HM> - Health Monitoring Diagnostics,
<OD> - OnDemand Diagnostics, <SCH> - Scheduled Diagnostics
====== ================================= =============================== ======
Card Description Current Running Test Run by
------ --------------------------------- ------------------------------- ------
1 C9300-24P N/A N/A
2 MODEL UNSET N/A N/A
3 MODEL UNSET N/A N/A
4 MODEL UNSET N/A N/A
5 MODEL UNSET N/A N/A
6 MODEL UNSET N/A N/A
7 MODEL UNSET N/A N/A
====== ================================= =============================== ======
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
383
Interface and Hardware Components
show tech-support diagnostic
------------------ show diagnostic content switch all ------------------
switch 1:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
Test Interval Thre-
ID Test Name Attributes day hh:mm:ss.ms shold
==== ================================== ============ =============== =====
1) DiagGoldPktTest -----------------> *BPN*X**I not configured n/a
2) DiagThermalTest -----------------> *B*N****A 000 00:01:30.00 5
3) DiagFanTest ---------------------> *B*N****A 000 00:01:30.00 5
4) DiagPhyLoopbackTest -------------> *BPD*X**I not configured n/a
5) DiagScratchRegisterTest ---------> *B*N****A 000 00:01:30.00 5
6) TestUnusedPortLoopback ----------> *BPN****I not configured n/a
7) TestPortTxMonitoring ------------> *BPN****A 000 00:01:30.00 1
8) DiagPoETest ---------------------> ***D*X**I not configured n/a
9) DiagStackCableTest --------------> ***D*X**I not configured n/a
10) DiagMemoryTest ------------------> *B*D*X**I not configured n/a
switch 2:
Diagnostics test suite attributes:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
384
Interface and Hardware Components
show tech-support diagnostic
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
Test Interval Thre-
ID Test Name Attributes day hh:mm:ss.ms shold
==== ================================== ============ =============== =====
1) DiagGoldPktTest -----------------> *BPN*X**I not configured n/a
2) DiagThermalTest -----------------> *B*N****A 000 00:01:30.00 5
3) DiagFanTest ---------------------> *B*N****A 000 00:01:30.00 5
4) DiagPhyLoopbackTest -------------> *BPD*X**I not configured n/a
5) DiagScratchRegisterTest ---------> *B*N****A 000 00:01:30.00 5
6) TestUnusedPortLoopback ----------> *BPN****I not configured n/a
7) TestPortTxMonitoring ------------> *BPN****A 000 00:01:30.00 1
8) DiagPoETest ---------------------> ***D*X**I not configured n/a
9) DiagStackCableTest --------------> ***D*X**I not configured n/a
10) DiagMemoryTest ------------------> *B*D*X**I not configured n/a
.
.
.
------------------ show logging onboard switch 4 clilog detail ------------------
--------------------------------------------------------------------------------
CLI LOGGING SUMMARY INFORMATION
--------------------------------------------------------------------------------
COUNT COMMAND
--------------------------------------------------------------------------------
No summary data to display
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
385
Interface and Hardware Components
show tech-support diagnostic
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
CLI LOGGING CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS COMMAND
--------------------------------------------------------------------------------
No continuous data
--------------------------------------------------------------------------------
------------------ show logging onboard switch 5 clilog detail ------------------
--------------------------------------------------------------------------------
CLI LOGGING SUMMARY INFORMATION
--------------------------------------------------------------------------------
COUNT COMMAND
--------------------------------------------------------------------------------
No summary data to display
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
CLI LOGGING CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS COMMAND
--------------------------------------------------------------------------------
No continuous data
--------------------------------------------------------------------------------
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
386
Interface and Hardware Components
show tech-support poe
show tech-support poe
To display the output of all the PoE-related troubleshooting commands, use the show tech-support poe
command in privileged EXEC mode. This command displays the output of the following commands:
• show clock
• show version
• show running-config
• show log
• show interface
• show interface status
• show controllers ethernet-controller
• show controllers power inline
• show cdp neighbors detail
• show llpd neighbors detail
• show post
• show platform software ilpower details
• show platform software ilpower system switch-id
• show power inline
• show power inline interface-id detail
• show power inline police
• show power inline priority
• show platform software trace message platform-mgr switch switch-number R0
• show platform software trace message fed switch switch-number
• show platform hardware fed switch switch-number fwd-asic register read register-name pimdeviceid
• show platform frontend-controller manager 0 switch-number
• show platform frontend-controller subordinate 0 switch-number
• show platform frontend-controller version 0 switch-number
• show stack-power budgeting
• show stack-power detail
Command Default This command has no arguments or keywords.
Command Modes Privileged EXEC
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
387
Interface and Hardware Components
show tech-support poe
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
This example shows the output from the show tech-support poe command:
Device# show tech-support poe
------------------ show clock ------------------
*17:39:28.741 PDT Wed Aug 22 2018
------------------ show version ------------------
Cisco IOS XE Software, Version Version 16.10.01
Cisco IOS Software [Gibraltar], Catalyst L3 Switch Software (CAT9K_LITE_IOSXE), Version
16.10.1, RELEASE SOFTWARE (fc1)
Copyright (c) 1986-2018 by Cisco Systems, Inc.
Compiled Wed 13-Jun-18 05:27 by mcpre
Cisco IOS-XE software, Copyright (c) 2005-2018 by cisco Systems, Inc.
All rights reserved. Certain components of Cisco IOS-XE software are
licensed under the GNU General Public License ("GPL") Version 2.0. The
software code licensed under GPL Version 2.0 is free software that comes
with ABSOLUTELY NO WARRANTY. You can redistribute and/or modify such
GPL code under the terms of GPL Version 2.0. For more details, see the
documentation or "License Notice" file accompanying the IOS-XE software,
or the applicable URL provided on the flyer accompanying the IOS-XE
software.
ROM: IOS-XE ROMMON
BOOTLDR: System Bootstrap, Version 8.4 DEVELOPMENT SOFTWARE
Switch uptime is 49 minutes
Uptime for this control processor is 53 minutes
System returned to ROM by Image Install
System image file is "flash:packages.conf"
Last reload reason: Image Install
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
[email protected].
Technology Package License Information:
------------------------------------------------------------------------------
Technology-package Technology-package
Current Type Next reboot
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
388
Interface and Hardware Components
show tech-support poe
------------------------------------------------------------------------------
network-essentials Smart License network-essentials
None Subscription Smart License None
cisco C9300-24T (ARM64) processor with 519006K/3071K bytes of memory.
Processor board ID JPG220200A8
1 Virtual Ethernet interface
56 Gigabit Ethernet interfaces
2048K bytes of non-volatile configuration memory.
2000996K bytes of physical memory.
819200K bytes of Crash Files at crashinfo:.
819200K bytes of Crash Files at crashinfo-2:.
1941504K bytes of Flash at flash:.
1941504K bytes of Flash at flash-2:.
0K bytes of WebUI ODM Files at webui:.
Base Ethernet MAC Address : 00:bf:77:62:62:80
Motherboard Assembly Number : 73-18700-2
Motherboard Serial Number : JAE220202YB
Model Revision Number : 15
Motherboard Revision Number : 07
Model Number : C9300-24T
System Serial Number : JPG220200A8
Switch Ports Model SW Version SW Image Mode
------ ----- ----- ---------- ---------- ----
* 1 24 C9300-24T 16.10.1 CAT9K_LITE_IOSXE INSTALL
------------------ show running-config ------------------
Building configuration...
Current configuration : 22900 bytes
!
! Last configuration change at 14:59:57 PDT Mon Sep 11 2017
!
version 16.3
no service pad
service timestamps debug datetime msec localtime show-timezone
service timestamps log datetime msec localtime show-timezone
service compress-config
no platform punt-keepalive disable-kernel-core
platform shell
!
hostname stack9-mixed2
!
!
vrf definition Mgmt-vrf
!
address-family ipv4
exit-address-family
!
address-family ipv6
exit-address-family
!
no logging monitor
!
no aaa new-model
boot system switch all flash:packages.conf
clock timezone PDT -7 0
stack-mac persistent timer 4
switch 1 provision ws-c3850-24xs
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
389
Interface and Hardware Components
show tech-support poe
!
stack-power stack Powerstack-11
mode redundant strict
!
stack-power switch 1
stack Powerstack-11
!
ip routing
!
crypto pki trustpoint TP-self-signed-2636786964
enrollment selfsigned
subject-name cn=IOS-Self-Signed-Certificate-2636786964
revocation-check none
rsakeypair TP-self-signed-2636786964
!
crypto pki certificate chain TP-self-signed-2636786964
certificate self-signed 01
30820330 30820218 A0030201 02020101 300D0609 2A864886 F70D0101 05050030
31312F30 2D060355 04031326 494F532D 53656C66 2D536967 6E65642D 43657274
69666963 6174652D 32363336 37383639 3634301E 170D3137 30333137 31383331
31325A17 0D323030 31303130 30303030 305A3031 312F302D 06035504 03132649
4F532D53 656C662D 5369676E 65642D43 65727469 66696361 74652D32 36333637
38363936 34308201 22300D06 092A8648 86F70D01 01010500 0382010F 00308201
0A028201 0100E7C5 F498308A 83FF02DB 48AC4428 2F738E43 8587DD2E D1D43918
7921617F 563890D7 35707C69 413D9F6D A160A6E2 D741C0B3 8E2969EA 9E732EA8
D3BD6B75 3465C0E6 0FAC1055 340903A5 0EF67AE4 271D73BF F6C91B39 A13C2423
9250D266 86E07FBC B41851AC 2B03B570 73300C09 0D1B15D1 E56DDA9A 4D39CDF2
0C7A0831 C634DFE8 3EA55909 D9EEFEA7 B0EB872E 0E91CA86 B90965CC 326780EA
28274CB1 EB13CA17 08959E01 8F9D25EC 4F8CE767 394E345C E870D776 10758D21
9D6BD6CD D7619DD0 28B1E6CB D1032A62 DC215510 BA58895E D3724D3C 2A8481D4
5E5129F5 65CE9105 47DCFD46 1AA7E20E 1D20E4DD 7C786428 83ACCDCE C5900822
F85AF081 FF130203 010001A3 53305130 0F060355 1D130101 FF040530 030101FF
301F0603 551D2304 18301680 149EE39D 6B4CC129 72868658 69880994 7AC71912
04301D06 03551D0E 04160414 9EE39D6B 4CC12972 86865869 8809947A C7191204
300D0609 2A864886 F70D0101 05050003 82010100 C42EAF92 1D2324B9 2B0153DD
A85E607E FA9FA0AD BB677982 B5DAC3F7 DE938EC9 6F948385 9916A359 AF2BBA86
06F04B7E 5B736DD7 CDD89067 1887C177 9241CDF5 0943000D D940F982 55F3DD8A
9E52167E 64074D23 A1E93445 1B60E4A0 D923F5FA 19064241 E575D6B9 7E1CCE9C
3957A4C7 67F86FE4 3CC37107 B003873A 3D986787 7DF29056 29D42E30 4AE1D7AC
3DABD1E8 940DDDF9 C14DCE35 71C79000 A7AF6B28 AD050608 4E7B16CB 7ED8D32E
FB4B5FF8 CDA2FFCD 3FDAFEF6 AC279A80 03A7FC31 FEB27C2F D7AEFCAE 1B01850F
AEEAC787 1F1B6BBB 380AA70F CACE89AF 3B0096B6 05906C96 8D004FDC D35AECFC
A644C0AF 4F874C6D 67F5769E A6147323 D199FE63
quit
!
errdisable recovery cause inline-power
errdisable recovery interval 30
license boot level ipservicesk9
diagnostic bootup level minimal
spanning-tree mode rapid-pvst
spanning-tree extend system-id
!
redundancy
mode sso
!
class-map match-any system-cpp-police-topology-control
description Topology control
class-map match-any system-cpp-police-sw-forward
description Sw forwarding, L2 LVX data, LOGGING
class-map match-any system-cpp-default
description EWLC control, EWCL data
!
policy-map port_child_policy
class non-client-nrt-class
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
390
Interface and Hardware Components
show tech-support poe
bandwidth remaining ratio 10
policy-map system-cpp-policy
class system-cpp-police-data
police rate 600 pps
class system-cpp-police-sys-data
police rate 100 pps
!
interface Port-channel1
no switchport
no ip address
!
interface GigabitEthernet0/0
vrf forwarding Mgmt-vrf
ip address 10.5.49.131 255.255.255.0
negotiation auto
!
interface FortyGigabitEthernet1/1/1
!
interface TenGigabitEthernet1/0/1
!
interface FortyGigabitEthernet2/1/1
shutdown
!
interface TenGigabitEthernet2/1/1
shutdown
!
interface GigabitEthernet3/0/40
shutdown
!
interface GigabitEthernet9/0/1
power inline port poe-ha
!
interface GigabitEthernet9/0/11
power inline port priority high
!
interface Vlan1
no ip address
!
ip forward-protocol nd
ip http server
ip http authentication local
ip http secure-server
!
ip tftp source-interface GigabitEthernet0/0
ip route 20.20.20.0 255.255.255.0 2.2.2.3
ip ssh time-out 60
ip ssh authentication-retries 2
ip ssh version 2
ip ssh server algorithm encryption aes128-ctr aes192-ctr aes256-ctr
ip ssh client algorithm encryption aes128-ctr aes192-ctr aes256-ctr
!
ip access-list extended AutoQos-4.0-wlan-Acl-Bulk-Data
permit tcp any any eq 22
permit tcp any any eq 465
permit tcp any any eq 143
permit tcp any any eq 993
permit tcp any any eq 995
permit tcp any any eq 1914
permit tcp any any eq ftp
permit tcp any any eq ftp-data
permit tcp any any eq smtp
permit tcp any any eq pop3
ip access-list extended AutoQos-4.0-wlan-Acl-MultiEnhanced-Conf
permit udp any any range 16384 32767
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
391
Interface and Hardware Components
show tech-support poe
permit tcp any any range 50000 59999
ip access-list extended AutoQos-4.0-wlan-Acl-Scavanger
permit tcp any any range 2300 2400
permit udp any any range 2300 2400
permit tcp any any range 6881 6999
permit tcp any any range 28800 29100
permit tcp any any eq 1214
permit udp any any eq 1214
permit tcp any any eq 3689
permit udp any any eq 3689
permit tcp any any eq 11999
ip access-list extended AutoQos-4.0-wlan-Acl-Signaling
permit tcp any any range 2000 2002
permit tcp any any range 5060 5061
permit udp any any range 5060 5061
ip access-list extended AutoQos-4.0-wlan-Acl-Transactional-Data
permit tcp any any eq 443
permit tcp any any eq 1521
permit udp any any eq 1521
permit tcp any any eq 1526
permit udp any any eq 1526
permit tcp any any eq 1575
permit udp any any eq 1575
permit tcp any any eq 1630
permit udp any any eq 1630
permit tcp any any eq 1527
permit tcp any any eq 6200
permit tcp any any eq 3389
permit tcp any any eq 5985
permit tcp any any eq 8080
!
control-plane
service-policy input system-cpp-policy
!
!
no vstack
!
line con 0
exec-timeout 0 0
stopbits 1
speed 115200
line aux 0
stopbits 1
line vty 0 4
login
line vty 5 15
login
!
!
mac address-table notification mac-move
wsma agent exec
profile httplistener
profile httpslistener
!
wsma agent config
profile httplistener
profile httpslistener
!
wsma agent filesys
profile httplistener
profile httpslistener
!
wsma agent notify
profile httplistener
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
392
Interface and Hardware Components
show tech-support poe
profile httpslistener
!
!
wsma profile listener httplistener
transport http
!
wsma profile listener httpslistener
transport https
!
ap dot11 airtime-fairness policy-name Default 0
ap group default-group
ap hyperlocation ble-beacon 0
ap hyperlocation ble-beacon 1
ap hyperlocation ble-beacon 2
ap hyperlocation ble-beacon 3
ap hyperlocation ble-beacon 4
end
------------------ show log ------------------
Syslog logging: enabled (0 messages dropped, 16 messages rate-limited, 0 flushes, 0 overruns,
xml disabled, filtering disabled)
No Active Message Discriminator.
No Inactive Message Discriminator.
Console logging: disabled
Monitor logging: level debugging, 0 messages logged, xml disabled,
filtering disabled
Buffer logging: level debugging, 782 messages logged, xml disabled,
filtering disabled
Exception Logging: size (4096 bytes)
Count and timestamp logging messages: disabled
File logging: disabled
Persistent logging: disabled
No active filter modules.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
393
Interface and Hardware Components
show tech-support poe
Trap logging: level informational, 310 message lines logged
Logging Source-Interface: VRF Name:
Log Buffer (4096 bytes):
rev) PD Class : Class 3/
(curr/prev) PD Priority : low/unknown
(curr/prev) Power Type : Type 2 PSE/Type 2 PSE
(curr/prev) mdi_pwr_support: 15/0
(curr/prev Power Pair) : Signal/
(curr/prev) PSE Pwr Source : Primary/Unknown
Aug 22 17:17:28.966 PDT: %LINK-3-UPDOWN: Interface FiveGigabitEthernet1/0/1, changed state
to down
Aug 22 17:17:29.196 PDT: %ILPOWER-5-POWER_GRANTED: Interface Fi1/0/1: Power granted
Aug 22 17:17:47.209 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:17:50.200 PDT: %ILPOWER-7-DETECT: Interface Fi1/0/1: Power Device detected: IEEE
PD
Aug 22 17:17:51.822 PDT: %ILPOWER-5-POWER_GRANTED: Interface Fi1/0/1: Power granted
Aug 22 17:17:52.321 PDT: ilpower delete power from pd linkdown Fi1/0/1
Aug 22 17:17:52.321 PDT: Ilpower interface (Fi1/0/1), delete allocated power 15400
Aug 22 17:17:52.321 PDT: Ilpower interface (Fi1/0/1) setting ICUT_OFF threshold to 0.
Aug 22 17:17:52.321 PDT: ilpower_notify_lldp_power_via_mdi_tlv Fi1/0/1 pwr alloc 0
Aug 22 17:17:52.321 PDT: Fi1/0/1 AUTO PORT PWR Alloc 130 Request 130
Aug 22 17:17:52.321 PDT: Fi1/0/1: LLDP NOTIFY TLV:
(curr/prev) PSE Allocation(mW): 13000/0
(curr/prev) PD Request(mW) : 13000/0
(curr/prev) PD Class : Class 3/
(curr/prev) PD Priority : low/unknown
(curr/prev) Power Type : Type 2 PSE/Type 2 PSE
(curr/prev) mdi_pwr_support: 15/0
(curr/prev Power Pair) : Signal/
(curr/prev) PSE Pwr Source : Primary/Unknown
Aug 22 17:17:52.321 PDT: ILP notify LLDB-TLV: lldp power class tlv:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
394
Interface and Hardware Components
show tech-support poe
Aug 22 17:17:52.321 PDT: (curr/prev) pwr value 15400/0
Aug 22 17:17:52.322 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:17:54.323 PDT: %LINK-5-CHANGED: Interface FiveGigabitEthernet1/0/1, changed state
to administratively down
Aug 22 17:18:11.981 PDT: ILP notify LLDB-TLV: lldp power class tlv:
Aug 22 17:18:11.981 PDT: (curr/prev) pwr value 15400/0
Aug 22 17:18:11.982 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:18:13.207 PDT: %ILPOWER-7-DETECT: Interface Fi1/0/1: Power Device detected: IEEE
PD
Aug 22 17:18:13.207 PDT: (Fi1/0/1) data power pool 1
Aug 22 17:18:13.207 PDT: Ilpower PD device 3 class 6 from interface (Fi1/0/1)
Aug 22 17:18:13.207 PDT: (Fi1/0/1) state auto
Aug 22 17:18:13.207 PDT: (Fi1/0/1) data power pool: 1, pool 1
Aug 22 17:18:13.207 PDT: (Fi1/0/1) curr pwr usage 15400
Aug 22 17:18:13.207 PDT: (Fi1/0/1) req pwr 15400
Aug 22 17:18:13.207 PDT: (Fi1/0/1) total pwr 610000
Aug 22 17:18:13.207 PDT: (Fi1/0/1) power_status OK
Aug 22 17:18:13.207 PDT: ilpower new power from pd discovery Fi1/0/1, power_status ok
Aug 22 17:18:13.207 PDT: Ilpower interface (Fi1/0/1) power status change, allocated power
15400
Aug 22 17:18:13.207 PDT: ILP notify LLDB-TLV: lldp power class tlv:
Aug 22 17:18:13.207 PDT: (curr/prev) pwr value 15400/0
Aug 22 17:18:13.208 PDT: ilpower_notify_lldp_power_via_mdi_tlv Fi1/0/1 pwr alloc 15400
Aug 22 17:18:13.208 PDT: Fi1/0/1 AUTO PORT PWR Alloc 130 Request 130
Aug 22 17:18:13.208 PDT: Fi1/0/1: LLDP NOTIFY TLV:
(curr/prev) PSE Allocation(mW): 13000/0
(curr/prev) PD Request(mW) : 13000/0
(curr/prev) PD Class : Class 3/
(curr/prev) PD Priority : low/unknown
(curr/prev) Power Type : Type 2 PSE/Type 2 PSE
(curr/prev) mdi_pwr_support: 15/0
(curr/prev Power Pair) : Signal/
(curr/prev) PSE Pwr Source : Primary/Unknown
Aug 22 17:18:13.981 PDT: %LINK-3-UPDOWN: Interface FiveGigabitEthernet1/0/1, changed state
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
395
Interface and Hardware Components
show tech-support poe
to down
Aug 22 17:18:14.207 PDT: %ILPOWER-5-POWER_GRANTED: Interface Fi1/0/1: Power granted
Aug 22 17:18:32.180 PDT: %SYS-5-LOG_CONFIG_CHANGE: Console logging disabled
Aug 22 17:18:32.242 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:47:45.133 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:47:45.717 PDT: %SYS-5-CONFIG_I: Configured from console by console
Aug 22 17:47:45.000 PDT: %SYS-6-CLOCKUPDATE: System clock has been updated from 17:47:45
PDT Wed Aug 22 2018 to 17:47:45 PDT Wed Aug 22 2018, configured from console by console.
------------------ show interface status ------------------
Port Name Status Vlan Duplex Speed Type
Fi1/0/1 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/2 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/3 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/4 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/5 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/6 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/7 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/8 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/9 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/10 notconnect 100 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/11 notconnect 100 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/12 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/13 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/14 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/15 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/16 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/17 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/18 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/19 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
396
Interface and Hardware Components
show tech-support poe
Fi1/0/20 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/21 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/22 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/23 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/24 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/25 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/26 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/27 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/28 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/29 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/30 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/31 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/32 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/33 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/34 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/35 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/36 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/37 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/38 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/39 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/40 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/41 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/42 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/43 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/44 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/45 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/46 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/47 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Fi1/0/48 notconnect 1 auto auto 100/1000/2.5G/5GBaseTX
Te1/1/1 notconnect 1 auto auto unknown
Te1/1/2 notconnect 1 auto auto unknown
Te1/1/3 notconnect 1 auto auto unknown
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
397
Interface and Hardware Components
show tech-support poe
Te1/1/4 notconnect 1 auto auto unknown
Po1 notconnect unassigned auto auto N/A
Po100 notconnect unassigned auto auto N/A
------------------ show controllers ethernet-controller phy detail ------------------
Fi1/0/1 (if_id: 7)
------------------------------------------------
00e0 : 1140 Control Register : 0001 0001 0100 0000
00e1 : 7969 Control Status : 0111 1001 0110 1001
00e2 : ae02 Phy ID 1 : 1010 1110 0000 0010
00e3 : 5161 Phy ID 2 : 0101 0001 0110 0001
00e4 : 9181 Auto-Negotiation Advertisement : 1001 0001 1000 0001
00e5 : c1e1 Auto-Negotiation Link Partner : 1100 0001 1110 0001
00e6 : 006f Auto-Negotiation Expansion Reg : 0000 0000 0110 1111
00e7 : 0000 Next Page Transmit Register : 0000 0000 0000 0000
00e8 : 6801 Link Partner Next page Register : 0110 1000 0000 0001
00e9 : 0600 PHY Control Register : 0000 0110 0000 0000
00ea : 3800 PHY Control Status : 0011 1000 0000 0000
00f0 : 0001 PHY Specific Control : 0000 0000 0000 0001
00f1 : 2301 PHY Specific Status : 0010 0011 0000 0001
0000 : 3000 AN Control Register : 0011 0000 0000 0000
0001 : 002d AN Control Status : 0000 0000 0010 1101
0010 : 9181 AN Advertisement : 1001 0001 1000 0001
0013 : c1e1 AN Link Partner : 1100 0001 1110 0001
0016 : 2001 AN Next Page Transmit : 0010 0000 0000 0001
0019 : 0000 AN Link Partner Next page : 0000 0000 0000 0000
0020 : 21e3 AN Specific Control : 0010 0001 1110 0011
0021 : 0000 AN Specific Status : 0000 0000 0000 0000
000d : 4032 Global Status : 0100 0000 0011 0010
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
398
Interface and Hardware Components
show tech-support poe
003b : 8400 MGBASE-T LED Control : 1000 0100 0000 0000
003c : 0040 MGBASE-T LED Ctrl status : 0000 0000 0100 0000
003d : 0000 MGBASE-T LED Ctrl High status : 0000 0000 0000 0000
------------------ show cdp neighbors detail ------------------
% CDP is not enabled
------------------ show lldp neighbors detail ------------------
% LLDP is not enabled
------------------ show post ------------------
Stored system POST messages:
Switch 1
---------
POST: MBIST Tests : Begin
POST: MBIST Tests : End, Status Passed
POST: CRYPTO Tests : Begin
POST: CRYPTO Tests : End, Status Passed
POST: PHY Loopback: loopback Test : Begin
POST: PHY Loopback: loopback Test : End, Status Passed
POST: Inline Power Controller Tests : Begin
POST: Inline Power Controller Tests : End, Status Passed
POST: Thermal, Temperature Tests : Begin
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
399
Interface and Hardware Components
show tech-support poe
POST: Thermal, Temperature Tests : End, Status Passed
POST: Thermal, Fan Tests : Begin
POST: Thermal, Fan Tests : End, Status Passed
POST: SIF Tests : Begin
POST: SIF Tests : End, Status Passed
------------------ show power inline ------------------
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
1 610.0 15.4 594.6
Interface Admin Oper Power Device Class Max
(Watts)
--------- ------ ---------- ------- ------------------- ----- ----
Fi1/0/1 auto on 15.4 Ieee PD 3 60.0
Fi1/0/2 auto off 0.0 n/a n/a 60.0
Fi1/0/3 auto off 0.0 n/a n/a 60.0
Fi1/0/4 auto off 0.0 n/a n/a 60.0
Fi1/0/5 auto off 0.0 n/a n/a 60.0
Fi1/0/6 auto off 0.0 n/a n/a 60.0
Fi1/0/7 auto off 0.0 n/a n/a 60.0
Fi1/0/8 auto off 0.0 n/a n/a 60.0
Fi1/0/9 auto off 0.0 n/a n/a 60.0
Fi1/0/10 auto off 0.0 n/a n/a 60.0
Fi1/0/11 auto off 0.0 n/a n/a 60.0
Fi1/0/12 auto off 0.0 n/a n/a 60.0
Fi1/0/13 auto off 0.0 n/a n/a 60.0
Fi1/0/14 auto off 0.0 n/a n/a 60.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
400
Interface and Hardware Components
show tech-support poe
Fi1/0/15 auto off 0.0 n/a n/a 60.0
Fi1/0/16 auto off 0.0 n/a n/a 60.0
Fi1/0/17 auto off 0.0 n/a n/a 60.0
Fi1/0/18 auto off 0.0 n/a n/a 60.0
Fi1/0/19 auto off 0.0 n/a n/a 60.0
Fi1/0/20 auto off 0.0 n/a n/a 60.0
Fi1/0/21 auto off 0.0 n/a n/a 60.0
Fi1/0/22 auto off 0.0 n/a n/a 60.0
Fi1/0/23 auto off 0.0 n/a n/a 60.0
Fi1/0/24 auto off 0.0 n/a n/a 60.0
Fi1/0/25 auto off 0.0 n/a n/a 60.0
Fi1/0/26 auto off 0.0 n/a n/a 60.0
Fi1/0/27 auto off 0.0 n/a n/a 60.0
Fi1/0/28 auto off 0.0 n/a n/a 60.0
Fi1/0/29 auto off 0.0 n/a n/a 60.0
Fi1/0/30 auto off 0.0 n/a n/a 60.0
Fi1/0/31 auto off 0.0 n/a n/a 60.0
Fi1/0/32 auto off 0.0 n/a n/a 60.0
Fi1/0/33 auto off 0.0 n/a n/a 60.0
Fi1/0/34 auto off 0.0 n/a n/a 60.0
Fi1/0/35 auto off 0.0 n/a n/a 60.0
Fi1/0/36 auto off 0.0 n/a n/a 60.0
Fi1/0/37 auto off 0.0 n/a n/a 60.0
Fi1/0/38 auto off 0.0 n/a n/a 60.0
Fi1/0/39 auto off 0.0 n/a n/a 60.0
Fi1/0/40 auto off 0.0 n/a n/a 60.0
Fi1/0/41 auto off 0.0 n/a n/a 60.0
Fi1/0/42 auto off 0.0 n/a n/a 60.0
Fi1/0/43 auto off 0.0 n/a n/a 60.0
Fi1/0/44 auto off 0.0 n/a n/a 60.0
Fi1/0/45 auto off 0.0 n/a n/a 60.0
Fi1/0/46 auto off 0.0 n/a n/a 60.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
401
Interface and Hardware Components
show tech-support poe
Fi1/0/47 auto off 0.0 n/a n/a 60.0
Fi1/0/48 auto off 0.0 n/a n/a 60.0
------------------ show power inline police ------------------
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
1 610.0 15.4 594.6
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Fi1/0/1 auto on none n/a n/a 9.3
Fi1/0/2 auto off none n/a n/a n/a
Fi1/0/3 auto off none n/a n/a n/a
Fi1/0/4 auto off none n/a n/a n/a
Fi1/0/5 auto off none n/a n/a n/a
Fi1/0/6 auto off none n/a n/a n/a
Fi1/0/7 auto off none n/a n/a n/a
Fi1/0/8 auto off none n/a n/a n/a
Fi1/0/9 auto off none n/a n/a n/a
Fi1/0/10 auto off none n/a n/a n/a
Fi1/0/11 auto off none n/a n/a n/a
Fi1/0/12 auto off none n/a n/a n/a
Fi1/0/13 auto off none n/a n/a n/a
Fi1/0/14 auto off none n/a n/a n/a
Fi1/0/15 auto off none n/a n/a n/a
Fi1/0/16 auto off none n/a n/a n/a
Fi1/0/17 auto off none n/a n/a n/a
Fi1/0/18 auto off none n/a n/a n/a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
402
Interface and Hardware Components
show tech-support poe
Fi1/0/19 auto off none n/a n/a n/a
Fi1/0/20 auto off none n/a n/a n/a
Fi1/0/21 auto off none n/a n/a n/a
Fi1/0/22 auto off none n/a n/a n/a
Fi1/0/23 auto off none n/a n/a n/a
Fi1/0/24 auto off none n/a n/a n/a
Fi1/0/25 auto off none n/a n/a n/a
Fi1/0/26 auto off none n/a n/a n/a
Fi1/0/27 auto off none n/a n/a n/a
Fi1/0/28 auto off none n/a n/a n/a
Fi1/0/29 auto off none n/a n/a n/a
Fi1/0/30 auto off none n/a n/a n/a
Fi1/0/31 auto off none n/a n/a n/a
Fi1/0/32 auto off none n/a n/a n/a
Fi1/0/33 auto off none n/a n/a n/a
Fi1/0/34 auto off none n/a n/a n/a
Fi1/0/35 auto off none n/a n/a n/a
Fi1/0/36 auto off none n/a n/a n/a
Fi1/0/37 auto off none n/a n/a n/a
Fi1/0/38 auto off none n/a n/a n/a
Fi1/0/39 auto off none n/a n/a n/a
Fi1/0/40 auto off none n/a n/a n/a
Fi1/0/41 auto off none n/a n/a n/a
Fi1/0/42 auto off none n/a n/a n/a
Fi1/0/43 auto off none n/a n/a n/a
Fi1/0/44 auto off none n/a n/a n/a
Fi1/0/45 auto off none n/a n/a n/a
Fi1/0/46 auto off none n/a n/a n/a
Fi1/0/47 auto off none n/a n/a n/a
Fi1/0/48 auto off none n/a n/a n/a
--------- ------ ---------- ---------- ---------- ------ -----
Totals: 9.3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
403
Interface and Hardware Components
show tech-support poe
------------------ show power inline priority ------------------
Interface Admin Oper Admin
State State Priority
---------- ------ ---------- ----------
Fi1/0/1 auto on low
Fi1/0/2 auto off low
Fi1/0/3 auto off low
Fi1/0/4 auto off low
Fi1/0/5 auto off low
Fi1/0/6 auto off low
Fi1/0/7 auto off low
Fi1/0/8 auto off low
Fi1/0/9 auto off low
Fi1/0/10 auto off low
Fi1/0/11 auto off low
Fi1/0/12 auto off low
Fi1/0/13 auto off low
Fi1/0/14 auto off low
Fi1/0/15 auto off low
Fi1/0/16 auto off low
Fi1/0/17 auto off low
Fi1/0/18 auto off low
Fi1/0/19 auto off low
Fi1/0/20 auto off low
Fi1/0/21 auto off low
Fi1/0/22 auto off low
Fi1/0/23 auto off low
Fi1/0/24 auto off low
Fi1/0/25 auto off low
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
404
Interface and Hardware Components
show tech-support poe
Fi1/0/26 auto off low
Fi1/0/27 auto off low
Fi1/0/28 auto off low
Fi1/0/29 auto off low
Fi1/0/30 auto off low
Fi1/0/31 auto off low
Fi1/0/32 auto off low
Fi1/0/33 auto off low
Fi1/0/34 auto off low
Fi1/0/35 auto off low
Fi1/0/36 auto off low
Fi1/0/37 auto off low
Fi1/0/38 auto off low
Fi1/0/39 auto off low
Fi1/0/40 auto off low
Fi1/0/41 auto off low
Fi1/0/42 auto off low
Fi1/0/43 auto off low
Fi1/0/44 auto off low
Fi1/0/45 auto off low
Fi1/0/46 auto off low
Fi1/0/47 auto off low
Fi1/0/48 auto off low
------------------ show interface ------------------
Vlan1 is administratively down, line protocol is down , Autostate Enabled
Hardware is Ethernet SVI, address is f8b7.e24f.37c7 (bia f8b7.e24f.37c7)
MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive not supported
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
405
Interface and Hardware Components
show tech-support poe
Last clearing of "show interface" counters never
Input queue: 0/375/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts (0 IP multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 packets output, 0 bytes, 0 underruns
0 output errors, 1 interface resets
0 unknown protocol drops
0 output buffer failures, 0 output buffers swapped out
GigabitEthernet0/0 is up, line protocol is up
Hardware is RP management port, address is f8b7.e24f.3780 (bia f8b7.e24f.3780)
Internet address is 10.8.40.172/16
MTU 1500 bytes, BW 100000 Kbit/sec, DLY 100 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Full Duplex, 100Mbps, link type is auto, media type is RJ45
output flow-control is unsupported, input flow-control is unsupported
ARP type: ARPA, ARP Timeout 04:00:00
Last input 00:00:00, output 00:01:47, output hang never
Last clearing of "show interface" counters never
Input queue: 0/75/2531/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 5000 bits/sec, 3 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
1636640 packets input, 321164654 bytes, 0 no buffer
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
406
Interface and Hardware Components
show tech-support poe
Received 0 broadcasts (0 IP multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 watchdog, 0 multicast, 0 pause input
7641 packets output, 2207212 bytes, 0 underruns
0 output errors, 0 collisions, 0 interface resets
1414 unknown protocol drops
0 babbles, 0 late collision, 0 deferred
0 lost carrier, 0 no carrier, 0 pause output
0 output buffer failures, 0 output buffers swapped out
0 carrier transitions
FiveGigabitEthernet1/0/1 is down, line protocol is down (notconnect)
Hardware is Five Gigabit Ethernet, address is f8b7.e24f.3781 (bia f8b7.e24f.3781)
MTU 1500 bytes, BW 5000000 Kbit/sec, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Auto-duplex, Auto-speed, media type is 100/1000/2.5G/5GBaseTX
input flow-control is on, output flow-control is unsupported
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts (0 multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 watchdog, 0 multicast, 0 pause input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
407
Interface and Hardware Components
show tech-support poe
0 input packets with dribble condition detected
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 collisions, 29 interface resets
0 unknown protocol drops
0 babbles, 0 late collision, 0 deferred
0 lost carrier, 0 no carrier, 0 pause output
0 output buffer failures, 0 output buffers swapped out
------------------ show controllers power inline module 1 ------------------
Alchemy instance 0, address 0
Pending event flag : N N N N N N N N N N N N N N N N
Current State : 51 11 11 11 11 11 11 11
Current Event : 10 00 00 00 00 00 00 00
Timers : 00 19 19 1B 1B 1D 1D 1F 1F 21 21 23 23 25 25 27
Error State : 00 00 00 00 00 00 00 00
Error Code : 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Power Status : Y N N N N N N N N N N N N N N N
Auto Config : Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
Disconnect : N N N N N N N N N N N N N N N N
Detection Status : 40 00 00 00 00 00 00 00
Current Class : 30 00 00 00 00 00 00 00
Tweetie debug : FF 00 00 00
POE Commands pending at sub:
Command 0 on each port : 00 00 00 00 00 00 00 00
Command 1 on each port : 00 00 00 00 00 00 00 00
Command 2 on each port : 00 00 00 00 00 00 00 00
Command 3 on each port : 00 00 00 00 00 00 00 00
Alchemy instance 1, address 7
------------------ show stack-power budgeting ------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
408
Interface and Hardware Components
show tech-support poe
Power Stack Stack Stack Total Rsvd Alloc Unused Num Num
Name Mode Topolgy Pwr(W) Pwr(W) Pwr(W) Pwr(W) SW PS
-------------------- ------ ------- ------ ------ ------ ------ --- ---
Powerstack-1 SP-PS Stndaln 1100 30 475 595 1 1
Power Stack PS-A PS-B Power Alloc Avail Consumd Pwr
SW Name (W) (W) Budgt(W) Power(W) Pwr(W) Sys/PoE(W)
-- -------------------- ----- ----- -------- -------- ------ -----------
1 Powerstack-1 0 1100 1070 475 595 145 /9
-- -------------------- ----- ----- -------- -------- ------ -----------
Totals: 475 595 145 /9
------------------ show stack-power detail ------------------
Power Stack Stack Stack Total Rsvd Alloc Unused Num Num
Name Mode Topolgy Pwr(W) Pwr(W) Pwr(W) Pwr(W) SW PS
-------------------- ------ ------- ------ ------ ------ ------ --- ---
Powerstack-1 SP-PS Stndaln 1100 30 475 595 1 1
Power stack name: Powerstack-1
Stack mode: Power sharing
Stack topology: Standalone
Switch 1:
Power budget: 1070
Power allocated: 475
Low port priority value: 22
High port priority value: 13
Switch priority value: 4
Port 1 status: Shut
Port 2 status: Shut
Neighbor on port 1: 0000.0000.0000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
409
Interface and Hardware Components
show tech-support poe
Neighbor on port 2: 0000.0000.0000
------------------ show controllers power inline module 1 ------------------
Alchemy instance 0, address 0
Pending event flag : N N N N N N N N N N N N
Current State : 00 00 10 93 D8 E8
Current Event : 11 11 14 00 00 00
Timers : 22 00 00 00 00 00 00 00 00 00 00 00
Error State : 14 14 14 14 14 14
Error Code : 00 00 00 00 00 00 00 00 00 00 00 00
Power Status : N N N N N N N N N N N N
Auto Config : N N N N N N N N N N N N
Disconnect : N N N N N N N N N N N N
Detection Status : F0 00 10 00 00 00
Current Class : 00 00 00 00 00 00
Tweetie debug : 00 00 00 00
POE Commands pending at sub:
Command 0 on each port : 00 00 00 00 00 00
Command 1 on each port : 00 00 00 00 00 00
Command 2 on each port : 00 00 00 00 00 00
Command 3 on each port : 00 00 00 00 00 00
Alchemy instance 1, address E
Pending event flag : N N N N N N N N N N N N
Current State : 00 00 10 93 D8 E8
Current Event : 11 11 11 00 00 00
Timers : 2A 00 00 00 00 00 00 00 00 00 00 00
Error State : 26 26 26 26 26 2A
Error Code : 00 00 00 00 00 00 00 00 00 00 00 00
Power Status : N N N N N N N N N N N N
Auto Config : N N N N N N N N N N N N
Disconnect : N N N N N N N N N N N N
Detection Status : F0 00 00 00 00 00
Current Class : 00 00 00 00 00 00
Tweetie debug : 00 00 00 00
POE Commands pending at sub:
Command 0 on each port : 00 00 00 00 00 00
Command 1 on each port : 00 00 00 00 00 00
Command 2 on each port : 00 00 00 00 00 00
Command 3 on each port : 00 00 00 00 00 00
------------------ show stack-power detail ------------------
Power Stack Stack Stack Total Rsvd Alloc Unused Num Num
Name Mode Topolgy Pwr(W) Pwr(W) Pwr(W) Pwr(W) SW PS
-------------------- ------ ------- ------ ------ ------ ------ --- ---
Powerstack-1 SP-PS Stndaln 1100 30 475 595 1 1
Power stack name: Powerstack-1
Stack mode: Power sharing
Stack topology: Standalone
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
410
Interface and Hardware Components
show tech-support poe
Switch 1:
Power budget: 1070
Power allocated: 475
Low port priority value: 22
High port priority value: 13
Switch priority value: 4
Port 1 status: Shut
Port 2 status: Shut
Neighbor on port 1: 0000.0000.0000
Neighbor on port 2: 0000.0000.0000
------------------ show platform software ilpower details ------------------
ILP Port Configuration for interface Te2/0/1
Initialization Done: Yes
ILP Supported: Yes
ILP Enabled: Yes
POST: Yes
Detect On: No
Powered Device Detected Yes
Powered Device Class Done No
Cisco Powered Device: No
Power is On: No
Power Denied: No
Powered Device Type: Null
Powerd Device Class: Null
Power State: Off
Current State: NGWC_ILP_DETECTING_S
Previous State: NGWC_ILP_DETECTING_S
Requested Power in milli watts: 0
Short Circuit Detected: 0
Short Circuit Count: 0
Cisco Powerd Device Detect Count: 0
Spare Pair mode: 0
Spare Pair Architecture: 1
Signal Pair Power allocation in milli watts: 0
Spare Pair Power On: 0
Powered Device power state: 0
Timer:
Power Good: Stopped
Power Denied: Stopped
Cisco Powered Device Detect: Stopped
IEEE Detect: Stopped
IEEE Short: Stopped
Link Down: Stopped
Voltage sense: Stopped
------------------ show platform software ilpower system 3 ------------------
ILP System Configuration
Slot: 3
ILP Supported: Yes
Total Power: 1101000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
411
Interface and Hardware Components
show tech-support poe
Used Power: 49400
Initialization Done: Yes
Post Done: Yes
Post Result Logged: No
Post Result: Success
Power Summary:
Module: 0
Power Total: 1101000
Power Used: 49400
Power Threshold: 0
Operation Status: On
Pool: 3
Pool Valid: Yes
Total Power: 1101000
Power Usage: 49400
------------------ show platform hardware fed switch 1 fwd-asic register read register-name
pimdeviceid ------------------
For asic 0 core 0
------------------ show platform software trace message platform-mgr switch 1 R0
------------------
------------------ show platform software trace message fed switch 1 ------------------
------------------ show power inline Gi9/0/16 detail ------------------
Interface: Gi9/0/16
Inline Power Mode: auto
Operational status: off
Device Detected: no
Device Type: n/a
IEEE Class: n/a
Discovery mechanism used/configured: Ieee and Cisco
Police: off
Power Allocated
Admin Value: 60.0
Power drawn from the source: 0.0
Power available to the device: 0.0
Actual consumption
Measured at the port: 0.0
Maximum Power drawn by the device since powered on: 0.0
Absent Counter: 0
Over Current Counter: 0
Short Current Counter: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
412
Interface and Hardware Components
show tech-support poe
Mosfet Counter: 0
Invalid Signature Counter: 0
Power Denied Counter: 0
Power Negotiation Used: None
LLDP Power Negotiation --Sent to PD-- --Rcvd from PD--
Power Type: - -
Power Source: - -
Power Priority: - -
Requested Power(W): - -
Allocated Power(W): - -
Four-Pair PoE Supported: Yes
Spare Pair Power Enabled: No
Four-Pair PD Architecture: N/A
------------------ show power inline Te8/0/1 detail ------------------
Interface Te8/0/1: inline power not supported
------------------ show power inline police ------------------
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
1 n/a n/a n/a
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
--------- ------ ---------- ---------- ---------- ------ -----
Totals: 0.0
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
2 1050.0 0.0 1050.0
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Te2/0/1 auto off none n/a n/a n/a
Te2/0/2 auto off none n/a n/a n/a
Te2/0/3 auto off none n/a n/a n/a
Te2/0/4 auto off none n/a n/a n/a
Te2/0/5 auto off none n/a n/a n/a
Te2/0/6 auto off none n/a n/a n/a
Te2/0/7 auto off none n/a n/a n/a
Te2/0/8 auto off none n/a n/a n/a
Te2/0/9 auto off none n/a n/a n/a
Te2/0/10 auto off none n/a n/a n/a
Te2/0/11 auto off none n/a n/a n/a
Te2/0/12 auto off none n/a n/a n/a
Te2/0/13 auto off none n/a n/a n/a
Te2/0/14 auto off none n/a n/a n/a
Te2/0/15 auto off none n/a n/a n/a
Te2/0/16 auto off none n/a n/a n/a
Te2/0/17 auto off none n/a n/a n/a
Te2/0/18 auto off none n/a n/a n/a
Te2/0/19 auto off none n/a n/a n/a
Te2/0/20 auto off none n/a n/a n/a
Te2/0/21 auto off none n/a n/a n/a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
413
Interface and Hardware Components
show tech-support poe
Te2/0/22 auto off none n/a n/a n/a
Te2/0/23 auto off none n/a n/a n/a
Te2/0/24 auto off none n/a n/a n/a
--------- ------ ---------- ---------- ---------- ------ -----
Totals: 0.0
Module Available Used Remaining
(Watts) (Watts) (Watts)
------ --------- -------- ---------
3 1131.0 49.4 1081.6
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi3/0/1 auto off none n/a n/a n/a
Gi3/0/2 auto off none n/a n/a n/a
Gi3/0/3 auto off none n/a n/a n/a
Gi3/0/4 auto off none n/a n/a n/a
Gi3/0/5 auto off none n/a n/a n/a
Gi3/0/6 auto off none n/a n/a n/a
Gi3/0/7 auto off none n/a n/a n/a
Gi3/0/8 auto off none n/a n/a n/a
Gi3/0/9 auto off none n/a n/a n/a
Gi3/0/10 auto off none n/a n/a n/a
Gi3/0/11 auto off none n/a n/a n/a
Gi3/0/12 auto off none n/a n/a n/a
Gi3/0/13 auto on none n/a n/a 3.6
Gi3/0/14 auto on none n/a n/a 7.0
Gi3/0/15 auto off none n/a n/a n/a
Gi3/0/16 auto on none n/a n/a 3.7
Gi3/0/17 auto on none n/a n/a 3.7
Gi3/0/18 auto off none n/a n/a n/a
Gi3/0/19 auto on none n/a n/a 3.7
Gi3/0/20 auto off none n/a n/a n/a
Gi3/0/21 auto on none n/a n/a 3.7
Gi3/0/22 auto off none n/a n/a n/a
Gi3/0/23 auto off none n/a n/a n/a
Gi3/0/24 auto off none n/a n/a n/a
Gi3/0/25 auto off none n/a n/a n/a
Gi3/0/26 auto off none n/a n/a n/a
Gi3/0/27 auto off none n/a n/a n/a
Gi3/0/28 auto off none n/a n/a n/a
Gi3/0/29 auto off none n/a n/a n/a
Gi3/0/30 auto off none n/a n/a n/a
Gi3/0/31 auto off none n/a n/a n/a
Gi3/0/32 auto off none n/a n/a n/a
Gi3/0/33 auto off none n/a n/a n/a
Gi3/0/34 auto off none n/a n/a n/a
Gi3/0/35 auto on none n/a n/a 2.3
Gi3/0/36 auto off none n/a n/a n/a
Gi3/0/37 auto off none n/a n/a n/a
Gi3/0/38 auto off none n/a n/a n/a
Gi3/0/39 auto off none n/a n/a n/a
Gi3/0/40 auto off none n/a n/a n/a
Gi3/0/41 auto off none n/a n/a n/a
Gi3/0/42 auto off none n/a n/a n/a
Gi3/0/43 auto off none n/a n/a n/a
Gi3/0/44 auto off none n/a n/a n/a
Gi3/0/45 auto off none n/a n/a n/a
Gi3/0/46 auto off none n/a n/a n/a
Gi3/0/47 auto off none n/a n/a n/a
Gi3/0/48 auto off none n/a n/a n/a
--------- ------ ---------- ---------- ---------- ------ -----
Totals: 27.7
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
414
Interface and Hardware Components
show tech-support poe
------------------ show platform frontend-controller manager 0 1 ------------------
showing manager info: 1
Tx cmd cnt SYS App 24681
Rx cmd cnt SYS App 24681
Tx cmd ignore SYS App 0
Tx cmd Q full SYS App 0
Tx cmd cnt SYS App 17706
Rx cmd cnt SYS App 11804
Tx cmd ignore SYS App 0
Tx cmd Q full SYS App 0
Tx cmd cnt SYS App 0
Rx cmd cnt SYS App 0
Tx cmd ignore SYS App 0
Tx cmd Q full SYS App 0
Tx cmd cnt POE App 0
Rx cmd cnt POE App 0
Tx cmd ignore POE App 0
Tx cmd Q full POE App 0
Tx cmd cnt FRUFE App 0
Rx cmd cnt FRUFE App 0
Tx cmd ignore FRUFE App 0
Tx cmd Q full FRUFE App 0
Tx cmd cnt SYS App 1744
Rx cmd cnt SYS App 993
Tx cmd ignore SYS App 0
Tx cmd Q full SYS App 0
Tx cmd cnt IMAGE App 13809
Rx cmd cnt IMAGE App 13808
Tx cmd ignore IMAGE App 0
Tx cmd Q full IMAGE App 0
Tx cmd cnt STACK App 0
Rx cmd cnt STACK App 0
Tx cmd ignore STACK App 0
Tx cmd Q full STACK App 0
Tx cmd cnt J2A App 0
Rx cmd cnt J2A App 0
Tx cmd ignore J2A App 0
Tx cmd Q full J2A App 0
Tx cmd cnt THERM App 0
Rx cmd cnt THERM App 0
Tx cmd ignore THERM App 0
Tx cmd Q full THERM App 0
Tx cmd cnt GPIO App 0
Rx cmd cnt GPIO App 255
Tx cmd ignore GPIO App 255
Tx cmd Q full GPIO App 255
Tx cmd cnt POE_E App -369383984
Rx cmd cnt POE_E App -369346528
Tx cmd ignore POE_E App -1826379312
Tx cmd Q full POE_E App -394693324
Tx cmd cnt DMSG App 0
Rx cmd cnt DMSG App 0
Tx cmd ignore DMSG App 0
Tx cmd Q full DMSG App 255
Tx reg cnt 16
Rx reg cnt 16
Tx reg ignore 0
Tx reg Q full 0
Rx invalid frame 0
Rx invalid App 748
Rx invalid Seq 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
415
Interface and Hardware Components
show tech-support poe
Rx invalid checksum 0
Nack cnt 0
Send Break count 0
Early Send Break count 0
Retransmission cnt 0
------------------ show platform frontend-controller subordinate 0 1 ------------------
showing sub info: 1
State OK
Last Reset Reason UNKNOWN REASON
UART FE Error 0
UART PE Error 0
UART DOR Error 0
Rx Buf Overflow 0
Rx Buf Underflow 0
Tx Buf Full 0
Rx Bad Endbyte 0
PLE Invalid App 0
PLE Disabled App 0
PLE Invalid Data 0
PLE Invalid Flags 0
PLE App Error 0
PLE Lost Ctxt 0
PLE Invalid Reg 0
PLE Invalid Reg Len 0
PLE Invalid Msg Len 0
SLE Poe No Port 0
SLE I2C Busy 0
SLE I2C Error 0
SLE I2C Timeout 0
SLE Invalid Reg Len 0
SLE Msg Underrun 0
------------------ show platform frontend-controller version 0 1 ------------------
Switch 1 MCU:
Software Version 0.109
System Type 6
Device Id 2
Device Revision 0
Hardware Version 41
Bootloader Version 16
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
416
Interface and Hardware Components
speed
speed
To specify the speed of a port, use the speed command in interface configuration mode. To return to the
default value, use the no form of this command.
Note Available configuration options depend on the switch model and transceiver module installed. Options include
10, 100, 1000, 2500, 5000, 10000, 25000, 40000, 100000
speed {10 | 100 | 1000 | 2500 | 5000 | auto [{10 | 100 | 1000 | 2500 | 5000}] | nonegotiate}
no speed
Syntax Description 10 Specifies that the port runs at 10 Mbps.
100 Specifies that the port runs at 100 Mbps.
1000 Specifies that the port runs at 1000 Mbps. This option is valid and visible only on 10/100/1000
Mb/s ports.
2500 Specifies that the port runs at 2500 Mbps. This option is valid and visible only on
multi-Gigabit-supported Ethernet ports.
5000 Specifies that the port runs at 5000 Mbps. This option is valid and visible only on
multi-Gigabit-supported Ethernet ports.
auto Detects the speed at which the port should run, automatically, based on the port at the other
end of the link. If you use the 10, 100, 1000, 2500, or 5000 keyword with the auto keyword,
the port autonegotiates only at the specified speeds.
nonegotiate Disables autonegotiation, and the port runs at 1000 Mbps.
Command Default The default is auto.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You cannot configure speed on 10-Gigabit Ethernet ports.
Except for the 1000BASE-T small form-factor pluggable (SFP) modules, you can configure the speed to not
negotiate (nonegotiate) when an SFP module port is connected to a device that does not support autonegotiation.
The keywords, 2500 and 5000 are visible only on multi-Gigabit (m-Gig) Ethernet supporting devices.
If the speed is set to auto, the switch negotiates with the device at the other end of the link for the speed
setting, and then forces the speed setting to the negotiated value. The duplex setting remains configured on
each end of the link, which might result in a duplex setting mismatch.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
417
Interface and Hardware Components
speed
If both ends of the line support autonegotiation, we highly recommend the default autonegotiation settings.
If one interface supports autonegotiation and the other end does not, use the auto setting on the supported
side, but set the duplex and speed on the other side.
Caution Changing the interface speed and duplex mode configuration might shut down and re-enable the interface
during the reconfiguration.
For guidelines on setting the switch speed and duplex parameters, see the “Configuring Interface Characteristics”
chapter in the software configuration guide for this release.
Verify your settings using the show interfaces privileged EXEC command.
Examples The following example shows how to set speed on a port to 100 Mbps:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# speed 100
The following example shows how to set a port to autonegotiate at only 10 Mbps:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# speed auto 10
The following example shows how to set a port to autonegotiate at only 10 or 100 Mbps:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# speed auto 10 100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
418
Interface and Hardware Components
stack-power
stack-power
To configure StackPower parameters for the power stack or for a switch in the power stack, use the stack
power command in global configuration mode. To return to the default setting, use the no form of the command,
Note Cisco Catalyst 9300L Series Switches do not support this command.
stack-power {stack power-stack-name | switch stack-member-number}
no stack-power {stack power-stack-name | switch stack-member-number}
Syntax Description stack power-stack-name Specifies the name of the power stack. The name can be up to 31 characters.
Entering these keywords followed by a carriage return enters power stack
configuration mode.
switch stack-member-number Specifies the switch number in the stack (1 to 4) to enter switch stack-power
configuration mode for the switch.
Command Default There is no default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you enter the stack-power stack power stack name command, you enter power stack configuration
mode, and these commands are available:
• default—Returns a command to its default setting.
• exit—Exits ARP access-list configuration mode.
• mode—Sets the power mode for the power stack. See the mode command.
• no—Negates a command or returns to default settings.
If you enter the stack-power switch switch-number command with a switch number that is not participating
in StackPower, you receive an error message.
When you enter the stack-power switch switch-number command with the number of a switch participating
in StackPower, you enter switch stack power configuration mode, and these commands are available:
• default—Returns a command to its default setting.
• exit—Exits switch stack power configuration mode.
• no—Negates a command or returns to default settings.
• power-priority—Sets the power priority for the switch and the switch ports. See the power-priority
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
419
Interface and Hardware Components
stack-power
• stack-id name—Enters the name of the power stack to which the switch belongs. If you do not enter the
power stack-ID, the switch does not inherit the stack parameters. The name can be up to 31 characters.
• standalone—Forces the switch to operate in standalone power mode. This mode shuts down both stack
power ports.
Examples This example removes switch 2, which is connected to the power stack, from the power pool and
shutting down both power ports:
Device(config)# stack-power switch 2
Device(config-switch-stackpower)# standalone
Device(config-switch-stackpower)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
420
Interface and Hardware Components
switchport block
switchport block
To prevent unknown multicast or unicast packets from being forwarded, use the switchport block command
in interface configuration mode. To allow forwarding unknown multicast or unicast packets, use the no form
of this command.
switchport block {multicast | unicast}
no switchport block {multicast | unicast}
Syntax Description multicast Specifies that unknown multicast traffic should be blocked.
Note Only pure Layer 2 multicast traffic is blocked. Multicast packets that contain IPv4
or IPv6 information in the header are not blocked.
unicast Specifies that unknown unicast traffic should be blocked.
Command Default Unknown multicast and unicast traffic is not blocked.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines By default, all traffic with unknown MAC addresses is sent to all ports. You can block unknown multicast or
unicast traffic on protected or nonprotected ports. If unknown multicast or unicast traffic is not blocked on a
protected port, there could be security issues.
With multicast traffic, the port blocking feature blocks only pure Layer 2 packets. Multicast packets that
contain IPv4 or IPv6 information in the header are not blocked.
Blocking unknown multicast or unicast traffic is not automatically enabled on protected ports; you must
explicitly configure it.
For more information about blocking packets, see the software configuration guide for this release.
This example shows how to block unknown unicast traffic on an interface:
Device(config-if)# switchport block unicast
You can verify your setting by entering the show interfaces interface-id switchport privileged
EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
421
Interface and Hardware Components
system mtu
system mtu
To set the global maximum packet size or MTU size for switched packets on Gigabit Ethernet and 10-Gigabit
Ethernet ports, use the system mtu command in global configuration mode. To restore the global MTU value
to its default value, use the no form of this command.
system mtu bytes
no system mtu
Syntax Description bytes The global MTU size in bytes. The range is 1500 to 9198 bytes; the default is 1500 bytes.
Command Default The default MTU size for all ports is 1500 bytes.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can verify your setting by entering the show system mtu privileged EXEC command.
The switch does not support the MTU on a per-interface basis.
If you enter a value that is outside the allowed range for the specific type of interface, the value is not accepted.
Examples This example shows how to set the global system MTU size to 6000 bytes:
Device(config)# system mtu 6000
Global Ethernet MTU is set to 6000 bytes.
Note: this is the Ethernet payload size, not the total
Ethernet frame size, which includes the Ethernet
header/trailer and possibly other tags, such as ISL or
802.1q tags.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
422
Interface and Hardware Components
tlv-type (device classifier condition)
tlv-type (device classifier condition)
To configure profiles based on match of TLV for the given protocol, use the tlv-type command in device
classifier condition mode.
{cdp|dhcp|lldp}tlv-type number value{integer num | string name | regex regular expression }
Syntax Description cdp Specifies Cisco Discovery Protocol on the device.
dhcp Specifies DHCP protocol on the device.
lldp Specifies Link Layer Discovery Protocol on the device.
number number configures application TLV type information. The number range is 1 to
255.
value Configures application TLV value information.
integer num Defines integer number value to match.
string name Defines string name value to match.
regex regular expression Defines regular expression to match.
Command Default The profiling based on match of TLV of the given protocol is not configured.
Command Modes Device classifier condition
Command History Release Modification
Cisco IOS XE Bengaluru 17.4.1 This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 The keyword regex was introduced.
Usage Guidelines The supported protocols are CDP, DHCP, and LLDP. Protocols like HTTP, OUI are not supported.
Example
The following example shows how to define profiles based on match of TLV for the given protocol
Device> enable
Device# configure terminal
Device(config)# device classifier condition ts-cond1
Device(config-device-classifier-condition)# cdp tlv-type 1 value String TS01
Device(config-device-classifier-condition)# exit
Device(config)# device classifier device-type Terminal-Server
Device(config-device-classifier-dtype)# condition ts-cond1
Device(config)# end
Device> enable
Device# configure terminal
Device(config)# device classifier condition ts-cond1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
423
Interface and Hardware Components
tlv-type (device classifier condition)
Device(config-device-classifier-condition)# cdp tlv-type 4 value integer 0x0029
Device(config-device-classifier-condition)# exit
Device(config)# device classifier device-type Terminal-Server
Device(config-device-classifier-dtype)# condition ts-cond2
Device(config)# end
Device> enable
Device# configure terminal
Device(config)# device classifier condition ts-cond1
Device(config-device-classifier-condition)# cdp tlv-type 5 value regex fibre*
Device(config-device-classifier-condition)# exit
Device(config)# device classifier device-type Terminal-Server
Device(config-device-classifier-dtype)# condition ts-cond3
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
424
Interface and Hardware Components
voice-signaling vlan (network-policy configuration)
voice-signaling vlan (network-policy configuration)
To create a network-policy profile for the voice-signaling application type, use the voice-signaling vlan
command in network-policy configuration mode. To delete the policy, use the no form of this command.
voice-signaling vlan {vlan-id [{cos cos-value | dscp dscp-value}] | dot1p [{cos l2-priority | dscp
dscp}] | none | untagged}
Syntax Description vlan-id (Optional) The VLAN for voice traffic. The range is 1 to 4094.
cos cos-value (Optional) Specifies the Layer 2 priority class of service (CoS) for the configured VLAN.
The range is 0 to 7; the default is 5.
dscp dscp-value (Optional) Specifies the differentiated services code point (DSCP) value for the configured
VLAN. The range is 0 to 63; the default is 46.
dot1p (Optional) Configures the phone to use IEEE 802.1p priority tagging and to use VLAN
0 (the native VLAN).
none (Optional) Does not instruct the Cisco IP phone about the voice VLAN. The phone uses
the configuration from the phone key pad.
untagged (Optional) Configures the phone to send untagged voice traffic. This is the default for
the phone.
Command Default No network-policy profiles for the voice-signaling application type are defined.
The default CoS value is 5.
The default DSCP value is 46.
The default tagging mode is untagged.
Command Modes Network-policy profile configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the network-policy profile global configuration command to create a profile and to enter network-policy
profile configuration mode.
The voice-signaling application type is for network topologies that require a different policy for voice signaling
than for voice media. This application type should not be advertised if all of the same network policies apply
as those advertised in the voice policy TLV.
When you are in network-policy profile configuration mode, you can create the profile for voice-signaling
by specifying the values for VLAN, class of service (CoS), differentiated services code point (DSCP), and
tagging mode.
These profile attributes are contained in the Link Layer Discovery Protocol for Media Endpoint Devices
(LLDP-MED) network-policy time-length-value (TLV).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
425
Interface and Hardware Components
voice-signaling vlan (network-policy configuration)
To return to privileged EXEC mode from the network-policy profile configuration mode, enter the exit
command.
This example shows how to configure voice-signaling for VLAN 200 with a priority 2 CoS:
(config)# network-policy profile 1
(config-network-policy)# voice-signaling vlan 200 cos 2
This example shows how to configure voice-signaling for VLAN 400 with a DSCP value of 45:
(config)# network-policy profile 1
(config-network-policy)# voice-signaling vlan 400 dscp 45
This example shows how to configure voice-signaling for the native VLAN with priority tagging:
(config-network-policy)# voice-signaling vlan dot1p cos 4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
426
Interface and Hardware Components
voice vlan (network-policy configuration)
voice vlan (network-policy configuration)
To create a network-policy profile for the voice application type, use the voice vlan command in network-policy
configuration mode. To delete the policy, use the no form of this command.
voice vlan {vlan-id [{cos cos-value | dscp dscp-value}] | dot1p [{cos l2-priority | dscp dscp}] | none
| untagged}
Syntax Description vlan-id (Optional) The VLAN for voice traffic. The range is 1 to 4094.
cos cos-value (Optional) Specifies the Layer 2 priority class of service (CoS) for the configured VLAN.
The range is 0 to 7; the default is 5.
dscp dscp-value (Optional) Specifies the differentiated services code point (DSCP) value for the configured
VLAN. The range is 0 to 63; the default is 46.
dot1p (Optional) Configures the phone to use IEEE 802.1p priority tagging and to use VLAN
0 (the native VLAN).
none (Optional) Does not instruct the Cisco IP phone about the voice VLAN. The phone uses
the configuration from the phone key pad.
untagged (Optional) Configures the phone to send untagged voice traffic. This is the default for
the phone.
Command Default No network-policy profiles for the voice application type are defined.
The default CoS value is 5.
The default DSCP value is 46.
The default tagging mode is untagged.
Command Modes Network-policy profile configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the network-policy profile global configuration command to create a profile and to enter network-policy
profile configuration mode.
The voice application type is for dedicated IP telephones and similar devices that support interactive voice
services. These devices are typically deployed on a separate VLAN for ease of deployment and enhanced
security through isolation from data applications.
When you are in network-policy profile configuration mode, you can create the profile for voice by specifying
the values for VLAN, class of service (CoS), differentiated services code point (DSCP), and tagging mode.
These profile attributes are contained in the Link Layer Discovery Protocol for Media Endpoint Devices
(LLDP-MED) network-policy time-length-value (TLV).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
427
Interface and Hardware Components
voice vlan (network-policy configuration)
To return to privileged EXEC mode from the network-policy profile configuration mode, enter the exit
command.
This example shows how to configure the voice application type for VLAN 100 with a priority 4
CoS:
(config)# network-policy profile 1
(config-network-policy)# voice vlan 100 cos 4
This example shows how to configure the voice application type for VLAN 100 with a DSCP value
of 34:
(config)# network-policy profile 1
(config-network-policy)# voice vlan 100 dscp 34
This example shows how to configure the voice application type for the native VLAN with priority
tagging:
(config-network-policy)# voice vlan dot1p cos 4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
428
PA R T IV
IP Addressing Services
• IP Addressing Services Commands, on page 431
IP Addressing Services Commands
• clear ip nhrp, on page 436
• clear ipv6 access-list, on page 437
• clear ipv6 dhcp, on page 438
• clear ipv6 dhcp binding, on page 439
• clear ipv6 dhcp client, on page 440
• clear ipv6 dhcp conflict, on page 441
• clear ipv6 dhcp relay binding, on page 442
• clear ipv6 eigrp, on page 443
• clear ipv6 mfib counters, on page 444
• clear ipv6 mld counters, on page 445
• clear ipv6 mld traffic, on page 446
• clear ipv6 mtu, on page 447
• clear ipv6 multicast aaa authorization, on page 448
• clear ipv6 nd destination, on page 449
• clear ipv6 nd on-link prefix, on page 450
• clear ipv6 nd router, on page 451
• clear ipv6 neighbors, on page 452
• clear ipv6 nhrp, on page 454
• clear ipv6 ospf, on page 455
• clear ipv6 ospf counters, on page 456
• clear ipv6 ospf events, on page 458
• clear ipv6 pim reset, on page 459
• clear ipv6 pim topology, on page 460
• clear ipv6 pim traffic, on page 461
• clear ipv6 prefix-list, on page 462
• clear ipv6 rip, on page 463
• clear ipv6 route, on page 464
• clear ipv6 spd, on page 465
• debug nhrp, on page 466
• fhrp delay, on page 468
• fhrp version vrrp v3, on page 469
• ip address dhcp, on page 470
• ip address pool (DHCP), on page 473
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
431
IP Addressing Services
• ip address, on page 474
• ip nat inside source, on page 476
• ip nat outside source, on page 481
• ip nat pool, on page 484
• ip nat translation max-entries, on page 486
• ip nat translation (timeout), on page 487
• ip nhrp map, on page 489
• ip nhrp map multicast, on page 491
• ip nhrp network-id, on page 492
• ip nhrp nhs, on page 493
• ip wccp, on page 495
• ipv6 access-list, on page 500
• ipv6 address-validate, on page 503
• ipv6 cef, on page 504
• ipv6 cef accounting, on page 506
• ipv6 cef distributed, on page 508
• ipv6 cef load-sharing algorithm, on page 510
• ipv6 cef optimize neighbor resolution, on page 511
• ipv6 destination-guard policy, on page 512
• ipv6 dhcp-relay bulk-lease, on page 513
• ipv6 dhcp-relay option vpn, on page 514
• ipv6 dhcp-relay source-interface, on page 515
• ipv6 dhcp binding track ppp, on page 516
• ipv6 dhcp database, on page 517
• ipv6 dhcp iana-route-add, on page 519
• ipv6 dhcp iapd-route-add, on page 520
• ipv6 dhcp-ldra , on page 521
• ipv6 dhcp ping packets, on page 522
• ipv6 dhcp pool, on page 523
• ipv6 dhcp server vrf enable, on page 525
• ipv6 flow monitor , on page 526
• ipv6 general-prefix, on page 527
• ipv6 local policy route-map, on page 529
• ipv6 local pool, on page 531
• ipv6 mld snooping (global), on page 533
• ipv6 mld ssm-map enable, on page 534
• ipv6 mld state-limit, on page 535
• ipv6 multicast-routing, on page 536
• ipv6 multicast group-range, on page 537
• ipv6 multicast pim-passive-enable, on page 539
• ipv6 multicast rpf, on page 540
• ipv6 nd cache expire, on page 541
• ipv6 nd cache interface-limit (global), on page 542
• ipv6 nd host mode strict, on page 543
• ipv6 nd na glean, on page 544
• ipv6 nd ns-interval, on page 545
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
432
IP Addressing Services
• ipv6 nd nud retry, on page 546
• ipv6 nd reachable-time, on page 548
• ipv6 nd resolution data limit, on page 549
• ipv6 nd route-owner, on page 550
• ipv6 neighbor, on page 551
• ipv6 ospf name-lookup, on page 553
• ipv6 pim, on page 554
• ipv6 pim accept-register, on page 555
• ipv6 pim allow-rp , on page 556
• ipv6 pim neighbor-filter list, on page 557
• ipv6 pim rp-address, on page 558
• ipv6 pim rp embedded, on page 561
• ipv6 pim spt-threshold infinity, on page 562
• ipv6 prefix-list, on page 563
• ipv6 source-guard attach-policy, on page 566
• ipv6 source-route, on page 567
• ipv6 spd mode, on page 568
• ipv6 spd queue max-threshold, on page 569
• ipv6 traffic interface-statistics, on page 570
• ipv6 unicast-routing, on page 571
• key chain, on page 572
• key-string (authentication), on page 573
• key, on page 574
• show ip nat translations, on page 575
• show ip nhrp nhs, on page 578
• show ip ports all, on page 581
• show ip wccp, on page 583
• show ipv6 access-list, on page 597
• show ipv6 destination-guard policy, on page 600
• show ipv6 dhcp, on page 601
• show ipv6 dhcp binding, on page 602
• show ipv6 dhcp conflict, on page 605
• show ipv6 dhcp database, on page 606
• show ipv6 dhcp guard policy, on page 608
• show ipv6 dhcp interface, on page 610
• show ipv6 dhcp relay binding, on page 612
• show ipv6 eigrp events, on page 614
• show ipv6 eigrp interfaces, on page 616
• show ipv6 eigrp topology, on page 618
• show ipv6 eigrp traffic, on page 620
• show ipv6 general-prefix, on page 622
• show ipv6 interface, on page 623
• show ipv6 mfib, on page 631
• show ipv6 mld groups, on page 637
• show ipv6 mld interface, on page 640
• show ipv6 mld snooping, on page 642
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
433
IP Addressing Services
• show ipv6 mld ssm-map, on page 644
• show ipv6 mld traffic, on page 646
• show ipv6 mrib client, on page 648
• show ipv6 mrib route, on page 650
• show ipv6 mroute, on page 652
• show ipv6 mtu, on page 656
• show ipv6 nd destination, on page 658
• show ipv6 nd on-link prefix, on page 659
• show ipv6 neighbors, on page 660
• show ipv6 nhrp, on page 664
• show ipv6 ospf, on page 667
• show ipv6 ospf border-routers, on page 671
• show ipv6 ospf event, on page 673
• show ipv6 ospf graceful-restart, on page 676
• show ipv6 ospf interface, on page 678
• show ipv6 ospf request-list, on page 683
• show ipv6 ospf retransmission-list, on page 685
• show ipv6 ospf statistics, on page 687
• show ipv6 ospf summary-prefix, on page 689
• show ipv6 ospf timers rate-limit, on page 690
• show ipv6 ospf traffic, on page 691
• show ipv6 ospf virtual-links, on page 695
• show ipv6 pim anycast-RP, on page 697
• show ipv6 pim bsr, on page 698
• show ipv6 pim df, on page 700
• show ipv6 pim group-map, on page 702
• show ipv6 pim interface, on page 704
• show ipv6 pim join-prune statistic, on page 706
• show ipv6 pim limit, on page 707
• show ipv6 pim neighbor, on page 708
• show ipv6 pim range-list, on page 710
• show ipv6 pim topology, on page 712
• show ipv6 pim traffic, on page 714
• show ipv6 pim tunnel, on page 716
• show ipv6 policy, on page 718
• show ipv6 prefix-list, on page 719
• show ipv6 protocols, on page 722
• show ipv6 rip, on page 725
• show ipv6 route, on page 730
• show ipv6 routers, on page 734
• show ipv6 rpf, on page 737
• show ipv6 source-guard policy, on page 739
• show ipv6 spd, on page 740
• show ipv6 static, on page 741
• show ipv6 traffic, on page 745
• show key chain, on page 748
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
434
IP Addressing Services
• show track, on page 749
• track, on page 751
• vrrp, on page 753
• vrrp description, on page 754
• vrrp preempt, on page 755
• vrrp priority, on page 756
• vrrp timers advertise, on page 757
• vrrs leader, on page 759
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
435
IP Addressing Services
clear ip nhrp
clear ip nhrp
To clear all dynamic entries from the Next Hop Resolution Protocol (NHRP) cache, use the clear ip nhrp
command in user EXEC or privileged EXEC mode.
clear ip nhrp[{vrf {vrf-name | global}}] [{dest-ip-address [{dest-mask}] | tunnel number | counters
[{interface tunnel number}] | stats [{tunnel number [{vrf {vrf-name | global}}]}]}]
Syntax Description vrf (Optional) Deletes entries from the NHRP cache for the specified virtual routing and
forwarding (VRF) instance.
vrf-name (Optional) Name of the VRF address family to which the command is applied.
global (Optional) Specifies the global VRF instance.
dest-ip-address (Optional) Destination IP address. Specifying this argument clears NHRP mapping entries
for the specified destination IP address.
dest-mask (Optional) Destination network mask.
counters (Optional) Clears the NHRP counters.
interface (Optional) Clears the NHRP mapping entries for all interfaces.
tunnel number (Optional) Removes the specified interface from the NHRP cache.
stats (Optional) Clears all IPv4 statistic information for all interfaces.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Denali 16.5.1 This command was introduced.
Usage Guidelines The clear ip nhrp command does not clear any static (configured) IP-to-NBMA address mappings from the
NHRP cache.
Examples The following example shows how to clear all dynamic entries from the NHRP cache for an interface:
Switch# clear ip nhrp
Related Commands Command Description
show ip nhrp Displays NHRP mapping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
436
IP Addressing Services
clear ipv6 access-list
clear ipv6 access-list
To reset the IPv6 access list match counters, use the clear ipv6 access-listcommand in privileged EXEC
mode.
clear ipv6 access-list [access-list-name]
Syntax Description access-list-name (Optional) Name of the IPv6 access list for which to clear the match counters. Names
cannot contain a space or quotation mark, or begin with a numeric.
Command Default No reset is initiated.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 access-list command is similar to the clear ip access-list counterscommand, except that it is
IPv6-specific.
The clear ipv6 access-listcommand used without the access-list-nameargument resets the match counters for
all IPv6 access lists configured on the router.
This command resets the IPv6 global ACL hardware counters.
Examples The following example resets the match counters for the IPv6 access list named marketing:
# clear ipv6 access-list marketing
Related Commands Command Description
hardware statistics Enables the collection of hardware statistics.
ipv6 access-list Defines an IPv6 access list and enters IPv6 access list configuration mode.
show ipv6 access-list Displays the contents of all current IPv6 access lists.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
437
IP Addressing Services
clear ipv6 dhcp
clear ipv6 dhcp
To clear IPv6 Dynamic Host Configuration Protocol (DHCP) information, use the clear ipv6 dhcpcommand
in privileged EXEC mode:
clear ipv6 dhcp
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 dhcp command deletes DHCP for IPv6 information.
Examples The following example :
# clear ipv6 dhcp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
438
IP Addressing Services
clear ipv6 dhcp binding
clear ipv6 dhcp binding
To delete automatic client bindings from the Dynamic Host Configuration Protocol (DHCP) for IPv6 server
binding table, use the clear ipv6 dhcp binding command in privileged EXEC mode.
clear ipv6 dhcp binding [ipv6-address] [vrf vrf-name]
Syntax Description ipv6-address (Optional) The address of a DHCP for IPv6 client.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 dhcp binding command is used as a server function.
A binding table entry on the DHCP for IPv6 server is automatically:
• Created whenever a prefix is delegated to a client from the configuration pool.
• Updated when the client renews, rebinds, or confirms the prefix delegation.
• Deleted when the client releases all the prefixes in the binding voluntarily, all prefixes’ valid lifetimes
have expired, or an administrator runs the clear ipv6 dhcp binding command.
If the clear ipv6 dhcp binding command is used with the optional ipv6-address argument specified, only the
binding for the specified client is deleted. If the clear ipv6 dhcp binding command is used without the
ipv6-address argument, then all automatic client bindings are deleted from the DHCP for IPv6 binding table.
If the optional vrf vrf-name keyword and argument combination is used, only the bindings for the specified
VRF are cleared.
Examples The following example deletes all automatic client bindings from the DHCP for IPv6 server binding
table:
# clear ipv6 dhcp binding
Related Commands Command Description
show ipv6 dhcp binding Displays automatic client bindings from the DHCP for IPv6 server binding table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
439
IP Addressing Services
clear ipv6 dhcp client
clear ipv6 dhcp client
To restart the Dynamic Host Configuration Protocol (DHCP) for IPv6 client on an interface, use the clear
ipv6 dhcp client command in privileged EXEC mode.
clear ipv6 dhcp client interface-type interface-number
Syntax Description interface-type interface-number Interface type and number. For more information, use the question mark
(?) online help function.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 dhcp client command restarts the DHCP for IPv6 client on specified interface after first
releasing and unconfiguring previously acquired prefixes and other configuration options (for example, Domain
Name System [DNS] servers).
Examples The following example restarts the DHCP for IPv6 client for Ethernet interface 1/0:
# clear ipv6 dhcp client Ethernet 1/0
Related Commands Command Description
show ipv6 dhcp interface Displays DHCP for IPv6 interface information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
440
IP Addressing Services
clear ipv6 dhcp conflict
clear ipv6 dhcp conflict
To clear an address conflict from the Dynamic Host Configuration Protocol for IPv6 (DHCPv6) server database,
use the clear ipv6 dhcp conflict command in privileged EXEC mode.
clear ipv6 dhcp conflict {*ipv6-address | vrf vrf-name}
Syntax Description * Clears all address conflicts.
ipv6-address Clears the host IPv6 address that contains the conflicting address.
vrf vrf-name Specifies a virtual routing and forwarding (VRF) name.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When you configure the DHCPv6 server to detect conflicts, it uses ping. The client uses neighbor discovery
to detect clients and reports to the server through a DECLINE message. If an address conflict is detected, the
address is removed from the pool, and the address is not assigned until the administrator removes the address
from the conflict list.
If you use the asterisk (*) character as the address parameter, DHCP clears all conflicts.
If the vrf vrf-name keyword and argument are specified, only the address conflicts that belong to the specified
VRF will be cleared.
Examples The following example shows how to clear all address conflicts from the DHCPv6 server database:
# clear ipv6 dhcp conflict *
Related Commands Command Description
show ipv6 dhcp conflict Displays address conflicts found by a DHCPv6 server when addresses are offered
to the client.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
441
IP Addressing Services
clear ipv6 dhcp relay binding
clear ipv6 dhcp relay binding
To clear an IPv6 address or IPv6 prefix of a Dynamic Host Configuration Protocol (DHCP) for IPv6 relay
binding, use the clear ipv6 dhcp relay binding command in privileged EXEC mode.
clear ipv6 dhcp relay binding{vrf vrf-name}{*ipv6-addressipv6-prefix}
clear ipv6 dhcp relay binding{vrf vrf-name}{* ipv6-prefix}
Syntax Description vrf vrf-name Specifies a virtual routing and forwarding (VRF) configuration.
* Clears all DHCPv6 relay bindings.
ipv6-address DHCPv6 address.
ipv6-prefix IPv6 prefix.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 dhcp relay binding command deletes a specific IPv6 address or IPv6 prefix of a DHCP for
IPv6 relay binding. If no relay client is specified, no binding is deleted.
Examples The following example shows how to clear the binding for a client with a specified IPv6 address:
# clear ipv6 dhcp relay binding 2001:0DB8:3333:4::5
The following example shows how to clear the binding for a client with the VRF name vrf1 and a
specified prefix on a Cisco uBR10012 universal broadband device:
# clear ipv6 dhcp relay binding vrf vrf1 2001:DB8:0:1::/64
Related Commands Command Description
show ipv6 dhcp relay binding Displays DHCPv6 IANA and DHCPv6 IAPD bindings on a relay agent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
442
IP Addressing Services
clear ipv6 eigrp
clear ipv6 eigrp
To delete entries from Enhanced Interior Gateway Routing Protocol (EIGRP) for IPv6 routing tables, use the
clear ipv6 eigrp command in privileged EXEC mode.
clear ipv6 eigrp [as-number] [neighbor [{ipv6-address | interface-type interface-number}]]
Syntax Description as-number (Optional) Autonomous system number.
neighbor (Optional) Deletes neighbor router entries.
ipv6-address (Optional) IPv6 address of a neighboring router.
interface-type (Optional) The interface type of the neighbor router.
interface-number (Optional) The interface number of the neighbor router.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the clear ipv6 eigrp command without any arguments or keywords to clear all EIGRP for IPv6 routing
table entries. Use the as-number argument to clear routing table entries on a specified process, and use the
neighboripv6-address keyword and argument, or the interface-typeinterface-number argument, to remove a
specific neighbor from the neighbor table.
Examples The following example removes the neighbor whose IPv6 address is 3FEE:12E1:2AC1:EA32:
# clear ipv6 eigrp neighbor 3FEE:12E1:2AC1:EA32
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
443
IP Addressing Services
clear ipv6 mfib counters
clear ipv6 mfib counters
To reset all active Multicast Forwarding Information Base (MFIB) traffic counters, use the clear ipv6 mfib
counters command in privileged EXEC mode.
clear ipv6 mfib [vrf vrf-name] counters [{group-name | group-address [{source-addresssource-name}]}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
source-address | source-name (Optional) IPv6 address or name of the source.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines After you enable the clear ipv6 mfib counters command, you can determine if additional traffic is forwarded
by using one of the following show commands that display traffic counters:
• show ipv6 mfib
• show ipv6 mfib active
• show ipv6 mfib count
• show ipv6 mfib interface
• show ipv6 mfib summary
Examples The following example clears and resets all MFIB traffic counters:
# clear ipv6 mfib counters
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
444
IP Addressing Services
clear ipv6 mld counters
clear ipv6 mld counters
To clear the Multicast Listener Discovery (MLD) interface counters, use the clear ipv6 mld counters command
in privileged EXEC mode.
clear ipv6 mld [vrf vrf-name] counters [interface-type]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface-type (Optional) Interface type. For more information, use the question mark (?) online help
function.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the clear ipv6 mld counters command to clear the MLD counters, which keep track of the number of
joins and leaves received. If you omit the optional interface-type argument, the clear ipv6 mld counters
command clears the counters on all interfaces.
Examples The following example clears the counters for Ethernet interface 1/0:
# clear ipv6 mld counters Ethernet1/0
Related Commands Command Description
show ipv6 mld interface Displays multicast-related information about an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
445
IP Addressing Services
clear ipv6 mld traffic
clear ipv6 mld traffic
To reset the Multicast Listener Discovery (MLD) traffic counters, use the clear ipv6 mld traffic command
in privileged EXEC mode.
clear ipv6 mld [vrf vrf-name] traffic
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Using the clear ipv6 mld traffic command will reset all MLD traffic counters.
Examples The following example resets the MLD traffic counters:
# clear ipv6 mld traffic
Command Description
show ipv6 mld traffic Displays the MLD traffic counters.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
446
IP Addressing Services
clear ipv6 mtu
clear ipv6 mtu
To clear the maximum transmission unit (MTU) cache of messages, use the clear ipv6 mtucommand in
privileged EXEC mode.
clear ipv6 mtu
Syntax Description This command has no arguments or keywords.
Command Default Messages are not cleared from the MTU cache.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If a router is flooded with ICMPv6 toobig messages, the router is forced to create an unlimited number of
entries in the MTU cache until all available memory is consumed. Use the clear ipv6 mtu command to clear
messages from the MTU cache.
Examples The following example clears the MTU cache of messages:
# clear ipv6 mtu
Related Commands Command Description
ipv6 flowset Configures flow-label marking in 1280-byte or larger packets sent by the router.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
447
IP Addressing Services
clear ipv6 multicast aaa authorization
clear ipv6 multicast aaa authorization
To clear authorization parameters that restrict user access to an IPv6 multicast network, use the clear ipv6
multicast aaa authorizationcommand in privileged EXEC mode.
clear ipv6 multicast aaa authorization [interface-type interface-number]
Syntax Description interface-type interface-number Interface type and number. For more information, use the question mark
(?) online help function.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Using the clear ipv6 multicast aaa authorization command without the optional interface-type and
interface-number arguments will clear all authorization parameters on a network.
Examples The following example clears all configured authorization parameters on an IPv6 network:
# clear ipv6 multicast aaa authorization FastEthernet 1/0
Related Commands Command Description
aaa authorization multicast default Sets parameters that restrict user access to an IPv6 multicast network.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
448
IP Addressing Services
clear ipv6 nd destination
clear ipv6 nd destination
To clear IPv6 host-mode destination cache entries, use the clear ipv6 nd destination command in privileged
EXEC mode.
clear ipv6 nd destination[vrf vrf-name]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 nd destination command clears IPv6 host-mode destination cache entries. If the vrf vrf-name
keyword and argument pair is used, then only information about the specified VRF is cleared.
Examples The following example shows how to clear IPv6 host-mode destination cache entries:
# clear ipv6 nd destination
Related Commands Command Description
ipv6 nd host mode strict Enables the conformant, or strict, IPv6 host mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
449
IP Addressing Services
clear ipv6 nd on-link prefix
clear ipv6 nd on-link prefix
To clear on-link prefixes learned through router advertisements (RAs), use the clear ipv6 nd on-link prefix
command in privileged EXEC mode.
clear ipv6 nd on-link prefix[vrf vrf-name]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the clear ipv6 nd on-link prefix command to clear locally reachable IPv6 addresses (e.g., on-link prefixes)
learned through RAs. If the vrf vrf-name keyword and argument pair is used, then only information about
the specified VRF is cleared.
Examples The following examples shows how to clear on-link prefixes learned through RAs:
# clear ipv6 nd on-link prefix
Related Commands Command Description
ipv6 nd host mode strict Enables the conformant, or strict, IPv6 host mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
450
IP Addressing Services
clear ipv6 nd router
clear ipv6 nd router
To clear neighbor discovery (ND) device entries learned through router advertisements (RAs), use the clear
ipv6 nd router command in privileged EXEC mode.
clear ipv6 nd router[vrf vrf-name]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the clear ipv6 nd router command to clear ND device entries learned through RAs. If the vrf vrf-name
keyword and argument pair is used, then only information about the specified VRF is cleared.
Examples The following example shows how to clear neighbor discovery ND device entries learned through
RAs:
# clear ipv6 nd router
Related Commands Command Description
ipv6 nd host mode strict Enables the conformant, or strict, IPv6 host mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
451
IP Addressing Services
clear ipv6 neighbors
clear ipv6 neighbors
To delete all entries in the IPv6 neighbor discovery cache, except static entries and ND cache entries on
non-virtual routing and forwarding (VRF) interfaces, use the clear ipv6 neighbors command in privileged
EXEC mode.
clear ipv6 neighbors [{interface type number[ipv6 ipv6-address] | statistics | vrf table-name
[{ipv6-address | statistics}]}]
clear ipv6 neighbors
Syntax Description interface type number (Optional) Clears the IPv6 neighbor discovery cache in the specified interface.
ipv6 ipv6-address (Optional) Clears the IPv6 neighbor discovery cache that matches the specified
IPv6 address on the specified interface.
statistics (Optional) Clears the IPv6 neighbor discovery entry cache.
vrf (Optional) Clears entries for a virtual private network (VPN) routing or
forwarding instance.
table-name (Optional) Table name or identifier. The value range is from 0x0 to 0xFFFFFFFF
(0 to 65535 in decimal).
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 neighbor command clears ND cache entries. If the command is issued without the vrf keyword,
then the command clears ND cache entries on interfaces associated with the default routing table (e.g., those
interfaces that do not have a vrf forwarding statement). If the command is issued with the vrf keyword, then
it clears ND cache entries on interfaces associated with the specified VRF.
Examples The following example deletes all entries, except static entries and ND cache entries on non-VRF
interfaces, in the neighbor discovery cache:
# clear ipv6 neighbors
The following example clears all IPv6 neighbor discovery cache entries, except static entries and
ND cache entries on non-VRF interfaces, on Ethernet interface 0/0:
# clear ipv6 neighbors interface Ethernet 0/0
The following example clears a neighbor discovery cache entry for 2001:0DB8:1::1 on Ethernet
interface 0/0:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
452
IP Addressing Services
clear ipv6 neighbors
# clear ipv6 neighbors interface Ethernet0/0 ipv6 2001:0DB8:1::1
In the following example, interface Ethernet 0/0 is associated with the VRF named red. Interfaces
Ethernet 1/0 and Ethernet 2/0 are associated with the default routing table (because they are not
associated with a VRF). Therefore, the clear ipv6 neighbor command will clear ND cache entries
on interfaces Ethernet 1/0 and Ethernet 2/0 only. In order to clear ND cache entries on interface
Ethernet 0/0, the user must issue the clear ipv6 neighbor vrf red command.
interface ethernet0/0
vrf forward red
ipv6 address 2001:db8:1::1/64
interface ethernet1/0
ipv6 address 2001:db8:2::1/64
interface ethernet2/0
ipv6 address 2001:db8:3::1/64
Related Commands Command Description
ipv6 neighbor Configures a static entry in the IPv6 neighbor discovery cache.
show ipv6 neighbors Displays IPv6 neighbor discovery cache information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
453
IP Addressing Services
clear ipv6 nhrp
clear ipv6 nhrp
To clear all dynamic entries from the Next Hop Resolution Protocol (NHRP) cache, use the clear ipv6 nhrp
command in privileged EXEC mode.
clear ipv6 nhrp [{ipv6-address | counters}]
Syntax Description ipv6-address (Optional) The IPv6 network to delete.
counters (Optional) Specifies NHRP counters to delete.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command does not clear any static (configured) IPv6-to-nonbroadcast multiaccess (NBMA) address
mappings from the NHRP cache.
Examples The following example shows how to clear all dynamic entries from the NHRP cache for the interface:
# clear ipv6 nhrp
Related Commands Command Description
show ipv6 nhrp Displays the NHRP cache.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
454
IP Addressing Services
clear ipv6 ospf
clear ipv6 ospf
To clear the Open Shortest Path First (OSPF) state based on the OSPF routing process ID, use the cl ear ipv6
ospf command in privileged EXEC mode.
clear ipv6 ospf [process-id] {process | force-spf | redistribution}
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer.
The number used here is the number assigned administratively when enabling the OSPF
routing process.
process Restarts the OSPF process.
force-spf Starts the shortest path first (SPF) algorithm without first clearing the OSPF database.
redistribution Clears OSPF route redistribution.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When the process keyword is used with the clear ipv6 ospfcommand, the OSPF database is cleared and
repopulated, and then the shortest path first (SPF) algorithm is performed. When the force-spfkeyword is
used with the clear ipv6 ospfcommand, the OSPF database is not cleared before the SPF algorithm is performed.
Use the process-idoption to clear only one OSPFprocess. If the process-idoptionis not specified,all OSPF
processesare cleared.
Examples The following example starts the SPF algorithm without clearing the OSPF database:
# clear ipv6 ospf force-spf
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
455
IP Addressing Services
clear ipv6 ospf counters
clear ipv6 ospf counters
To clear the Open Shortest Path First (OSPF) state based on the OSPF routing process ID, use the cl ear ipv6
ospf command in privileged EXEC mode.
clear ipv6 ospf [process-id] counters [neighbor [{neighbor-interfaceneighbor-id}]]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer.
The number used here is the number assigned administratively when enabling the OSPF
routing process.
neighbor (Optional) Neighbor statistics per interface or neighbor ID.
neighbor-interface (Optional) Neighbor interface.
neighbor-id (Optional) IPv6 or IP address of the neighbor.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the neighbor neighbor-interface option to clear counters for all neighbors on a specified interface. If the
neighbor neighbor-interface option is not used, all OSPF counters are cleared.
Use the neighbor neighbor-id option to clear counters at a specified neighbor. If the neighbor neighbor-id
option is not used,all OSPF counters are cleared.
Examples The following example provides detailed information on a neighbor router:
# show ipv6 ospf neighbor detail
Neighbor 10.0.0.1
In the area 1 via interface Serial19/0
Neighbor:interface-id 21, link-local address FE80::A8BB:CCFF:FE00:6F00
Neighbor priority is 1, State is FULL, 6 state changes
Options is 0x194AE05
Dead timer due in 00:00:37
Neighbor is up for 00:00:15
Index 1/1/1, retransmission queue length 0, number of retransmission 1
First 0x0(0)/0x0(0)/0x0(0) Next 0x0(0)/0x0(0)/0x0(0)
Last retransmission scan length is 1, maximum is 1
Last retransmission scan time is 0 msec, maximum is 0 msec
The following example clears all neighbors on the specified interface:
# clear ipv6 ospf counters neighbor s19/0
The following example now shows that there have been 0 state changes since the clear ipv6 ospf
counters neighbor s19/0 command was used:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
456
IP Addressing Services
clear ipv6 ospf counters
# show ipv6 ospf neighbor detail
Neighbor 10.0.0.1
In the area 1 via interface Serial19/0
Neighbor:interface-id 21, link-local address FE80::A8BB:CCFF:FE00:6F00
Neighbor priority is 1, State is FULL, 0 state changes
Options is 0x194AE05
Dead timer due in 00:00:39
Neighbor is up for 00:00:43
Index 1/1/1, retransmission queue length 0, number of retransmission 1
First 0x0(0)/0x0(0)/0x0(0) Next 0x0(0)/0x0(0)/0x0(0)
Last retransmission scan length is 1, maximum is 1
Last retransmission scan time is 0 msec, maximum is 0 msec
Related Commands Command Description
show ipv6 ospf neighbor Displays OSPF neighbor information on a per-interface basis.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
457
IP Addressing Services
clear ipv6 ospf events
clear ipv6 ospf events
To clear the Open Shortest Path First (OSPF) for IPv6 event log content based on the OSPF routing process
ID, use the cl ear ipv6 ospf events command in privileged EXEC mode.
clear ipv6 ospf [process-id] events
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when enabling the OSPF routing
process.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the optional process-id argument to clear the IPv6 event log content of a specified OSPF routing process.
If the process-id argument is not used, all event log content is cleared.
Examples The following example enables the clearing of OSPF for IPv6 event log content for routing process
1:
# clear ipv6 ospf 1 events
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
458
IP Addressing Services
clear ipv6 pim reset
clear ipv6 pim reset
To delete all entries from the topology table and reset the Multicast Routing Information Base (MRIB)
connection, use the clear ipv6 pim reset command in privileged EXEC mode.
clear ipv6 pim [vrf vrf-name] reset
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Using the clear ipv6 pim reset command breaks the PIM-MRIB connection, clears the topology table, and
then reestablishes the PIM-MRIB connection. This procedure forces MRIB resynchronization.
Caution Use the clear ipv6 pim reset command with caution, as it clears all PIM protocol information from the PIM
topology table. Use of the clear ipv6 pim reset command should be reserved for situations where PIM and
MRIB communication are malfunctioning.
Examples The following example deletes all entries from the topology table and resets the MRIB connection:
# clear ipv6 pim reset
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
459
IP Addressing Services
clear ipv6 pim topology
clear ipv6 pim topology
To clear the Protocol Independent Multicast (PIM) topology table, use the clear ipv6 pim topology command
in privileged EXEC mode.
clear ipv6 pim [vrf vrf-name] topology [{group-namegroup-address}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
Command Default When the command is used with no arguments, all group entries located in the PIM topology table are cleared
of PIM protocol information.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command clears PIM protocol informationfrom all group entries located in the PIM topology table.
Information obtained from the MRIB table is retained. If a multicast group is specified, only those group
entries are cleared.
Examples The following example clears all group entries located in the PIM topology table:
# clear ipv6 pim topology
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
460
IP Addressing Services
clear ipv6 pim traffic
clear ipv6 pim traffic
To clear the Protocol Independent Multicast (PIM) traffic counters, use the clear ipv6 pim traffic command
in privileged EXEC mode.
clear ipv6 pim [vrf vrf-name] traffic
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Default When the command is used with no arguments, all traffic counters are cleared.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command clears PIM traffic counters. If the vrf vrf-name keyword and argument are used, only those
counters are cleared.
Examples The following example clears all PIM traffic counter:
# clear ipv6 pim traffic
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
461
IP Addressing Services
clear ipv6 prefix-list
clear ipv6 prefix-list
To reset the hit count of the IPv6 prefix list entries, use the clear ipv6 prefix-list command in privileged
EXEC mode.
clear ipv6 prefix-list [prefix-list-name] [ipv6-prefix/prefix-length]
Syntax Description prefix-list-name (Optional) The name of the prefix list from which the hit count is to be cleared.
ipv6-prefix (Optional) The IPv6 network from which the hit count is to be cleared.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
/ prefix-length (Optional) The length of the IPv6 prefix. A decimal value that indicates how many of the
high-order contiguous bits of the address comprise the prefix (the network portion of the
address). A slash mark must precede the decimal value.
Command Default The hit count is automatically cleared for all IPv6 prefix lists.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 prefix-list command is similar to the clear ip prefix-list command, except that it is
IPv6-specific.
The hit count is a value indicating the number of matches to a specific prefix list entry.
Examples The following example clears the hit count from the prefix list entries for the prefix list named
first_list that match the network mask 2001:0DB8::/35.
# clear ipv6 prefix-list first_list 2001:0DB8::/35
Related Commands Command Description
ipv6 prefix-list Creates an entry in an IPv6 prefix list.
ipv6 prefix-list sequence-number Enables the generation of sequence numbers for entries in an IPv6
prefix list.
show ipv6 prefix-list Displays information about an IPv6 prefix list or prefix list entries.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
462
IP Addressing Services
clear ipv6 rip
clear ipv6 rip
To delete routes from the IPv6 Routing Information Protocol (RIP) routing table, use the clear ipv6 rip
command in privileged EXEC mode.
clear ipv6 rip [name][vrf vrf-name]
clear ipv6 rip [name]
Syntax Description name (Optional) Name of an IPv6 RIP process.
vrf vrf-name (Optional) Clears information about the specified Virtual Routing and Forwarding (VRF)
instance.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When the name argument is specified, only routes for the specified IPv6 RIP process are deleted from the
IPv6 RIP routing table. If no name argument is specified, all IPv6 RIP routes are deleted.
Use the show ipv6 rip command to display IPv6 RIP routes.
Use the clear ipv6 rip name vrf vrf-name command to delete the specified VRF instances for the specified
IPv6 RIP process.
Examples The following example deletes all the IPv6 routes for the RIP process called one:
# clear ipv6 rip one
The following example deletes the IPv6 VRF instance, called vrf1 for the RIP process, called one:
# clear ipv6 rip one vrf vrf1
*Mar 15 12:36:17.022: RIPng: Deleting 2001:DB8::/32
*Mar 15 12:36:17.022: [Exec]IPv6RT[vrf1]: rip <name>, Delete all next-hops for 2001:DB8::1
*Mar 15 12:36:17.022: [Exec]IPv6RT[vrf1]: rip <name>, Delete 2001:DB8::1 from table
*Mar 15 12:36:17.022: [IPv6 RIB Event Handler]IPv6RT[<red>]: Event: 2001:DB8::1, Del, owner
rip, previous None
Related Commands Command Description
debug ipv6 rip Displays the current contents of the IPv6 RIP routing table.
ipv6 rip vrf-mode enable Enables VRF-aware support for IPv6 RIP.
show ipv6 rip Displays the current content of the IPv6 RIP routing table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
463
IP Addressing Services
clear ipv6 route
clear ipv6 route
To delete routes from the IPv6 routing table, use the clear ipv6 route command in privileged EXEC mode.
{clear ipv6 route {ipv6-addressipv6-prefix/prefix-length} | *}
Syntax Description ipv6-address The address of the IPv6 network to delete from the table.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
ipv6-prefix The IPv6 network number to delete from the table.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
/ prefix-length The length of the IPv6 prefix. A decimal value that indicates how many of the high-order
contiguous bits of the address comprise the prefix (the network portion of the address). A
slash mark must precede the decimal value.
* Clears all IPv6 routes.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 route command is similar to the clear ip route command, except that it is IPv6-specific.
When the ipv6-address or ipv6-prefix/ prefix-length argument is specified, only that route is deleted from the
IPv6 routing table. When the * keyword is specified, all routes are deleted from the routing table (the
per-destination maximum transmission unit [MTU] cache is also cleared).
Examples The following example deletes the IPv6 network 2001:0DB8::/35:
# clear ipv6 route 2001:0DB8::/35
Related Commands Command Description
ipv6 route Establishes static IPv6 routes.
show ipv6 route Displays the current contents of the IPv6 routing table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
464
IP Addressing Services
clear ipv6 spd
clear ipv6 spd
To clear the most recent Selective Packet Discard (SPD) state transition, use the clear ipv6 spd command in
privileged EXEC mode.
clear ipv6 spd
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The clear ipv6 spd command removes the most recent SPD state transition and any trend historical data.
Examples The following example shows how to clear the most recent SPD state transition:
# clear ipv6 spd
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
465
IP Addressing Services
debug nhrp
debug nhrp
To enable Next Hop Resolution Protocol (NHRP) debugging, use the debug nhrp command in privileged
EXEC mode. To disable debugging output, use the no form of this command.
debug nhrp [{attribute | cache | condition {interface tunnel number | peer {nbma {ipv4-nbma-address
nbma-name ipv6-nbma-address} } | umatched | vrf vrf-name} | detail | error | extension | group |
packet | rate}]
no debug nhrp [{attribute | cache | condition {interface tunnel number | peer {nbma
{ipv4-nbma-address nbma-name ipv6-nbma-address} } unmatched | vrf vrf-name} | detail | error |
extension | group | packet | rate }]
Syntax Description attribute (Optional) Enables NHRP attribute debugging operations.
cache (Optional) Enables NHRP cache debugging operations.
condition (Optional) Enables NHRP conditional debugging operations.
interface tunnel number (Optional) Enables debugging operations for the tunnel interface.
nbma (Optional) Enables debugging operations for the non-broadcast multiple access
(NBMA) network.
ipv4-nbma-address (Optional) Enables debugging operations based on the IPv4 address of the NBMA
network.
nbma-name (Optional) NBMA network name.
IPv6-address (Optional) Enables debugging operations based on the IPv6 address of the NBMA
network.
vrf vrf-name (Optional) Enables debugging operations for the virtual routing and forwarding
instance.
detail (Optional) Displays detailed logs of NHRP debugs.
error (Optional) Enables NHRP error debugging operations.
extension (Optional) Enables NHRP extension processing debugging operations.
group (Optional) Enables NHRP group debugging operations.
packet (Optional) Enables NHRP activity debugging.
rate (Optional) Enables NHRP rate limiting.
routing (Optional) Enables NHRP routing debugging operations.
Command Default NHRP debugging is not enabled.
Command Modes Privileged EXEC (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
466
IP Addressing Services
debug nhrp
Command History Release Modification
Cisco IOS XE Denali 16.5.1 This command was introduced.
Usage Guidelines Use the debug nhrp detail command to view the NHRP attribute logs.
The Virtual-Access number keyword-argument pair is visible only if the virtual access interface is available
on the device.
Examples The following sample output from the debug nhrp command displays NHRP debugging output for
IPv4:
Switch# debug nhrp
Aug 9 13:13:41.486: NHRP: Attempting to send packet via DEST 10.1.1.99
Aug 9 13:13:41.486: NHRP: Encapsulation succeeded. Tunnel IP addr 10.11.11.99
Aug 9 13:13:41.486: NHRP: Send Registration Request via Tunnel0 vrf 0, packet size: 105
Aug 9 13:13:41.486: src: 10.1.1.11, dst: 10.1.1.99
Aug 9 13:13:41.486: NHRP: 105 bytes out Tunnel0
Aug 9 13:13:41.486: NHRP: Receive Registration Reply via Tunnel0 vrf 0, packet size: 125
Aug 9 13:13:41.486: NHRP: netid_in = 0, to_us = 1
Related Commands Command Description
show ip nhrp Displays NHRP mapping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
467
IP Addressing Services
fhrp delay
fhrp delay
To specify the delay period for the initialization of First Hop Redundancy Protocol (FHRP) clients, use the
fhrp delay command in interface configuration mode. To remove the delay period specified, use the no form
of this command.
fhrp delay {[minimum] [reload] seconds}
no fhrp delay {[minimum] [reload] seconds}
Syntax Description minimum (Optional) Configures the delay period after an interface becomes available.
reload (Optional) Configures the delay period after the device reloads.
seconds Delay period in seconds. The range is from 0 to 3600.
Command Default None
Command Modes Interface configuration (config-if)
Examples This example shows how to specify the delay period for the initialization of FHRP clients:
Device(config-if)# fhrp delay minimum 90
Related Commands Command Description
show fhrp Displays First Hop Redundancy Protocol (FHRP) information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
468
IP Addressing Services
fhrp version vrrp v3
fhrp version vrrp v3
To enable Virtual Router Redundancy Protocol version 3 (VRRPv3) and Virtual Router Redundancy Service
(VRRS) configuration on a device, use the fhrp version vrrp v3 command in global configuration mode. To
disable the ability to configure VRRPv3 and VRRS on a device, use the no form of this command.
fhrp version vrrp v3
no fhrp version vrrp v3
Syntax Description This command has no keywords or arguments.
Command Default VRRPv3 and VRRS configuration on a device is not enabled.
Command Modes Global configuration (config)
Usage Guidelines When VRRPv3 is in use, VRRP version 2 (VRRPv2) is unavailable.
Examples In the following example, a tracking process is configured to track the state of an IPv6 object using
a VRRPv3 group. VRRP on GigabitEthernet interface 0/0/0 then registers with the tracking process
to be informed of any changes to the IPv6 object on the VRRPv3 group. If the IPv6 object state on
serial interface VRRPv3 goes down, then the priority of the VRRP group is reduced by 20:
Device(config)# fhrp version vrrp v3
Device(config)# interface GigabitEthernet 0/0/0
Device(config-if)# vrrp 1 address-family ipv6
Device(config-if-vrrp)# track 1 decrement 20
Related Commands Command Description
track (VRRP) Enables an object to be tracked using a VRRPv3 group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
469
IP Addressing Services
ip address dhcp
ip address dhcp
To acquire an IP address on an interface from the DHCP, use the ip address dhcp command in interface
configuration mode. To remove any address that was acquired, use the no form of this command.
ip address dhcp [client-id interface-type number] [hostname hostname]
no ip address dhcp [client-id interface-type number] [hostname hostname]
Syntax Description client-id (Optional) Specifies the client identifier. By default, the client identifier is an ASCII value.
The client-id interface-type number option sets the client identifier to the hexadecimal MAC
address of the named interface.
interface-type (Optional) Interface type. For more information, use the question mark (?) online help
function.
number (Optional) Interface or subinterface number. For more information about the numbering
syntax for your networking device, use the question mark (?) online help function.
hostname (Optional) Specifies the hostname.
hostname (Optional) Name of the host to be placed in the DHCP option 12 field. This name need not
be the same as the hostname entered in global configuration mode.
Command Default The hostname is the globally configured hostname of the device. The client identifier is an ASCII value.
Command Modes Interface configuration (config-if)
Usage Guidelines The ip address dhcp command allows any interface to dynamically learn its IP address by using the DHCP
protocol. It is especially useful on Ethernet interfaces that dynamically connect to an Internet service provider
(ISP). Once assigned a dynamic address, the interface can be used with the Port Address Translation (PAT)
of Cisco IOS Network Address Translation (NAT) to provide Internet access to a privately addressed network
attached to the device.
The ip address dhcp command also works with ATM point-to-point interfaces and will accept any
encapsulation type. However, for ATM multipoint interfaces you must specify Inverse ARP via the protocol
ip inarp interface configuration command and use only the aa15snap encapsulation type.
Some ISPs require that the DHCPDISCOVER message have a specific hostname and client identifier that is
the MAC address of the interface. The most typical usage of the ip address dhcp client-id interface-type
number hostname hostname command is when interface-type is the Ethernet interface where the command
is configured and interface-type number is the hostname provided by the ISP.
A client identifier (DHCP option 61) can be a hexadecimal or an ASCII value. By default, the client identifier
is an ASCII value. The client-id interface-type number option overrides the default and forces the use of the
hexadecimal MAC address of the named interface.
If a Cisco device is configured to obtain its IP address from a DHCP server, it sends a DHCPDISCOVER
message to provide information about itself to the DHCP server on the network.
If you use the ip address dhcp command with or without any of the optional keywords, the DHCP option 12
field (hostname option) is included in the DISCOVER message. By default, the hostname specified in option
12 will be the globally configured hostname of the device. However, you can use the ip address dhcp hostname
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
470
IP Addressing Services
ip address dhcp
hostname command to place a different name in the DHCP option 12 field than the globally configured
hostname of the device.
The no ip address dhcp command removes any IP address that was acquired, thus sending a DHCPRELEASE
message.
You might need to experiment with different configurations to determine the one required by your DHCP
server. The table below shows the possible configuration methods and the information placed in the DISCOVER
message for each method.
Table 31: Configuration Method and Resulting Contents of the DISCOVER Message
Configuration Method Contents of DISCOVER Messages
ip address dhcp The DISCOVER message contains “cisco- mac-address -Eth1” in the
client ID field. The mac-address is the MAC address of the Ethernet 1
interface and contains the default hostname of the device in the option
12 field.
ip address dhcp hostname The DISCOVER message contains “cisco- mac-address -Eth1” in the
hostname client ID field. The mac-address is the MAC address of the Ethernet 1
interface, and contains hostname in the option 12 field.
ip address dhcp client-id ethernet The DISCOVER message contains the MAC address of the Ethernet 1
1 interface in the client ID field and contains the default hostname of the
device in the option 12 field.
ip address dhcp client-id ethernet The DISCOVER message contains the MAC address of the Ethernet 1
1 hostname hostname interface in the client ID field and contains hostname in the option 12
field.
Examples In the examples that follow, the command ip address dhcp is entered for Ethernet interface 1. The
DISCOVER message sent by a device configured as shown in the following example would contain
“cisco- mac-address -Eth1” in the client-ID field, and the value abc in the option 12 field.
hostname abc
!
interface GigabitEthernet 1/0/1
ip address dhcp
The DISCOVER message sent by a device configured as shown in the following example would
contain “cisco- mac-address -Eth1” in the client-ID field, and the value def in the option 12 field.
hostname abc
!
interface GigabitEthernet 1/0/1
ip address dhcp hostname def
The DISCOVER message sent by a device configured as shown in the following example would
contain the MAC address of Ethernet interface 1 in the client-id field, and the value abc in the option
12 field.
hostname abc
!
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
471
IP Addressing Services
ip address dhcp
interface Ethernet 1
ip address dhcp client-id GigabitEthernet 1/0/1
The DISCOVER message sent by a device configured as shown in the following example would
contain the MAC address of Ethernet interface 1 in the client-id field, and the value def in the option
12 field.
hostname abc
!
interface Ethernet 1
ip address dhcp client-id GigabitEthernet 1/0/1 hostname def
Related Commands Command Description
ip dhcp pool Configures a DHCP address pool on a Cisco IOS DHCP server and enters DHCP pool
configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
472
IP Addressing Services
ip address pool (DHCP)
ip address pool (DHCP)
To enable the IP address of an interface to be automatically configured when a Dynamic Host Configuration
Protocol (DHCP) pool is populated with a subnet from IP Control Protocol (IPCP) negotiation, use the ip
address pool command in interface configuration mode. To disable autoconfiguring of the IP address of the
interface, use the no form of this command.
ip address pool name
no ip address pool
Syntax Description name Name of the DHCP pool. The IP address of the interface will be automatically configured from the
DHCP pool specified in name.
Command Default IP address pooling is disabled.
Command Modes Interface configuration
Usage Guidelines Use this command to automatically configure the IP address of a LAN interface when there are DHCP clients
on the attached LAN that should be serviced by the DHCP pool on the device. The DHCP pool obtains its
subnet dynamically through IPCP subnet negotiation.
Examples The following example specifies that the IP address of GigabitEthernet interface 1/0/1 will be
automatically configured from the address pool named abc:
ip dhcp pool abc
import all
origin ipcp
!
interface GigabitEthernet 1/0/1
ip address pool abc
Related Commands Command Description
show ip interface Displays the usability status of interfaces configured for IP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
473
IP Addressing Services
ip address
ip address
To set a primary or secondary IP address for an interface, use the ip address command in interface configuration
mode. To remove an IP address or disable IP processing, use the noform of this command.
ip address ip-address mask [secondary [vrf vrf-name]]
no ip address ip-address mask [secondary [vrf vrf-name]]
Syntax Description ip-address IP address.
mask Mask for the associated IP subnet.
secondary (Optional) Specifies that the configured address is a secondary IP address. If this keyword is
omitted, the configured address is the primary IP address.
Note If the secondary address is used for a VRF table configuration with the vrf
keyword, the vrf keyword must be specified also.
vrf (Optional) Name of the VRF table. The vrf-name argument specifies the VRF name of the
ingress interface.
Command Default No IP address is defined for the interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines An interface can have one primary IP address and multiple secondary IP addresses. Packets generated by the
Cisco IOS software always use the primary IP address. Therefore, all devices and access servers on a segment
should share the same primary network number.
Hosts can determine subnet masks using the Internet Control Message Protocol (ICMP) mask request message.
Devices respond to this request with an ICMP mask reply message.
You can disable IP processing on a particular interface by removing its IP address with the no ip address
command. If the software detects another host using one of its IP addresses, it will print an error message on
the console.
The optional secondary keyword allows you to specify an unlimited number of secondary addresses. Secondary
addresses are treated like primary addresses, except the system never generates datagrams other than routing
updates with secondary source addresses. IP broadcasts and Address Resolution Protocol (ARP) requests are
handled properly, as are interface routes in the IP routing table.
Secondary IP addresses can be used in a variety of situations. The following are the most common applications:
• There may not be enough host addresses for a particular network segment. For example, your subnetting
allows up to 254 hosts per logical subnet, but on one physical subnet you need 300 host addresses. Using
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
474
IP Addressing Services
ip address
secondary IP addresses on the devices or access servers allows you to have two logical subnets using
one physical subnet.
• Many older networks were built using Level 2 bridges. The judicious use of secondary addresses can aid
in the transition to a subnetted, device-based network. Devices on an older, bridged segment can be easily
made aware that many subnets are on that segment.
• Two subnets of a single network might otherwise be separated by another network. This situation is not
permitted when subnets are in use. In these instances, the first network is extended, or layered on top of
the second network using secondary addresses.
Note • If any device on a network segment uses a secondary address, all other devices on that same segment
must also use a secondary address from the same network or subnet. Inconsistent use of secondary
addresses on a network segment can very quickly cause routing loops.
• When you are routing using the Open Shortest Path First (OSPF) algorithm, ensure that all secondary
addresses of an interface fall into the same OSPF area as the primary addresses.
• If you configure a secondary IP address, you must disable sending ICMP redirect messages by entering
the no ip redirects command, to avoid high CPU utilization.
Examples In the following example, 192.108.1.27 is the primary address and 192.31.7.17 is the secondary
address for GigabitEthernet interface 1/0/1:
Device> enable
Device# configure terminal
Device(config)# interface GigabitEthernet 1/0/1
Device(config-if)# ip address 192.108.1.27 255.255.255.0
Device(config-if)# ip address 192.31.7.17 255.255.255.0 secondary
Related Commands Command Description
match ip route-source Specifies a source IP address to match to required route maps that have been set
up based on VRF connected routes.
route-map Defines the conditions for redistributing routes from one routing protocol into
another, or to enable policy routing.
set vrf Enables VPN VRF selection within a route map for policy-based routing VRF
selection.
show ip arp Displays the ARP cache, in which SLIP addresses appear as permanent ARP table
entries.
show ip interface Displays the usability status of interfaces configured for IP.
show route-map Displays static and dynamic route maps.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
475
IP Addressing Services
ip nat inside source
ip nat inside source
To enable Network Address Translation (NAT) of the inside source address, use the ip nat inside source
command in global configuration mode. To remove the static translation, or the dynamic association to a pool,
use the no form of this command.
Dynamic NAT
ip nat inside source { list { access-list-number access-list-name } | route-map name } {
interface type number | pool name } [no-payload] [overload] [c] [ vrf name ]
no ip nat inside source { list { access-list-number access-list-name } | route-map name }
{ interface type number | pool name } [no-payload] [overload] [ vrf name ]
Static NAT
ip nat inside source static { interface type number | local-ip global-ip} [extendable] [no-alias]
[no-payload] [ route-map name ] [reversible][ vrf name [forced] ]
no ip nat inside source static { interface type number | local-ip global-ip} [extendable]
[no-alias] [no-payload] [ route-map name ] [ vrf name [forced] ]
Port Static NAT
ip nat inside source static {tcp | udp} {local-ip local-port global-ip global-port [extendable]
[forced] [no-alias] [no-payload] [ route-map name ] [ vrf name ] | interface global-port}
no ip nat inside source static {tcp | udp} {local-ip local-port global-ip global-port [extendable]
[forced] [no-alias] [no-payload] [ route-map name ] [ vrf name ] | interface global-port}
Network Static NAT
ip nat inside source static network local-network global-network mask [extendable]
[forced] [no-alias] [no-payload] [ vrf name ]
no ip nat inside source static network local-network global-network mask [extendable] [forced]
[no-alias] [no-payload] [ vrf name ]
Syntax Description list access-list-number Specifies the number of a standard IP access list. Packets with source addresses
that pass the access list are dynamically translated using global addresses from
the named pool.
list access-list-name Specifies the name of a standard IP access list. Packets with source addresses that
pass the access list are dynamically translated using global addresses from the
named pool.
route-map name Specifies the named route map.
interface Specifies an interface for the global address.
type Interface type. For more information, use the question mark (?) online help
function.
number Interface or subinterface number. For more information about the numbering
syntax for your networking device, use the question mark (?) online help function.
pool name Specifies the name of the pool from which global IP addresses are allocated
dynamically.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
476
IP Addressing Services
ip nat inside source
no-payload (Optional) Prohibits the translation of an embedded address or port in the payload.
overload (Optional) Enables the device to use one global address for many local addresses.
When overloading is configured, the TCP or UDP port number of each inside host
distinguishes between the multiple conversations using the same local IP address.
vrf name (Optional) Associates the NAT translation rule with a particular VPN routing and
forwarding (VRF) instance.
static Sets up a single static translation.
local-ip Local IP address assigned to a host on the inside network. The address could be
randomly chosen, allocated from RFC 1918, or obsolete.
global-ip Globally unique IP address of an inside host as it appears to the outside network.
extendable (Optional) Extends the translation.
forced (Optional) Forcefully deletes an entry and its children from the configuration.
no-alias (Optional) Prohibits an alias from being created for the global address.
tcp Establishes the TCP protocol.
udp Establishes the UDP protocol.
local-port Local TCP or UDP port. The range is from 1 to 65535.
global-port Global TCP or UDP port. The range is from 1 to 65535.
network local-network Specifies the local subnet translation.
global-network Global subnet translation.
mask IP network mask to be used with subnet translations.
Command Default No NAT translation of inside source addresses occurs.
Command Modes Global configuration (config)
Command History
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Cisco IOS XE Dublin 17.10.1 The route-map keyword was introduced.
Cisco IOS XE Amsterdam 17.1.1 The vrf keyword was introduced.
Usage Guidelines The optional keywords of the ip nat inside source command can be entered in any order.
This command has two forms: the dynamic and the static address translation. The form with an access list
establishes the dynamic translation. Packets from addresses that match the standard access list are translated
using global addresses allocated from the pool named with the ip nat pool command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
477
IP Addressing Services
ip nat inside source
Packets that enter the device through the inside interface and packets sourced from the device are checked
against the access list for possible NAT candidates. The access list is used to specify which traffic is to be
translated.
Alternatively, the syntax form with the keyword static establishes a single static translation.
Note When a session is initiated from outside with the source IP as the outside global address, the device is unable
to determine the destination VRF of the packet.
Note When you configure NAT with a VRF-enabled interface address that acts as the global address, you must
configure the ip nat inside source static no-alias command. If the no-alias keyword is not configured,
Telnet to the VRF-enabled interface address fails.
Examples The following example shows how to translate between inside hosts addressed from either the
192.0.2.0 or the 198.51.100.0 network to the globally unique 203.0.113.209/28 network:
ip nat pool net-209 203.0.113.209 203.0.113.222 prefix-length 28
ip nat inside source list 1 pool net-209
!
interface ethernet 0
ip address 203.0.113.113 255.255.255.240
ip nat outside
!
interface ethernet 1
ip address 192.0.2.1 255.255.255.0
ip nat inside
!
access-list 1 permit 192.0.2.1 255.255.255.0
access-list 1 permit 198.51.100.253 255.255.255.0
The following example shows how to translate the traffic that is local to the provider’s edge device
running NAT (NAT-PE):
ip nat inside source list 1 interface ethernet 0 vrf vrf1 overload
ip nat inside source list 1 interface ethernet 0 vrf vrf2 overload
!
ip route vrf vrf1 10.0.0.1 10.0.0.1 192.0.2.1
ip route vrf vrf2 10.0.0.1 10.0.0.1 192.0.2.1
!
access-list 1 permit 10.1.1.1 0.0.0.255
!
ip nat inside source list 1 interface ethernet 1 vrf vrf1 overload
ip nat inside source list 1 interface ethernet 1 vrf vrf2 overload
!
ip route vrf vrf1 10.0.0.1 10.0.0.1 198.51.100.1 global
ip route vrf vrf2 10.0.0.1 10.0.0.1 198.51.100.1 global
access-list 1 permit 10.1.1.0 0.0.0.255
The following example shows how to translate sessions from outside to inside networks:
ip nat pool POOL-A 10.1.10.1 10.1.10.126 255.255.255.128
ip nat pool POOL-B 10.1.20.1 10.1.20.126 255.255.255.128
ip nat inside source route-map MAP-A pool POOL-A reversible
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
478
IP Addressing Services
ip nat inside source
ip nat inside source route-map MAP-B pool POOL-B reversible
!
ip access-list extended ACL-A
permit ip any 10.1.10.128 0.0.0.127
ip access-list extended ACL-B
permit ip any 10.1.20.128 0.0.0.127
!
route-map MAP-A permit 10
match ip address ACL-A
!
route-map MAP-B permit 10
match ip address ACL-B
!
The following example shows how to configure the route map R1 to allow outside-to-inside translation
for static NAT:
ip nat inside source static 10.1.1.1 10.2.2.2 route-map R1 reversible
!
ip access-list extended ACL-A
permit ip any 10.1.10.128 0.0.0.127
route-map R1 permit 10
match ip address ACL-A
The following example shows how to configure NAT inside and outside traffic in the same VRF:
interface Loopback1
ip vrf forwarding forwarding1
ip address 192.0.2.11 255.255.255.0
ip nat inside
ip virtual-reassembly
!
interface Ethernet0/0
ip vrf forwarding forwarding2
ip address 192.0.2.22 255.255.255.0
ip nat outside
ip virtual-reassembly
ip nat pool MYPOOL 192.0.2.5 192.0.2.5 prefix-length 24
ip nat inside source list acl-nat pool MYPOOL vrf vrf1 overload
!
!
ip access-list extended acl-nat
permit ip 192.0.2.0 0.0.0.255 any
Related Commands Command Description
access-list (IP extended) Defines an extended IP access list.
access-list (IP standard) Defines a standard IP access list.
clear ip nat translation Clears dynamic NAT translations from the translation table.
interface Configures an interface type and enters interface configuration mode.
ip access-list Defines an IP access list or object group access control list by name or number.
ip nat Designates that traffic originating from or destined for the interface is subject
to NAT.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
479
IP Addressing Services
ip nat inside source
Command Description
ip nat inside destination Enables NAT of the inside destination address.
ip nat outside source Enables NAT of the outside source address.
ip nat pool Defines a pool of IP addresses for NAT.
ip nat service Enables a port other than the default port.
ip route vrf Establishes static routes for a VRF instance.
ip vrf forwarding Associates a VRF instance with a diameter peer.
permit Sets conditions in a named IP access list or object group access control list that
will permit packets.
route-map Defines the conditions for redistributing routes from one routing protocol into
another routing protocol, or enables policy routing.
show ip nat statistics Displays NAT statistics.
show ip nat translations Displays active NAT translations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
480
IP Addressing Services
ip nat outside source
ip nat outside source
To enable Network Address Translation (NAT) of the outside source address, use the ip nat outside source
command in global configuration mode. To remove the static entry or the dynamic association, use the no
form of this command.
Dynamic NAT
ip nat outside source { list { access-list-number access-list-name } } pool pool-name
[ vrf name ] [add-route]
no ip nat outside source { list { access-list-number access-list-name } } pool pool-name
[ vrf name ] [add-route]
Static NAT
ip nat outside source static global-ip local-ip [ vrf name ] [add-route] [extendable]
[no-alias]
no ip nat outside source static global-ip local-ip [ vrf name ] [add-route] [extendable]
[no-alias]
Port Static NAT
ip nat outside source static { tcp | udp } global-ip global-port local-ip local-port [
vrf name ] [add-route] [extendable] [no-alias]
no ip nat outside source static { tcp | udp } global-ip global-port local-ip local-port
[ vrf name ] [add-route] [extendable] [no-alias]
Network Static NAT
ip nat outside source static network global-network local-network mask [ vrf name ]
[add-route] [extendable] [no-alias]
no ip nat outside source static network global-network local-network mask [ vrf
name ] [add-route] [extendable] [no-alias]
Syntax Description list access-list-number Specifies the number of a standard IP access list. Packets with source addresses
that pass the access list are translated using global addresses from the named pool.
list access-list-name Specifies the name of a standard IP access list. Packets with source addresses that
pass the access list are translated using global addresses from the named pool.
pool pool-name Specifies the name of the pool from which global IP addresses are allocated.
add-route (Optional) Adds a static route for the outside local address.
vrf name (Optional) Associates the NAT rule with a particular VPN routing and forwarding
(VRF) instance.
static Sets up a single static translation.
global-ip Globally unique IP address assigned to a host on the outside network by its owner.
The address was allocated from the globally routable network space.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
481
IP Addressing Services
ip nat outside source
local-ip Local IP address of an outside host as it appears to the inside network. The address
was allocated from the address space routable on the inside (RFC 1918, Address
Allocation for Private Internets).
extendable (Optional) Extends the transmission.
no-alias (Optional) Prohibits an alias from being created for the local address.
tcp Establishes the TCP.
udp Establishes the UDP.
global-port Port number assigned to a host on the outside network by its owner.
local-port Port number of an outside host as it appears to the inside network.
static network Sets up a single static network translation.
global-network Globally unique network address assigned to a host on the outside network by its
owner. The address is allocated from a globally routable network space.
local-network Local network address of an outside host as it appears to the inside network. The
address is allocated from an address space that is routable on the inside network.
mask Subnet mask for the networks that are translated.
Command Default No translation of source addresses coming from the outside to the inside network occurs.
Command Modes Global configuration (config)
Command History
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Cisco IOS XE Amsterdam 17.1.1 The vrf keyword was introduced.
Usage Guidelines The optional keywords of the ip nat outside source command except for the vrf name keyword can be entered
in any order.
You can use NAT to translate inside addresses that overlap with outside addresses. Use this command if your
IP addresses in the stub network happen to be legitimate IP addresses belonging to another network, and you
need to communicate with those hosts or devices.
This command has two general forms: dynamic and static address translation. The form with an access list
establishes dynamic translation. Packets from addresses that match the standard access list are translated using
global addresses allocated from the pool that is named by using the ip nat pool command.
Alternatively, the syntax form with the static keyword establishes a single static translation.
When you configure the ip nat outside source static command to add static routes for static outside local
addresses, there is a delay in the translation of packets and packets are dropped. To avoid dropped packets,
configure either the ip nat outside source static add-route command or the ip route command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
482
IP Addressing Services
ip nat outside source
Examples The following example shows how to translate between inside hosts addressed from the 10.114.11.0
network to the globally unique 10.69.233.208/28 network. Further, packets from outside hosts
addressed from the 10.114.11.0 network (the true 10.114.11.0 network) are translated to appear to
be from the 10.0.1.0/24 network.
ip nat pool net-208 10.69.233.208 10.69.233.223 prefix-length 28
ip nat pool net-10 10.0.1.0 10.0.1.255 prefix-length 24
ip nat inside source list 1 pool net-208
ip nat outside source list 1 pool net-10
!
interface ethernet 0
ip address 10.69.232.182 255.255.255.240
ip nat outside
!
interface ethernet 1
ip address 10.114.11.39 255.255.255.0
ip nat inside
!
access-list 1 permit 10.114.11.0 0.0.0.255
Related Commands Command Description
access-list (IP extended) Defines an extended IP access list.
access-list (IP standard) Defines a standard IP access list.
clear ip nat translation Clears dynamic NAT from the translation table.
interface Configures an interface type and enters interface configuration mode.
ip address Sets a primary or secondary IP address for an interface.
ip nat Designates the traffic originating from or destined for the interface as subject
to NAT.
ip nat inside destination Enables NAT of the inside destination address.
ip nat inside source Enables NAT of the inside source address.
ip nat pool Defines a pool of IP addresses for NAT.
ip nat service Enables a port other than the default port.
ip route Establishes static routes.
show ip nat statistics Displays NAT statistics.
show ip nat translations Displays active NATs.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
483
IP Addressing Services
ip nat pool
ip nat pool
To define a pool of IP addresses for Network Address Translation (NAT) translations, use the ip nat pool
command in global configuration mode. To remove one or more addresses from the pool, use the no form of
this command.
ip nat pool name start-ip end-ip { netmask netmask | prefix-length prefix-length }
[add-route] [ type ]
no ip nat pool name start-ip end-ip { netmask netmask | prefix-length prefix-length }
[add-route] [ type ]
Syntax Description name Name of the pool.
start-ip Starting IP address that defines the range of addresses in the
address pool.
end-ip Ending IP address that defines the range of addresses in the
address pool.
netmask netmask Specifies the network mask that indicates the address bits that
belong to the network and subnetwork fields and the ones that
belong to the host field.
• Specify the network mask of the network to which the
pool addresses belong.
prefix-length prefix-length Specifies the number that indicates how many bits of the
address is dedicated for the network.
add-route (Optional) Specifies that a route is added to the NAT Virtual
Interface (NVI) for the global address.
type (Optional) Indicates the type of pool.
Command Default No pool of addresses is defined.
Command Modes Global configuration (config)
Command History
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was
introduced.
Usage Guidelines This command defines a pool of addresses by specifying the start address, the end address, and either network
mask or prefix length.
When you enable the no-alias keyword, IP aliases are not created for IP addresses mentioned in the NAT
pool.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
484
IP Addressing Services
ip nat pool
Using the nopreservation keyword with the prefix-length or the netmask keyword disables the default
behavior, which is known as IP address reservation. The no form of the command with the nopreservation
keyword enables the default behavior and reserves the first IP address in the NAT pool, making the IP address
unavailable for dynamic translation.
Examples The following example shows how to translate between inside hosts addressed from either the
192.0.2.1 or 192.0.2.2 network to the globally unique 10.69.233.208/28 network:
ip nat pool net-208 10.69.233.208 10.69.233.223 prefix-length 28
ip nat inside source list 1 pool net-208
!
interface ethernet 0
ip address 10.0.0.1 255.255.255.240
ip nat outside
!
interface ethernet 1
ip address 192.0.2.4 255.255.255.0
ip nat inside
!
access-list 1 permit 192.0.2.1 0.0.0.255
access-list 1 permit 192.0.2.2 0.0.0.255
The following example shows how to add a route to the NVI interface for the global address:
ip nat pool NAT 192.0.2.0 192.0.2.3 netmask 255.255.255.0 add-route
ip nat source list 1 pool NAT vrf group1 overload
Related Commands Command Description
access-list Defines a standard IP access list.
clear ip nat translation Clears dynamic NAT translations from the translation table.
debug ip nat Displays information about IP packets translated by NAT.
interface Configures an interface and enters interface configuration mode.
ip address Sets a primary or secondary IP address for an interface.
ip nat Designates that traffic originating from or destined for an interface is subject to
NAT.
ip nat inside source Enables NAT of the inside source address.
ip nat outside source Enables NAT of the outside source address.
ip nat service Enables a port other than the default port.
ip nat source Enables NAT on a virtual interface without inside or outside specification.
show ip nat statistics Displays NAT statistics.
show ip nat translations Displays active NAT translations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
485
IP Addressing Services
ip nat translation max-entries
ip nat translation max-entries
To configure a limit on dynamically created NAT entries, use the ip nat translation max-entries command
in global configuration mode. To remove the specified limit, use the no form of this command.
ip nat translation max-entries { all-host | all-vrf | host ip address | list { list-name | list-number } | vrf
name } max-entries
no ip nat translation max-entries { all-host | all-vrf | host ip address | list { list-name | list-number } |
vrf name } max-entries
Syntax Description all-host (Optional) Subjects each host to the specified NAT limit.
all-vrf (Optional) Subjects each VPN routing and forwarding (VRF) instance to the specific NAT
limit.
host ip-address (Optional) Specifies an IP address subject to the NAT limit.
list list-name (Optional) Specifies an access control list (ACL) subject to the NAT limit.
list list-number (Optional) Specifies an access control list (ACL) subject to the NAT limit. The range is
from 1 to 99.
vrf name (Optional) Specifies a virtual routing and forwarding instance (VRF) subject to the NAT
limit.
max-entries Specifies the maximum number of allowed NAT entries. The range is from 1 to
2147483647.
Command Default There is no configured limit on the number of translations.
Command Modes Global configuration (config)
Command History
Command History Release Modification
Cisco IOS XE Fuji This command was
16.8.1 introduced.
Usage Guidelines You can set NAT rate limit to constrain the dynamic entries created by a specific host, group of hosts via an
ACL, per vrf or globally in which case the given limit would apply to all entries regardless of the source.
When using the no form of the ip nat translation max-entries command, you must specify the type of NAT
rate limit that you want to remove and its value. The show ip nat statistics command can be used to display
various limit related statistics.
The following example shows how to limit the maximum number of allowed NAT entries to 300:
Device(config)# ip nat translation max-entries 300
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
486
IP Addressing Services
ip nat translation (timeout)
ip nat translation (timeout)
To change the Network Address Translation (NAT) timeout, use the ip nat translation command in global
configuration mode. To disable the timeout, use the no form of this command.
ip nat translation { finrst-timeout | icmp-timeout | port-timeout { tcp | udp } port-number |
syn-timeout | tcp-timeout | timeout | udp-timeout } {seconds | never}
no ip nat translation { finrst-timeout | icmp-timeout | port-timeout { tcp | udp } port-number
| syn-timeout | tcp-timeout | timeout | udp-timeout }
Syntax Description finrst-timeout Specifies that the timeout value applies to Finish and Reset TCP
packets, which terminate a connection. The default is 60 seconds.
icmp-timeout Specifies the timeout value for Internet Control Message Protocol
(ICMP) flows. The default is 60 seconds.
port-timeout Specifies that the timeout value applies to the TCP/UDP port.
tcp Specifies TCP.
udp Specifies UDP.
port-number Port number for TCP or UDP. The range is from 1 to 65535.
syn-timeout Specifies that the timeout value applies to TCP flows immediately
after a synchronous transmission (SYN) message that consists of
digital signals that are sent with precise clocking. The default is 60
seconds.
tcp-timeout Specifies that the timeout value applies to the TCP port. Default is
86,400 seconds (24 hours).
timeout Specifies that the timeout value applies to dynamic translations,
except for overload translations. The default is 86,400 seconds (24
hours).
udp-timeout Specifies that the timeout value applies to the UDP port. The default
is 300 seconds (5 minutes).
seconds Number of seconds after which the specified port translation times
out.
never Specifies that port translation will not time out.
Command Default NAT translation timeouts are enabled by default.
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
487
IP Addressing Services
ip nat translation (timeout)
Command History
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was
introduced.
Usage Guidelines When port translation is configured, each entry contains more information about the traffic that is using the
translation, which gives you finer control over translation entry timeouts. Non-DNS UDP translations time
out after 5 minutes, and DNS times out in 1 minute. TCP translations time out in 24 hours, unless a TCP Reset
(RST) or a Finish (FIN) bit is seen on the stream, in which case they will time out in 1 minute.
Examples The following example shows how to configure the router to cause UDP port translation entries to
time out after 10 minutes (600 seconds):
Router# configure terminal
Router(config)# ip nat translation udp-timeout 600
Related Commands Command Description
clear ip nat translation Clears dynamic NAT translations from the translation table.
ip nat Designates that traffic originating from or destined for the interface is
subject to NAT; enables NAT logging; or enables static IP address support.
ip nat inside destination Enables NAT of a globally unique host address to multiple inside host
addresses.
ip nat inside source Enables NAT of the inside source address.
ip nat outside source Enables NAT of the outside source address.
ip nat pool Defines a pool of IP addresses for NAT.
ip nat service Specifies a port other than the default port for NAT.
ip nat translation max-entries Limits the size of a NAT table to a specified maximum.
show ip nat statistics Displays NAT statistics.
show ip nat translations Displays active NAT translations.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
488
IP Addressing Services
ip nhrp map
ip nhrp map
To statically configure the IP-to-nonbroadcast multiaccess (NBMA) address mapping of IP destinations
connected to an NBMA network, use the ip nhrp map interface configuration command. To remove the static
entry from Next Hop Resolution Protocol (NHRP) cache, use the no form of this command.
ip nhrp map {ip-address [nbma-ip-address][dest-mask][nbma-ipv6-address] | multicast
{nbma-ip-address nbma-ipv6-address | dynamic}}
no ip nhrp map {ip-address [nbma-ip-address][dest-mask][nbma-ipv6-address] | multicast
{nbma-ip-address nbma-ipv6-address | dynamic}}
Syntax Description ip-address IP address of the destinations reachable through the Nonbroadcast multiaccess (NBMA)
network. This address is mapped to the NBMA address.
nbma-ip-address NBMA IP address.
dest-mask Destination network address for which a mask is required.
nbma-ipv6-address NBMA IPv6 address.
dynamic Dynamically learns destinations from client registrations on hub.
multicast NBMA address that is directly reachable through the NBMA network. The address format
varies depending on the medium you are using. For example, ATM has a Network Service
Access Point (NSAP) address, Ethernet has a MAC address, and Switched Multimegabit
Data Service (SMDS) has an E.164 address. This address is mapped to the IP address.
Command Default No static IP-to-NBMA cache entries exist.
Command Modes Interface configuration (config-if)
Command History Release Modification
This command was introduced.
Usage Guidelines You will probably need to configure at least one static mapping in order to reach the next-hop server. Repeat
this command to statically configure multiple IP-to-NBMA address mappings.
Examples In the following example, this station in a multipoint tunnel network is statically configured to be
served by two next-hop servers 10.0.0.1 and 10.0.1.3. The NBMA address for 10.0.0.1 is statically
configured to be 192.0.0.1 and the NBMA address for 10.0.1.3 is 192.2.7.8.
Device(config)# interface tunnel 0
Device(config-if)# ip nhrp nhs 10.0.0.1
Device(config-if)# ip nhrp nhs 10.0.1.3
Device(config-if)# ip nhrp map 10.0.0.1 192.0.0.1
Device(config-if)# ip nhrp map 10.0.1.3 192.2.7.8
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
489
IP Addressing Services
ip nhrp map
Examples In the following example, if a packet is sent to 10.255.255.255, it is replicated to destinations 10.0.0.1
and 10.0.0.2. Addresses 10.0.0.1 and 10.0.0.2 are the IP addresses of two other routers that are part
of the tunnel network, but those addresses are their addresses in the underlying network, not the
tunnel network. They would have tunnel addresses that are in network 10.0.0.0.
Device(config)# interface tunnel 0
Device(config-if)# ip address 10.0.0.3 255.0.0.0
Device(config-if)# ip nhrp map multicast 10.0.0.1
Device(config-if)# ip nhrp map multicast 10.0.0.2
Related Commands Command Description
clear ip nhrp Clears all dynamic entries from the NHRP cache.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
490
IP Addressing Services
ip nhrp map multicast
ip nhrp map multicast
To configure nonbroadcast multiaccess (NBMA) addresses used as destinations for broadcast or multicast
packets to be sent over a tunnel network, use the ip nhrp map multicastcommand in interface configuration
mode. To remove the destinations, use the no form of this command.
ip nhrp map multicast {ip-nbma-address ipv6-nbma-address | dynamic}
no ip nhrp map multicast {ip-nbma-address ipv6-nbma-address | dynamic}
Syntax Description ip-nbma-address NBMA address that is directly reachable through the NBMA network. The address
format varies depending on the medium that you are using.
ipv6-nbma-address IPv6 NBMA address.
dynamic Dynamically learns destinations from client registrations on the hub.
Command Default No NBMA addresses are configured as destinations for broadcast or multicast packets.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Denali 16.5.1 This command was introduced.
Usage Guidelines This command applies only to tunnel interfaces. This command is useful for supporting broadcasts over a
tunnel network when the underlying network does not support IP multicast. If the underlying network does
support IP multicast, you should use the tunnel destination command to configure a multicast destination
for transmission of tunnel broadcasts or multicasts.
When multiple NBMA addresses are configured, the system replicates the broadcast packet for each address.
Examples In the following example, if a packet is sent to 10.255.255.255, it is replicated to destinations 10.0.0.1
and 10.0.0.2:
Switch(config)# interface tunnel 0
Switch(config-if)# ip address 10.0.0.3 255.0.0.0
Switch(config-if)# ip nhrp map multicast 10.0.0.1
Switch(config-if)# ip nhrp map multicast 10.0.0.2
Related Commands Command Description
debug nhrp Enables NHRP debugging.
interface Configures an interface and enters interface configuration mode.
tunnel destination Specifies the destination for a tunnel interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
491
IP Addressing Services
ip nhrp network-id
ip nhrp network-id
To enable the Next Hop Resolution Protocol ( NHRP) on an interface, use the ip nhrp network-id command
in interface configuration mode. To disable NHRP on the interface, use the no form of this command.
ip nhrp network-id number
no ip nhrp network-id [number]
Syntax Description number Globally unique, 32-bit network identifier from a nonbroadcast multiaccess (NBMA) network.
The range is from 1 to 4294967295.
Command Default NHRP is disabled on the interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
This command was introduced.
Usage Guidelines In general, all NHRP stations within one logical NBMA network must be configured with the same network
identifier.
Examples The following example enables NHRP on the interface:
Device(config-if)# ip nhrp network-id 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
492
IP Addressing Services
ip nhrp nhs
ip nhrp nhs
To specify the address of one or more Next Hop Resolution Protocol (NHRP) servers, use the ip nhrp
nhscommand in interface configuration mode. To remove the address, use the no form of this command.
ip nhrp nhs {nhs-address [nbma {nbma-addressFQDN-string}] [multicast] [priority value] [cluster
value] | cluster value max-connections value | dynamic nbma {nbma-addressFQDN-string} [multicast]
[priority value] [cluster value]}
no ip nhrp nhs {nhs-address [nbma {nbma-addressFQDN-string}] [multicast] [priority value]
[cluster value] | cluster value max-connections value | dynamic nbma {nbma-addressFQDN-string}
[multicast] [priority value] [cluster value]}
Syntax Description nhs-address Address of the next-hop server being specified.
net-address (Optional) IP address of a network served by the next-hop server.
netmask (Optional) IP network mask to be associated with the IP address. The IP address
is logically ANDed with the mask.
nbma (Optional) Specifies the nonbroadcast multiple access (NBMA) address or FQDN.
nbma-address NBMA address.
FQDN-string Next hop server (NHS) fully qualified domain name (FQDN) string.
multicast (Optional) Specifies to use NBMA mapping for broadcasts and multicasts.
priority value (Optional) Assigns a priority to hubs to control the order in which spokes select
hubs to establish tunnels. The range is from 0 to 255; 0 is the highest and 255
is the lowest priority.
cluster value (Optional) Specifies NHS groups. The range is from 0 to 10; 0 is the highest and
10 is the lowest. The default value is 0.
max-connections value Specifies the number of NHS elements from each NHS group that needs to be
active. The range is from 0 to 255.
dynamic Configures the spoke to learn the NHS protocol address dynamically.
Command Default No next-hop servers are explicitly configured, so normal network layer routing decisions are used to forward
NHRP traffic.
Command Modes Interface configuration (config-if)
Command History Release Modification
This command was introduced.
Usage Guidelines Use the ip nhrp nhs command to specify the address of a next hop server and the networks it serves. Normally,
NHRP consults the network layer forwarding table to determine how to forward NHRP packets. When next
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
493
IP Addressing Services
ip nhrp nhs
hop servers are configured, these next hop addresses override the forwarding path that would otherwise be
used for NHRP traffic.
When the ip nhrp nhs dynamic command is configured on a DMVPN tunnel and the shut command is issued
to the tunnel interface, the crypto socket does not receive shut message, thereby not bringing up a DMVPN
session with the hub.
For any next hop server that is configured, you can specify multiple networks by repeating this command
with the same nhs-addressargument, but with different IP network addresses.
Examples The following example shows how to register a hub to a spoke using NBMA and FQDN:
Device# configure terminal
Device(config)# interface tunnel 1
Device(config-if)# ip nhrp nhs 192.0.2.1 nbma examplehub.example1.com
The following example shows how to configure the desired max-connections value:
Device# configure terminal
Device(config)# interface tunnel 1
Device(config-if)# ip nhrp nhs cluster 5 max-connections 100
The following example shows how to configure NHS priority and group values:
Device# configure terminal
Device(config)# interface tunnel 1
Device(config-if)# ip nhrp nhs 192.0.2.1 priority 1 cluster 2
Related Commands Command Description
ip nhrp map Statically configures the IP-to-NBMA address mapping of IP destinations connected to an
NBMA network.
show ip nhrp Displays NHRP mapping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
494
IP Addressing Services
ip wccp
ip wccp
To enable support of the specified Web Cache Communication Protocol (WCCP) service for participation in
a service group, use the ip wccp command in global configuration mode. To disable the service group, use
the no form of this command.
ip wccp [{ vrf vrf-name }] { web-cache service-number } [ service-list service-access-list ]
[ mode { open | closed } ] [ group-address multicast-address ] [ redirect-list access-list ] [
group-list access-list ] [ password [{ 0 | 7 }] password ]
no ip wccp [{ vrf vrf-name }] { web-cache service-number } [ service-list service-access-list
] [ mode { open | closed } ] [ group-address multicast-address ] [ redirect-list access-list ]
[ group-list access-list ] [ password [{ 0 | 7 }] password ]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding instance (VRF) to associate
with a service group.
web-cache Specifies the web-cache service (WCCP Version 1 and Version 2).
Note Web-cache counts as one of the services. The maximum number
of services, including those assigned with the service-number
argument, is 256.
service-number Dynamic service identifier, which means the service definition is dictated by
the cache. The dynamic service number can be from 0 to 254. The maximum
number of services is 256, which includes the web-cache service specified with
the web-cache keyword.
Note If Cisco cache engines are used in the cache cluster, the reverse
proxy service is indicated by a value of 99.
service-list (Optional) Identifies a named extended IP access list that defines the packets
service-access-list that will match the service.
mode open (Optional) Identifies the service as open. This is the default service mode.
mode closed (Optional) Identifies the service as closed.
group-address (Optional) Specifies the multicast IP address that communicates with the WCCP
multicast-address service group. The multicast address is used by the device to determine which
web cache should receive redirected messages.
redirect-list access-list (Optional) Specifies the access list that controls traffic redirected to this service
group. The access-list argument should consist of a string of no more than 64
characters (name or number) in length that specifies the access list.
group-list access-list (Optional) Specifies the access list that determines which web caches are allowed
to participate in the service group. The access-list argument specifies either the
number or the name of a standard or extended access list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
495
IP Addressing Services
ip wccp
password [0 | 7] password (Optional) Specifies the message digest algorithm 5 (MD5) authentication for
messages received from the service group. Messages that are not accepted by
the authentication are discarded. The encryption type can be 0 or 7, with 0
specifying not yet encrypted and 7 for proprietary. The password argument can
be up to eight characters in length.
Command Default WCCP services are not enabled on the device.
Command Modes Global configuration (config)
Command History Release Modification
This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 The vrf keyword and vrf-name argument pair were added.
Usage Guidelines WCCP transparent caching bypasses Network Address Translation (NAT) when Cisco Express Forwarding
switching is enabled. To work around this situation, configure WCCP transparent caching in the outgoing
direction, enable Cisco Express Forwarding switching on the content engine interface, and specify the ip wccp
web-cache redirect out command. Configure WCCP in the incoming direction on the inside interface by
specifying the ip wccp redirect exclude in command on the device interface facing the cache. This
configuration prevents the redirection of any packets arriving on that interface.
You can also include a redirect list when configuring a service group. The specified redirect list will deny
packets with a NAT (source) IP address and prevent redirection.
This command instructs a device to enable or disable support for the specified service number or the web-cache
service name. A service number can be from 0 to 254. Once the service number or name is enabled, the device
can participate in the establishment of a service group.
Note All WCCP parameters must be included in a single IP WCCP command. For example: ip wccp 61 redirect-list
10 password password.
The vrf vrf-name keyword and argument pair is optional. It allows you to specify a VRF to associate with a
service group. You can then specify a web-cache service name or service number.
The same service (web-cache or service number) can be configured in different VRF tables. Each service will
operate independently.
When the no ip wccp command is entered, the device terminates participation in the service group, deallocates
space if none of the interfaces still has the service configured, and terminates the WCCP task if no other
services are configured.
The keywords following the web-cache keyword and the service-number argument are optional and may be
specified in any order, but only may be specified once. The following sections outline the specific usage of
each of the optional forms of this command.
ip wccp [vrf vrf-name] {web-cache | service-number} group-address multicast-address
A WCCP group address can be configured to set up a multicast address that cooperating devices and web
caches can use to exchange WCCP protocol messages. If such an address is used, IP multicast routing must
be enabled so that the messages that use the configured group (multicast) addresses are received correctly.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
496
IP Addressing Services
ip wccp
This option instructs the device 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. The response is also sent to the group
address. The default is for no group address to be configured, in which case all "Here I Am" messages are
responded to with a unicast reply.
ip wccp [vrf vrf-name] {web-cache | service-number} redirect-list access-list
This option instructs the device to use an access list to control the traffic that is redirected to the web caches
of the service group specified by the service name given. The access-list argument specifies either the number
or the name of a standard or extended access list. The access list itself specifies which traffic is permitted to
be redirected. The default is for no redirect list to be configured (all traffic is redirected).
WCCP requires that the following protocol and ports not be filtered by any access lists:
• UDP (protocol type 17) port 2048. This port is used for control signaling. Blocking this type of traffic
prevents WCCP from establishing a connection between the device and web caches.
• Generic routing encapsulation (GRE) (protocol type 47 encapsulated frames). Blocking this type of traffic
prevents the web caches from ever seeing the packets that are intercepted.
ip wccp [vrf vrf-name] {web-cache | service-number} group-list access-list
This option instructs the device to use an access list to control the web caches that are allowed to participate
in the specified service group. The access-list argument specifies either the number of a standard or extended
access list or the name of any type of named access list. The access list itself specifies which web caches are
permitted to participate in the service group. The default is for no group list to be configured, in which case
all web caches may participate in the service group.
Note The ip wccp {web-cache | service-number} group-list command syntax resembles the ip wccp {web-cache
| service-number} group-listen command, but these are entirely different commands. The ip wccp group-listen
command is an interface configuration command used to configure an interface to listen for multicast
notifications from a cache cluster.
ip wccp [vrf vrf-name] web-cache | service-number} password password
This option instructs the device to use MD5 authentication on the messages received from the service group
specified by the service name given. Use this form of the command to set the password on the device. You
must also configure the same password separately on each web cache. The password can be up to a maximum
of eight characters in length. Messages that do not authenticate when authentication is enabled on the device
are discarded. The default is for no authentication password to be configured and for authentication to be
disabled.
ip wccp service-number service-list service-access-list mode closed
In applications where the interception and redirection of WCCP packets to external intermediate devices for
the purpose of applying feature processing are not available within Cisco IOS software, packets for the
application must be blocked when the intermediary device is not available. This blocking is called a closed
service. By default, WCCP operates as an open service, wherein communication between clients and servers
proceeds normally in the absence of an intermediary device. The service-list keyword can be used only for
closed mode services. When a WCCP service is configured as closed, WCCP discards packets that do not
have a client application registered to receive the traffic. Use the service-list keyword and service-access-list
argument to register an application protocol type or port number.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
497
IP Addressing Services
ip wccp
When the definition of a service in a service list conflicts with the definition received via the WCCP protocol,
a warning message similar to the following is displayed:
Sep 28 14:06:35.923: %WCCP-5-SERVICEMISMATCH: Service 90 mismatched on WCCP client 10.1.1.13
When there is service list definitions conflict, the configured definition takes precedence over the external
definition received via WCCP protocol messages.
Examples The following example shows how to configure a device to run WCCP reverse-proxy service, using
the multicast address of 239.0.0.0:
Device> enable
Device# configure terminal
Device(config)# ip multicast-routing
Device(config)# ip wccp 99 group-address 239.0.0.0
Device(config)# interface ethernet 0
Device(config-if)# ip wccp 99 group-listen
The following example shows how to configure a device to redirect web-related packets without a
destination of 10.168.196.51 to the web cache:
Device> enable
Device# configure terminal
Device(config)# access-list 100 deny ip any host 10.168.196.51
Device(config)# access-list 100 permit ip any any
Device(config)# ip wccp web-cache redirect-list 100
Device(config)# interface ethernet 0
Device(config-if)# ip wccp web-cache redirect out
The following example shows how to configure an access list to prevent traffic from network 10.0.0.0
leaving Fast Ethernet interface 0/0. Because the outbound access control list (ACL) check is enabled,
WCCP does not redirect that traffic. WCCP checks packets against the ACL before they are redirected.
Device> enable
Device# configure terminal
Device(config)# ip wccp web-cache
Device(config)# ip wccp check acl outbound
Device(config)# interface fastethernet0/0
Device(config-if)# ip access-group 10 out
Device(config-if)# ip wccp web-cache redirect out
Device(config-if)# access-list 10 deny 10.0.0.0 0.255.255.255
Device(config-if)# access-list 10 permit any
If the outbound ACL check is disabled, HTTP packets from network 10.0.0.0 would be redirected
to a cache, and users with that network address could retrieve web pages when the network
administrator wanted to prevent this from happening.
The following example shows how to configure a closed WCCP service:
Device> enable
Device# configure terminal
Device(config)# ip wccp 99 service-list access1 mode closed
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
498
IP Addressing Services
ip wccp
Note • If multiple parameters are required, all parameters under ip wccp [vrf vrf-name] web-cache |
service-number} must be configured as a single command.
• If the command is reissued with different parameters, the existing parameter will be removed
and the new parameter will be configured.
The following example shows how to configure multiple parameters as a single command:
Device> enable
Device# configure terminal
Device(config)# ip wccp 61 group-address 10.0.0.1 password 0 password mode closed
redirect-list 121
Related Commands Command Description
ip wccp check services all Enables all WCCP services.
ip wccp group listen Configures an interface on a device to enable or disable the reception of IP
multicast packets for WCCP.
ip wccp redirect exclude in Enables redirection exclusion on an interface.
ip wccp redirect out Configures redirection on an interface in the outgoing direction.
ip wccp version Specifies which version of WCCP you want to use on your device.
show ip wccp Displays global statistics related to WCCP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
499
IP Addressing Services
ipv6 access-list
ipv6 access-list
To define an IPv6 access list and to place the device in IPv6 access list configuration mode, use the ipv6
access-list command in global configuration mode. To remove the access list, use the no form of this command.
ipv6 access-list access-list-name
no ipv6 access-list access-list-name
Syntax Description access-list-name Name of the IPv6 access list. Names cannot contain a space or quotation mark, or begin
with a numeric.
Command Default No IPv6 access list is defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 access-list command is similar to the ip access-listcommand, except that it is IPv6-specific.
The standard IPv6 ACL functionality supports --in addition to traffic filtering based on source and destination
addresses--filtering of traffic based on IPv6 option headers and optional, upper-layer protocol type information
for finer granularity of control (functionality similar to extended ACLs in IPv4). IPv6 ACLs are defined by
using the ipv6 access-list command in global configuration mode and their permit and deny conditions are
set by using the deny and permit commands in IPv6 access list configuration mode. Configuring the ipv6
access-list command places the device in IPv6 access list configuration mode--the device prompt changes to
Device(config-ipv6-acl)#. From IPv6 access list configuration mode, permit and deny conditions can be set
for the defined IPv6 ACL.
Note IPv6 ACLs are defined by a unique name (IPv6 does not support numbered ACLs). An IPv4 ACL and an
IPv6 ACL cannot share the same name.
For backward compatibility, the ipv6 access-list command with the deny and permit keywords in global
configuration mode is still supported; however, an IPv6 ACL defined with deny and permit conditions in
global configuration mode is translated to IPv6 access list configuration mode.
Refer to the deny (IPv6) and permit (IPv6) commands for more information on filtering IPv6 traffic based on
IPv6 option headers and optional, upper-layer protocol type information. See the "Examples" section for an
example of a translated IPv6 ACL configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
500
IP Addressing Services
ipv6 access-list
Note Every IPv6 ACL has implicit permit icmp any any nd-na, permit icmp any any nd-ns, and deny ipv6 any
any statements as its last match conditions. (The former two match conditions allow for ICMPv6 neighbor
discovery.) An IPv6 ACL must contain at least one entry for the implicit deny ipv6 any any statement to take
effect. The IPv6 neighbor discovery process makes use of the IPv6 network layer service; therefore, by default,
IPv6 ACLs implicitly allow IPv6 neighbor discovery packets to be sent and received on an interface. In IPv4,
the Address Resolution Protocol (ARP), which is equivalent to the IPv6 neighbor discovery process, makes
use of a separate data link layer protocol; therefore, by default, IPv4 ACLs implicitly allow ARP packets to
be sent and received on an interface.
Note IPv6 prefix lists, not access lists, should be used for filtering routing protocol prefixes.
Use the ipv6 traffic-filter interface configuration command with the access-list-name argument to apply an
IPv6 ACL to an IPv6 interface. Use the ipv6 access-class line configuration command with the access-list-name
argument to apply an IPv6 ACL to incoming and outgoing IPv6 virtual terminal connections to and from the
device.
Note An IPv6 ACL applied to an interface with the ipv6 traffic-filter command filters traffic that is forwarded,
not originated, by the device.
Note When using this command to modify an ACL that is already associated with a bootstrap router (BSR) candidate
rendezvous point (RP) (see the ipv6 pim bsr candidate rp command) or a static RP (see the ipv6 pim
rp-address command), any added address ranges that overlap the PIM SSM group address range (FF3x::/96)
are ignored. A warning message is generated and the overlapping address ranges are added to the ACL, but
they have no effect on the operation of the configured BSR candidate RP or static RP commands.
Duplicate remark statements can no longer be configured from the IPv6 access control list. Because each
remark statement is a separate entity, each one is required to be unique.
Examples The following example is from a device running Cisco IOS Release 12.0(23)S or later releases. The
example configures the IPv6 ACL list named list1 and places the device in IPv6 access list
configuration mode.
Device(config)# ipv6 access-list list1
Device(config-ipv6-acl)#
The following example is from a device running Cisco IOS Release 12.2(2)T or later releases,
12.0(21)ST, or 12.0(22)S. The example configures the IPv6 ACL named list2 and applies the ACL
to outbound traffic on Ethernet interface 0. Specifically, the first ACL entry keeps all packets from
the network FEC0:0:0:2::/64 (packets that have the site-local prefix FEC0:0:0:2 as the first 64 bits
of their source IPv6 address) from exiting out of Ethernet interface 0. The second entry in the ACL
permits all other traffic to exit out of Ethernet interface 0. The second entry is necessary because an
implicit deny all condition is at the end of each IPv6 ACL.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
501
IP Addressing Services
ipv6 access-list
Device(config)# ipv6 access-list list2 deny FEC0:0:0:2::/64 any
Device(config)# ipv6 access-list list2 permit any any
Device(config)# interface ethernet 0
Device(config-if)# ipv6 traffic-filter list2 out
If the same configuration was entered on a device running Cisco IOS Release 12.0(23)S or later
releases, the configuration would be translated into IPv6 access list configuration mode as follows:
ipv6 access-list list2
deny FEC0:0:0:2::/64 any
permit ipv6 any any
interface ethernet 0
ipv6 traffic-filter list2 out
Note IPv6 is automatically configured as the protocol type in permit any any and deny any any statements
that are translated from global configuration mode to IPv6 access list configuration mode.
Note IPv6 ACLs defined on a device running Cisco IOS Release 12.2(2)T or later releases, 12.0(21)ST,
or 12.0(22)S that rely on the implicit deny condition or specify a deny any any statement to filter
traffic should contain permit statements for link-local and multicast addresses to avoid the filtering
of protocol packets (for example, packets associated with the neighbor discovery protocol).
Additionally, IPv6 ACLs that use deny statements to filter traffic should use a permit any any
statement as the last statement in the list.
Note An IPv6 device will not forward to another network an IPv6 packet that has a link-local address as
either its source or destination address (and the source interface for the packet is different from the
destination interface for the packet).
Related Commands Command Description
deny (IPv6) Sets deny conditions for an IPv6 access list.
ipv6 access-class Filters incoming and outgoing connections to and from the device based on
an IPv6 access list.
ipv6 pim bsr candidate rp Configures the candidate RP to send PIM RP advertisements to the BSR.
ipv6 pim rp-address Configure the address of a PIM RP for a particular group range.
ipv6 traffic-filter Filters incoming or outgoing IPv6 traffic on an interface.
permit (IPv6) Sets permit conditions for an IPv6 access list.
show ipv6 access-list Displays the contents of all current IPv6 access lists.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
502
IP Addressing Services
ipv6 address-validate
ipv6 address-validate
To enable IPv6 address validation, use the ipv6 address-validate in global configuration mode. To disable
IPv6 address validation, use the no form of this command.
ipv6 address-validate
no ipv6 address-validate
Command Default This command is enabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.11.1 This command was introduced.
Usage Guidelines The ipv6 address-validate command is used to validate whether the interface identifiers in an assigned IPv6
address are a part of the reserved IPv6 interface identifiers range, as specified in RFC5453. If the interface
identifiers of the assigned IPv6 address are a part of the reserved range, a new IPv6 address is assigned.
Only auto-configured addresses or addresses configured by DHCPv6 are validated.
Note The no ipv6-address validate command disables the IPv6 address validation and allows assigning of IPv6
addresses with interface identifiers that are a part of the reserved IPv6 interface identifiers range. We do not
recommend the use of this command.
You must enter a minimum of eight characters of the ipv6-address validate command if you’re using CLI
help (?) for completing the syntax of this command. If you enter less than eight characters the command will
conflict with the no ipv6 address command in interface configuration mode.
Examples The following example shows how to re-enable IPv6 address validation if it is disabled using the no
ipv6-address validate command:
Device> enable
Device# configure terminal
Device(config)# ipv6 address-validate
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
503
IP Addressing Services
ipv6 cef
ipv6 cef
To enable Cisco Express Forwarding for IPv6, use the ipv6 cef command in global configuration mode. To
disable Cisco Express Forwarding for IPv6, use the no form of this command.
ipv6 cef
no ipv6 cef
Syntax Description This command has no arguments or keywords.
Command Default Cisco Express Forwarding for IPv6 is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 cef command is similar to the ip cef command, except that it is IPv6-specific.
The ipv6 cef command is not available on the Cisco 12000 series Internet routers because this distributed
platform operates only in distributed Cisco Express Forwarding for IPv6 mode.
Note The ipv6 cefcommand is not supported in interface configuration mode.
Note Some distributed architecture platforms support both Cisco Express Forwarding for IPv6 and distributed Cisco
Express Forwarding for IPv6. When Cisco Express Forwarding for IPv6 is configured on distributed platforms,
Cisco Express Forwarding switching is performed by the Route Processor (RP).
Note You must enable Cisco Express Forwarding for IPv4 by using the ip cef global configuration command before
enabling Cisco Express Forwarding for IPv6 by using the ipv6 cef global configuration command.
Cisco Express Forwarding for IPv6 is advanced Layer 3 IP switching technology that functions the same and
offer the same benefits as Cisco Express Forwarding for IPv4. Cisco Express Forwarding for IPv6 optimizes
network performance and scalability for networks with dynamic, topologically dispersed traffic patterns, such
as those associated with web-based applications and interactive sessions.
Examples The following example enables standard Cisco Express Forwarding for IPv4 operation and then
standard Cisco Express Forwarding for IPv6 operation globally on the .
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
504
IP Addressing Services
ipv6 cef
(config)# ip cef
(config)# ipv6 cef
Related Commands Command Description
ip route-cache Controls the use of high-speed switching caches for IP routing.
ipv6 cef accounting Enables Cisco Express Forwarding for IPv6 and distributed Cisco Express Forwarding
for IPv6 network accounting.
ipv6 cef distributed Enables distributed Cisco Express Forwarding for IPv6.
show cef Displays which packets the line cards dropped or displays which packets were not
express-forwarded.
show ipv6 cef Displays entries in the IPv6 FIB.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
505
IP Addressing Services
ipv6 cef accounting
ipv6 cef accounting
To enable Cisco Express Forwarding for IPv6 and distributed Cisco Express Forwarding for IPv6 network
accounting, use the ipv6 cef accounting command in global configuration mode or interface configuration
mode. To disable Cisco Express Forwarding for IPv6 network accounting, use the no form of this command.
ipv6 cef accounting accounting-types
no ipv6 cef accounting accounting-types
Specific Cisco Express Forwarding Accounting Information Through Interface Configuration Mode
ipv6 cef accounting non-recursive {external | internal}
no ipv6 cef accounting non-recursive {external | internal}
Syntax Description accounting-types The accounting-types argument must be replaced with at least one of the following
keywords. Optionally, you can follow this keyword by any or all of the other keywords,
but you can use each keyword only once.
• load-balance-hash --Enables load balancing hash bucket counters.
• non-recursive --Enables accounting through nonrecursive prefixes.
• per-prefix --Enables express forwarding of the collection of the number of packets
and bytes to a destination (or prefix).
• prefix-length --Enables accounting through prefix length.
non-recursive Enables accounting through nonrecursive prefixes.
This keyword is optional when used in global configuration mode after another keyword
is entered. See the accounting-types argument.
external Counts input traffic in the nonrecursive external bin.
internal Counts input traffic in the nonrecursive internal bin.
Command Default Cisco Express Forwarding for IPv6 network accounting is disabled by default.
Command Modes Global configuration (config)
Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 cef accounting command is similar to the ip cef accounting command, except that it is IPv6-specific.
Configuring Cisco Express Forwarding for IPv6 network accounting enables you to collect statistics on Cisco
Express Forwarding for IPv6 traffic patterns in your network.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
506
IP Addressing Services
ipv6 cef accounting
When you enable network accounting for Cisco Express Forwarding for IPv6 by using the ipv6 cef accounting
command in global configuration mode, accounting information is collected at the Route Processor (RP) when
Cisco Express Forwarding for IPv6 mode is enabled and at the line cards when distributed Cisco Express
Forwarding for IPv6 mode is enabled. You can then display the collected accounting information using the
show ipv6 cef EXEC command.
For prefixes with directly connected next hops, the non-recursive keyword enables express forwarding of
the collection of packets and bytes through a prefix. This keyword is optional when this command is used in
global configuration mode after you enter another keyword on the ipv6 cef accounting command.
This command in interface configuration mode must be used in conjunction with the global configuration
command. The interface configuration command allows a user to specify two different bins (internal or
external) for the accumulation of statistics. The internal bin is used by default. The statistics are displayed
through the show ipv6 cef detail command.
Per-destination load balancing uses a series of 16 hash buckets into which the set of available paths are
distributed. A hash function operating on certain properties of the packet is applied to select a bucket that
contains a path to use. The source and destination IP addresses are the properties used to select the bucket for
per-destination load balancing. Use the load-balance-hash keyword with the ipv6 cef accounting command
to enable per-hash-bucket counters. Enter the show ipv6 cef prefix internal command to display the
per-hash-bucket counters.
Examples The following example enables the collection of Cisco Express Forwarding for IPv6 accounting
information for prefixes with directly connected next hops:
(config)# ipv6 cef accounting non-recursive
Related Commands Command Description
ip cef accounting Enable Cisco Express Forwarding network accounting (for IPv4).
show cef Displays information about packets forwarded by Cisco Express Forwarding.
show ipv6 cef Displays entries in the IPv6 FIB.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
507
IP Addressing Services
ipv6 cef distributed
ipv6 cef distributed
To enable distributed Cisco Express Forwarding for IPv6, use the ipv6 cef distributed command in global
configuration mode. To disable Cisco Express Forwarding for IPv6, use the no form of this command.
ipv6 cef distributed
no ipv6 cef distributed
Syntax Description This command has no arguments or keywords.
Command Default Distributed Cisco Express Forwarding for IPv6 is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 cef distributed command is similar to the ip cef distributed command, except that it is IPv6-specific.
Enabling distributed Cisco Express Forwarding for IPv6 globally on the router by using the ipv6 cef distributed
in global configuration mode distributes the Cisco Express Forwarding processing of IPv6 packets from the
Route Processor (RP) to the line cards of distributed architecture platforms.
Note To forward distributed Cisco Express Forwarding for IPv6 traffic on the router, configure the forwarding of
IPv6 unicast datagrams globally on your router by using the ipv6 unicast-routing global configuration
command, and configure an IPv6 address and IPv6 processing on an interface by using the ipv6 address
interface configuration command.
Note You must enable distributed Cisco Express Forwarding for IPv4 by using the ip cef distributed global
configuration command before enabling distributed Cisco Express Forwarding for IPv6 by using the ipv6 cef
distributed global configuration command.
Cisco Express Forwarding is advanced Layer 3 IP switching technology. Cisco Express Forwarding optimizes
network performance and scalability for networks with dynamic, topologically dispersed traffic patterns, such
as those associated with web-based applications and interactive sessions.
Examples The following example enables distributed Cisco Express Forwarding for IPv6 operation:
(config)# ipv6 cef distributed
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
508
IP Addressing Services
ipv6 cef distributed
Related Commands Command Description
ip route-cache Controls the use of high-speed switching caches for IP routing.
show ipv6 cef Displays entries in the IPv6 FIB.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
509
IP Addressing Services
ipv6 cef load-sharing algorithm
ipv6 cef load-sharing algorithm
To select a Cisco Express Forwarding load-balancing algorithm for IPv6, use the ipv6 cef load-sharing
algorithm command in global configuration mode. To return to the default universal load-balancing algorithm,
use the no form of this command.
ipv6 cef load-sharing algorithm {original | universal [id]}
no ipv6 cef load-sharing algorithm
Syntax Description original Sets the load-balancing algorithm to the original algorithm based on a source and destination
hash.
universal Sets the load-balancing algorithm to the universal algorithm that uses a source and destination
and an ID hash.
id (Optional) Fixed identifier in hexadecimal format.
Command Default The universal load-balancing algorithm is selected by default. If you do not configure the fixed identifier for
a load-balancing algorithm, the device automatically generates a unique ID.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 cef load-sharing algorithm command is similar to the ip cef load-sharing algorithm command,
except that it is IPv6-specific.
When the Cisco Express Forwarding for IPv6 load-balancing algorithm is set to universal mode, each device
on the network can make a different load-sharing decision for each source-destination address pair.
Examples The following example shows how to enable the Cisco Express Forwarding original load-balancing
algorithm for IPv6:
Device> enable
Device# configure terminal
Device(config)# ipv6 cef load-sharing algorithm original
Related Commands Command Description
ip cef load-sharing algorithm Selects a Cisco Express Forwarding load-balancing algorithm (for IPv4).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
510
IP Addressing Services
ipv6 cef optimize neighbor resolution
ipv6 cef optimize neighbor resolution
To configure address resolution optimization from Cisco Express Forwarding for IPv6 for directly connected
neighbors, use the ipv6 cef optimize neighbor resolution command in global configuration mode. To disable
address resolution optimization from Cisco Express Forwarding for IPv6 for directly connected neighbors,
use the no form of this command.
ipv6 cef optimize neighbor resolution
no ipv6 cef optimize neighbor resolution
Syntax Description This command has no arguments or keywords.
Command Default If this command is not configured, Cisco Express Forwarding for IPv6 does not optimize the address resolution
of directly connected neighbors.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 cef optimize neighbor resolution command is very similar to the ip cef optimize neighbor
resolution command, except that it is IPv6-specific.
Use this command to trigger Layer 2 address resolution of neighbors directly from Cisco Express Forwarding
for IPv6.
Examples The following example shows how to optimize address resolution from Cisco Express Forwarding
for IPv6 for directly connected neighbors:
(config)# ipv6 cef optimize neighbor resolution
Related Commands Command Description
ip cef optimize neighbor resolution Configures address resolution optimization from Cisco Express
Forwarding for IPv4 for directly connected neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
511
IP Addressing Services
ipv6 destination-guard policy
ipv6 destination-guard policy
To define a destination guard policy, use the ipv6 destination-guard policy command in global configuration
mode. To remove the destination guard policy, use the no form of this command.
ipv6 destination-guard policy [policy-name]
no ipv6 destination-guard policy [policy-name]
Syntax Description policy-name (Optional) Name of the destination guard policy.
Command Default No destination guard policy is defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command enters destination-guard configuration mode. The destination guard policies can be used to
filter IPv6 traffic based on the destination address to block data traffic from an unknown source.
Examples The following example shows how to define the name of a destination guard policy:
(config)#ipv6 destination-guard policy policy1
Related Commands Command Description
show ipv6 destination-guard policy Displays destination guard information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
512
IP Addressing Services
ipv6 dhcp-relay bulk-lease
ipv6 dhcp-relay bulk-lease
To configure bulk lease query parameters, use the ipv6 dhcp-relay bulk-lease command in global configuration
mode. To remove the bulk-lease query configuration, use the no form of this command.
ipv6 dhcp-relay bulk-lease {data-timeout seconds | retry number} [disable]
no ipv6 dhcp-relay bulk-lease [disable]
Syntax Description data-timeout (Optional) Bulk lease query data transfer timeout.
seconds (Optional) The range is from 60 seconds to 600 seconds. The default is 300 seconds.
retry (Optional) Sets the bulk lease query retries.
number (Optional) The range is from 0 to 5. The default is 5.
disable (Optional) Disables the DHCPv6 bulk lease query feature.
Command Default Bulk lease query is enabled automatically when the DHCP for IPv6 (DHCPv6) relay agent feature is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 dhcp-relay bulk-lease command in global configuration mode to configure bulk lease query
parameters, such as data transfer timeout and bulk-lease TCP connection retries.
The DHCPv6 bulk lease query feature is enabled automatically when the DHCPv6 relay agent is enabled.
The DHCPv6 bulk lease query feature itself cannot be enabled using this command. To disable this feature,
use the ipv6 dhcp-relay bulk-lease command with the disable keyword.
Examples The following example shows how to set the bulk lease query data transfer timeout to 60 seconds:
(config)# ipv6 dhcp-relay bulk-lease data-timeout 60
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
513
IP Addressing Services
ipv6 dhcp-relay option vpn
ipv6 dhcp-relay option vpn
To enable the DHCP for IPv6 relay VRF-aware feature, use the ipv6 dhcp-relay option vpn command in
global configuration mode. To disable the feature, use the no form of this command.
ipv6 dhcp-relay option vpn
no ipv6 dhcp-relay option vpn
Syntax Description This command has no arguments or keywords.
Command Default The DHCP for IPv6 relay VRF-aware feature is not enabled on the device.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 dhcp-relay option vpn command allows the DHCPv6 relay VRF-aware feature to be enabled
globally on the device. If the ipv6 dhcp relay option vpn command is enabled on a specified interface, it
overrides the global ipv6 dhcp-relay option vpn command.
Examples The following example enables the DHCPv6 relay VRF-aware feature globally on the device:
(config)# ipv6 dhcp-relay option vpn
Related Commands Command Description
ipv6 dhcp relay option vpn Enables the DHCPv6 relay VRF-aware feature on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
514
IP Addressing Services
ipv6 dhcp-relay source-interface
ipv6 dhcp-relay source-interface
To configure an interface to use as the source when relaying messages, use the ipv6 dhcp-relay
source-interface command in global configuration mode. To remove the interface from use as the source,
use the no form of this command.
ipv6 dhcp-relay source-interface interface-type interface-number
no ipv6 dhcp-relay source-interface interface-type interface-number
Syntax Description interface-type (Optional) Interface type and number that specifies output interface for a
interface-number destination. If this argument is configured, client messages are forwarded to
the destination address through the link to which the output interface is
connected.
Command Default The address of the server-facing interface is used as the IPv6 relay source.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If the configured interface is shut down, or if all of its IPv6 addresses are removed, the relay will revert to its
standard behavior.
The interface configuration (using the ipv6 dhcp relay source-interface command in interface configuration
mode) takes precedence over the global configuration if both have been configured.
Examples The following example configures the Loopback 0 interface to be used as the relay source:
(config)# ipv6 dhcp-relay source-interface loopback 0
Related Commands Command Description
ipv6 dhcp relay source-interface Enables DHCP for IPv6 service on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
515
IP Addressing Services
ipv6 dhcp binding track ppp
ipv6 dhcp binding track ppp
To configure Dynamic Host Configuration Protocol (DHCP) for IPv6 to release any bindings associated with
a PPP connection when that connection closes, use the ipv6 dhcp binding track ppp command in global
configuration mode. To return to the default behavior, use the no form of this command.
ipv6 dhcp binding track ppp
no ipv6 dhcp binding track ppp
Syntax Description This command has no arguments or keywords.
Command Default When a PPP connection closes, the DHCP bindings associated with that connection are not released.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 dhcp binding track ppp command configures DHCP for IPv6 to automatically release any bindings
associated with a PPP connection when that connection is closed. The bindings are released automatically to
accommodate subsequent new registrations by providing sufficient resource.
Note In IPv6 broadband deployment using DHCPv6, you must enable release of prefix bindings associated with a
PPP virtual interface using this command. This ensures that DHCPv6 bindings are tracked together with PPP
sessions, and in the event of DHCP REBIND failure, the client initiates DHCPv6 negotiation again.
A binding table entry on the DHCP for IPv6 server is automatically:
• Created whenever a prefix is delegated to a client from the configuration pool.
• Updated when the client renews, rebinds, or confirms the prefix delegation.
• Deleted when the client releases all the prefixes in the binding voluntarily, all prefixes’ valid lifetimes
have expired, or an administrator clears the binding.
Examples The following example shows how to release the prefix bindings associated with the PPP:
(config)# ipv6 dhcp binding track ppp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
516
IP Addressing Services
ipv6 dhcp database
ipv6 dhcp database
To configure a Dynamic Host Configuration Protocol (DHCP) for IPv6 binding database agent, use the ipv6
dhcp database command in global configuration mode. To delete the database agent, use the no form of this
command.
ipv6 dhcp database agent [ write-delay seconds ] abort [ timeout seconds ]
no ipv6 dhcp database agent
Syntax Description agent A flash, local bootflash, compact flash, NVRAM, FTP, TFTP, or Remote Copy
Protocol (RCP) uniform resource locator.
write-delay seconds (Optional) How often (in seconds) DHCP for IPv6 sends database updates. The
default is 300 seconds. The minimum write delay is 60 seconds.
timeout seconds (Optional) How long, in seconds, the router waits for a database transfer.
Command Default Write-delay default is 300 seconds. Timeout default is 300 seconds.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 dhcp database command specifies DHCP for IPv6 binding database agent parameters. The user
may configure multiple database agents.
A binding table entry is automatically created whenever a prefix is delegated to a client from the configuration
pool, updated when the client renews, rebinds, or confirms the prefix delegation, and deleted when the client
releases all the prefixes in the binding voluntarily, all prefixes’ valid lifetimes have expired, or administrators
enable the clear ipv6 dhcp binding command. These bindings are maintained in RAM and can be saved to
permanent storage using the agent argument so that the information about configuration such as prefixes
assigned to clients is not lost after a system reload or power down. The bindings are stored as text records for
easy maintenance.
Each permanent storage to which the binding database is saved is called the database agent. A database agent
can be a remote host such as an FTP server or a local file system such as NVRAM.
The write-delay keyword specifies how often, in seconds, that DHCP sends database updates. By default,
DHCP for IPv6 server waits 300 seconds before sending any database changes.
The timeout keyword specifies how long, in seconds, the router waits for a database transfer. Infinity is
defined as 0 seconds, and transfers that exceed the timeout period are canceled. By default, the DHCP for
IPv6 server waits 300 seconds before canceling a database transfer. When the system is going to reload, there
is no transfer timeout so that the binding table can be stored completely.
Examples The following example specifies DHCP for IPv6 binding database agent parameters and stores
binding entries in TFTP:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
517
IP Addressing Services
ipv6 dhcp database
(config)# ipv6 dhcp database tftp://10.0.0.1/dhcp-binding
The following example specifies DHCP for IPv6 binding database agent parameters and stores
binding entries in bootflash:
(config)# ipv6 dhcp database bootflash
Related Commands Command Description
clear ipv6 dhcp binding Deletes automatic client bindings from the DHCP for IPv6 server binding table
show ipv6 dhcp database Displays DHCP for IPv6 binding database agent information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
518
IP Addressing Services
ipv6 dhcp iana-route-add
ipv6 dhcp iana-route-add
To add routes for individually assigned IPv6 addresses on a relay or server, use the ipv6 dhcp iana-route-add
command in global configuration mode. To disable route addition for individually assigned IPv6 addresses
on a relay or server, use the no form of the command.
ipv6 dhcp iana-route-add
no ipv6 dhcp iana-route-add
Syntax Description This command has no arguments or keywords.
Command Default Route addition for individually assigned IPv6 addresses on a relay or server is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 dhcp iana-route-add command is disabled by default and has to be enabled if route addition is
required. Route addition for Internet Assigned Numbers Authority (IANA) is possible if the client is connected
to the relay or server through unnumbered interfaces, and if route addition is enabled with the help of this
command.
Examples The following example shows how to enable route addition for individually assigned IPv6 addresses:
Device(config)# ipv6 dhcp iana-route-add
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
519
IP Addressing Services
ipv6 dhcp iapd-route-add
ipv6 dhcp iapd-route-add
To enable route addition by Dynamic Host Configuration Protocol for IPv6 (DHCPv6) relay and server for
the delegated prefix, use the ipv6 dhcp iapd-route-add command in global configuration mode. To disable
route addition, use the no form of the command.
ipv6 dhcp iapd-route-add
no ipv6 dhcp iapd-route-add
Syntax Description This command has no arguments or keywords.
Command Default DHCPv6 relay and DHCPv6 server add routes for delegated prefixes by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The DHCPv6 relay and the DHCPv6 server add routes for delegated prefixes by default. The presence of this
command on a device does not mean that routes will be added on that device. When you configure the
command, routes for delegated prefixes will only be added on the first Layer 3 relay and server.
Examples The following example shows how to enable the DHCPv6 relay and server to add routes for a
delegated prefix:
Device(config)# ipv6 dhcp iapd-route-add
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
520
IP Addressing Services
ipv6 dhcp-ldra
ipv6 dhcp-ldra
To enable Lightweight DHCPv6 Relay Agent (LDRA) functionality on an access node, use the ipv6 dhcp-ldra
command in global configuration mode. To disable the LDRA functionality, use the no form of this command.
ipv6 dhcp-ldra {enable | disable}
no ipv6 dhcp-ldra {enable | disable}
Syntax Description enable Enables LDRA functionality on an access node.
disable Disables LDRA functionality on an access node.
Command Default By default, LDRA functionality is not enabled on an access node.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You must configure the LDRA functionality globally using the ipv6 dhcp-ldra command before configuring
it on a VLAN or an access node (such as a Digital Subscriber Link Access Multiplexer [DSLAM] or an
Ethernet switch) interface.
Example
The following example shows how to enable the LDRA functionality:
(config)# ipv6 dhcp-ldra enable
(config)# exit
Note In the above example, Device denotes an access node.
Related Commands Command Description
ipv6 dhcp ldra attach-policy Enables LDRA functionality on a VLAN.
ipv6 dhcp-ldra attach-policy Enables LDRA functionality on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
521
IP Addressing Services
ipv6 dhcp ping packets
ipv6 dhcp ping packets
To specify the number of packets a Dynamic Host Configuration Protocol for IPv6 (DHCPv6) server sends
to a pool address as part of a ping operation, use the ipv6 dhcp ping packets command in global configuration
mode. To prevent the server from pinging pool addresses, use the no form of this command.
ipv6 dhcp ping packets number
ipv6 dhcp ping packets
Syntax Description number The number of ping packets sent before the address is assigned to a requesting client. The valid
range is from 0 to 10.
Command Default No ping packets are sent before the address is assigned to a requesting client.
Command Modes Global configuration (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The DHCPv6 server pings a pool address before assigning the address to a requesting client. If the ping is
unanswered, the server assumes, with a high probability, that the address is not in use and assigns the address
to the requesting client.
Setting the number argument to 0 turns off the DHCPv6 server ping operation
Examples The following example specifies four ping attempts by the DHCPv6 server before further ping
attempts stop:
(config)# ipv6 dhcp ping packets 4
Related Commands Command Description
clear ipv6 dhcp conflict Clears an address conflict from the DHCPv6 server database.
show ipv6 dhcp conflict Displays address conflicts found by a DHCPv6 server, or reported through a
DECLINE message from a client.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
522
IP Addressing Services
ipv6 dhcp pool
ipv6 dhcp pool
To configure a Dynamic Host Configuration Protocol (DHCP) for IPv6 server configuration information pool
and enter DHCP for IPv6 pool configuration mode, use the ipv6 dhcp pool command in global configuration
mode. To delete a DHCP for IPv6 pool, use the no form of this command.
ipv6 dhcp pool poolname
no ipv6 dhcp pool poolname
Syntax Description poolname User-defined name for the local prefix pool. The pool name can be a symbolic string (such as
"Engineering") or an integer (such as 0).
Command Default DHCP for IPv6 pools are not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 dhcp poolcommand to create a DHCP for IPv6 server configuration information pool. When
the ipv6 dhcp pool command is enabled, the configuration mode changes to DHCP for IPv6 pool configuration
mode. In this mode, the administrator can configure pool parameters, such as prefixes to be delegated and
Domain Name System (DNS) servers, using the following commands:
• address prefix IPv6-prefix [lifetime {valid-lifetime preferred-lifetime | infinite}]sets an address prefix
for address assignment. This address must be in hexadecimal, using 16-bit values between colons.
• link-address IPv6-prefix sets a link-address IPv6 prefix. When an address on the incoming interface
or a link-address in the packet matches the specified IPv6-prefix, the server uses the configuration
information pool. This address must be in hexadecimal, using 16-bit values between colons.
• vendor-specific vendor-id enables DHCPv6 vendor-specific configuration mode. Specify a vendor
identification number. This number is the vendor IANA Private Enterprise Number. The range is 1 to
4294967295. The following configuration command is available:
• suboption number sets vendor-specific suboption number. The range is 1 to 65535. You can enter
an IPv6 address, ASCII text, or a hex string as defined by the suboption parameters.
Note The hex value used under the suboption keyword allows users to enter only hex digits (0-f). Entering an
invalid hex value does not delete the previous configuration.
Once the DHCP for IPv6 configuration information pool has been created, use the ipv6 dhcp server command
to associate the pool with a server on an interface. If you do not configure an information pool, you need to
use the ipv6 dhcp server interface configuration command to enable the DHCPv6 server function on an
interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
523
IP Addressing Services
ipv6 dhcp pool
When you associate a DHCPv6 pool with an interface, only that pool services requests on the associated
interface. The pool also services other interfaces. If you do not associate a DHCPv6 pool with an interface,
it can service requests on any interface.
Not using any IPv6 address prefix means that the pool returns only configured options.
The link-address command allows matching a link-address without necessarily allocating an address. You
can match the pool from multiple relays by using multiple link-address configuration commands inside a pool.
Since a longest match is performed on either the address pool information or the link information, you can
configure one pool to allocate addresses and another pool on a subprefix that returns only configured options.
Examples The following example specifies a DHCP for IPv6 configuration information pool named cisco1 and
places the router in DHCP for IPv6 pool configuration mode:
(config)# ipv6 dhcp pool cisco1
(config-dhcpv6)#
The following example shows how to configure an IPv6 address prefix for the IPv6 configuration
pool cisco1:
(config-dhcpv6)# address prefix 2001:1000::0/64
(config-dhcpv6)# end
The following example shows how to configure a pool named engineering with three link-address
prefixes and an IPv6 address prefix:
# configure terminal
(config)# ipv6 dhcp pool engineering
(config-dhcpv6)# link-address 2001:1001::0/64(config-dhcpv6)# link-address
2001:1002::0/64(config-dhcpv6)# link-address 2001:2000::0/48(config-dhcpv6)# address prefix
2001:1003::0/64
(config-dhcpv6)# end
The following example shows how to configure a pool named 350 with vendor-specific options:
# configure terminal
(config)# ipv6 dhcp pool 350
(config-dhcpv6)# vendor-specific 9
(config-dhcpv6-vs)# suboption 1 address 1000:235D::1(config-dhcpv6-vs)# suboption 2 ascii
"IP-Phone"
(config-dhcpv6-vs)# end
Related Commands Command Description
ipv6 dhcp server Enables DHCP for IPv6 service on an interface.
show ipv6 dhcp pool Displays DHCP for IPv6 configuration pool information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
524
IP Addressing Services
ipv6 dhcp server vrf enable
ipv6 dhcp server vrf enable
To enable the DHCP for IPv6 server VRF-aware feature, use the ipv6 dhcp server vrf enable command in
global configuration mode. To disable the feature, use the no form of this command.
ipv6 dhcp server vrf enable
no ipv6 dhcp server vrf enable
Syntax Description This command has no arguments or keywords.
Command Default The DHCPv6 server VRF-aware feature is not enabled.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 dhcp server option vpn command allows the DHCPv6 server VRF-aware feature to be enabled
globally on a device.
Examples The following example enables the DHCPv6 server VRF-aware feature globally on a device:
(config)# ipv6 dhcp server option vpn
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
525
IP Addressing Services
ipv6 flow monitor
ipv6 flow monitor
This command activates a previously created flow monitor by assigning it to the interface to analyze incoming
or outgoing traffic.
To activate a previously created flow monitor, use the ipv6 flow monitor command. To de-activate a flow
monitor, use the no form of the command.
ipv6 flow monitor ipv6-monitor-name [sampler ipv6-sampler-name] {input | output}
no ipv6 flow monitor ipv6-monitor-name [sampler ipv6-sampler-name] {input | output}
Syntax Description ipv6-monitor-name Activates a previously created flow monitor by assigning it to the interface
to analyze incoming or outgoing traffic.
sampler ipv6-sampler-name Applies the flow monitor sampler.
input Applies the flow monitor on input traffic.
output Applies the flow monitor on output traffic.
Command Default IPv6 flow monitor is not activated until it is assigned to an interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You cannot attach a NetFlow monitor to a port channel interface. If both service module interfaces are part
of an EtherChannel, you should attach the monitor to both physical interfaces.
This example shows how to apply a flow monitor to an interface:
(config)# interface gigabitethernet 1/1/2
(config-if)# ip flow monitor FLOW-MONITOR-1 input
(config-if)# ip flow monitor FLOW-MONITOR-2 output
(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
526
IP Addressing Services
ipv6 general-prefix
ipv6 general-prefix
To define an IPv6 general prefix, use the ipv6 general-prefix command in global configuration mode. To
remove the IPv6 general prefix, use the no form of this command.
ipv6 general-prefix prefix-name {ipv6-prefix/prefix-length | 6to4 interface-type interface-number | 6rd
interface-type interface-number}
no ipv6 general-prefix prefix-name
Syntax Description prefix-name The name assigned to the prefix.
ipv6-prefix The IPv6 network assigned to the general prefix.
This argument must be in the form documented in RFC 2373 where the address is
specified in hexadecimal using 16-bit values between colons.
When defining a general prefix manually, specify both the ipv6-prefix and /
prefix-length arguments.
/ prefix-length The length of the IPv6 prefix. A decimal value that indicates how many of the
high-order contiguous bits of the address comprise the prefix (the network portion
of the address). A slash mark must precede the decimal value.
When defining a general prefix manually, specify both the ipv6-prefix and /
prefix-length arguments.
6to4 Allows configuration of a general prefix based on an interface used for 6to4 tunneling.
When defining a general prefix based on a 6to4 interface, specify the 6to4 keyword
and the interface-type interface-numberargument.
interface-type Interface type and number. For more information, use the question mark (?) online
interface-number help function.
When defining a general prefix based on a 6to4 interface, specify the 6to4 keyword
and the interface-type interface-numberargument.
6rd Allows configuration of a general prefix computed from an interface used for IPv6
rapid deployment (6RD) tunneling.
Command Default No general prefix is defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 general-prefix command to define an IPv6 general prefix.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
527
IP Addressing Services
ipv6 general-prefix
A general prefix holds a short prefix, based on which a number of longer, more specific, prefixes can be
defined. When the general prefix is changed, all of the more specific prefixes based on it will change, too.
This function greatly simplifies network renumbering and allows for automated prefix definition.
More specific prefixes, based on a general prefix, can be used when configuring IPv6 on an interface.
When defining a general prefix based on an interface used for 6to4 tunneling, the general prefix will be of
the form 2002:a.b.c.d::/48, where "a.b.c.d" is the IPv4 address of the interface referenced.
Examples The following example manually defines an IPv6 general prefix named my-prefix:
(config)# ipv6 general-prefix my-prefix 2001:DB8:2222::/48
The following example defines an IPv6 general prefix named my-prefix based on a 6to4 interface:
(config)# ipv6 general-prefix my-prefix 6to4 ethernet0
Related Commands Command Description
show ipv6 general-prefix Displays information on general prefixes for an IPv6 addresses.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
528
IP Addressing Services
ipv6 local policy route-map
ipv6 local policy route-map
To enable local policy-based routing (PBR) for IPv6 packets, use the ipv6 local policy route-map command
in global configuration mode. To disable local policy-based routing for IPv6 packets, use the no form of this
command.
ipv6 local policy route-map route-map-name
no ipv6 local policy route-map route-map-name
Syntax Description route-map-name Name of the route map to be used for local IPv6 PBR. The name must match a
route-map-name value specified by the route-map command.
Command Default IPv6 packets are not policy routed.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Packets originating from a router are not normally policy routed. However, you can use the ipv6 local policy
route-map command to policy route such packets. You might enable local PBR if you want packets originated
at the router to take a route other than the obvious shortest path.
The ipv6 local policy route-map command identifies a route map to be used for local PBR. The route-map
commands each have a list of match and set commands associated with them. The match commands specify
the match criteria, which are the conditions under which packets should be policy routed. The set commands
specify set actions, which are particular policy routing actions to be performed if the criteria enforced by the
match commands are met. The no ipv6 local policy route-map command deletes the reference to the route
map and disables local policy routing.
Examples In the following example, packets with a destination IPv6 address matching that allowed by access
list pbr-src-90 are sent to the router at IPv6 address 2001:DB8::1:
ipv6 access-list src-90
permit ipv6 host 2001::90 2001:1000::/64
route-map pbr-src-90 permit 10
match ipv6 address src-90
set ipv6 next-hop 2001:DB8::1
ipv6 local policy route-map pbr-src-90
Related Commands Command Description
ipv6 policy route-map Configures IPv6 PBR on an interface.
match ipv6 address Specifies an IPv6 access list to be used to match packets for PBR for IPv6.
match length Bases policy routing on the Level 3 length of a packet.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
529
IP Addressing Services
ipv6 local policy route-map
Command Description
route-map (IP) Defines the conditions for redistributing routes from one routing protocol into
another, or enables policy routing.
set default interface Specifies the default interface to output packets that pass a match clause of a
route map for policy routing and have no explicit route to the destination.
set interface Specifies the default interface to output packets that pass a match clause of a
route map for policy routing.
set ipv6 default next-hop Specifies an IPv6 default next hop to which matching packets will be forwarded.
set ipv6 next-hop (PBR) Indicates where to output IPv6 packets that pass a match clause of a route map
for policy routing.
set ipv6 precedence Sets the precedence value in the IPv6 packet header.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
530
IP Addressing Services
ipv6 local pool
ipv6 local pool
To configure a local IPv6 prefix pool, use the ipv6 local pool configuration command with the prefix pool
name. To disband the pool, use the no form of this command.
ipv6 local pool poolname prefix/prefix-length assigned-length [shared] [cache-size size]
no ipv6 local pool poolname
Syntax Description poolname User-defined name for the local prefix pool.
prefix IPv6 prefix assigned to the pool.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
/ prefix-length The length of the IPv6 prefix assigned to the pool. A decimal value that indicates how
many of the high-order contiguous bits of the address comprise the prefix (the network
portion of the address).
assigned-length Length of prefix, in bits, assigned to the user from the pool. The value of the
assigned-length argument cannot be less than the value of the / prefix-length argument.
shared (Optional) Indicates that the pool is a shared pool.
cache-size size (Optional) Specifies the size of the cache.
Command Default No pool is configured.
Command Modes Global configuration (global)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines All pool names must be unique.
IPv6 prefix pools have a function similar to IPv4 address pools. Contrary to IPv4, a block of addresses (an
address prefix) are assigned and not single addresses.
Prefix pools are not allowed to overlap.
Once a pool is configured, it cannot be changed. To change the configuration, the pool must be removed and
recreated. All prefixes already allocated will also be freed.
Examples This example shows the creation of an IPv6 prefix pool:
(config)# ipv6 local pool pool1 2001:0DB8::/29 64
(config)# end
# show ipv6 local pool
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
531
IP Addressing Services
ipv6 local pool
Pool Prefix Free In use
pool1 2001:0DB8::/29 65516 20
Related Commands Command Description
debug ipv6 pool Enables IPv6 pool debugging.
peer default ipv6 address pool Specifies the pool from which client prefixes are assigned for PPP links.
prefix-delegation pool Specifies a named IPv6 local prefix pool from which prefixes are delegated
to DHCP for IPv6 clients.
show ipv6 local pool Displays information about any defined IPv6 address pools.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
532
IP Addressing Services
ipv6 mld snooping (global)
ipv6 mld snooping (global)
To enable Multicast Listener Discovery version 2 (MLDv2) protocol snooping globally, use the ipv6 mld
snooping command in global configuration mode. To disable the MLDv2 snooping globally, use the no form
of this command.
ipv6 mld snooping
no ipv6 mld snooping
Syntax Description This command has no arguments or keywords.
Command Default This command is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced on the Supervisor Engine 720.
16.5.1a
Usage Guidelines MLDv2 snooping is supported on the Supervisor Engine 720 with all versions of the Policy Feature Card 3
(PFC3).
To use MLDv2 snooping, configure a Layer 3 interface in the subnet for IPv6 multicast routing or enable the
MLDv2 snooping querier in the subnet.
Examples This example shows how to enable MLDv2 snooping globally:
(config)# ipv6 mld snooping
Related Commands Command Description
show ipv6 mld snooping Displays MLDv2 snooping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
533
IP Addressing Services
ipv6 mld ssm-map enable
ipv6 mld ssm-map enable
To enable the Source Specific Multicast (SSM) mapping feature for groups in the configured SSM range, use
the ipv6 mld ssm-map enable command in global configuration mode. To disable this feature, use the no
form of this command.
ipv6 mld [vrf vrf-name] ssm-map enable
no ipv6 mld [vrf vrf-name] ssm-map enable
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Default The SSM mapping feature is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 mld ssm-map enable command enables the SSM mapping feature for groups in the configured
SSM range. When the ipv6 mld ssm-map enable command is used, SSM mapping defaults to use the Domain
Name System (DNS).
SSM mapping is applied only to received Multicast Listener Discovery (MLD) version 1 or MLD version 2
membership reports.
Examples The following example shows how to enable the SSM mapping feature:
(config)# ipv6 mld ssm-map enable
Related Commands Command Description
debug ipv6 mld ssm-map Displays debug messages for SSM mapping.
ipv6 mld ssm-map query dns Enables DNS-based SSM mapping.
ipv6 mld ssm-map static Configures static SSM mappings.
show ipv6 mld ssm-map Displays SSM mapping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
534
IP Addressing Services
ipv6 mld state-limit
ipv6 mld state-limit
To limit the number of Multicast Listener Discovery (MLD) states globally, use the ipv6 mld state-limit
command in global configuration mode. To disable a configured MLD state limit, use the no form of this
command.
ipv6 mld [vrf vrf-name] state-limit number
no ipv6 mld [vrf vrf-name] state-limit number
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
number Maximum number of MLD states allowed on a router. The valid range is from 1 to 64000.
Command Default No default number of MLD limits is configured. You must configure the number of maximum MLD states
allowed globally on a router when you configure this command.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the ipv6 mld state-limit command to configure a limit on the number of MLD states resulting from MLD
membership reports on a global basis. Membership reports sent after the configured limits have been exceeded
are not entered in the MLD cache and traffic for the excess membership reports is not forwarded.
Use the ipv6 mld limit command in interface configuration mode to configure the per-interface MLD state
limit.
Per-interface and per-system limits operate independently of each other and can enforce different configured
limits. A membership state will be ignored if it exceeds either the per-interface limit or global limit.
Examples The following example shows how to limit the number of MLD states on a router to 300:
(config)# ipv6 mld state-limit 300
Related Commands Command Description
ipv6 mld access-group Enables the performance of IPv6 multicast receiver access control.
ipv6 mld limit Limits the number of MLD states resulting from MLD membership state on a
per-interface basis.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
535
IP Addressing Services
ipv6 multicast-routing
ipv6 multicast-routing
To enable multicast routing using Protocol Independent Multicast (PIM) and Multicast Listener Discovery
(MLD) on all IPv6-enabled interfaces of the router and to enable multicast forwarding, use the ipv6
multicast-routing command in global configuration mode. To stop multicast routing and forwarding, use the
no form of this command.
ipv6 multicast-routing [vrf vrf-name]
no ipv6 multicast-routing
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Default Multicast routing is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 multicast-routing command to enable multicast forwarding. This command also enables Protocol
Independent Multicast (PIM) and Multicast Listener Discovery (MLD) on all IPv6-enabled interfaces of the
router being configured.
You can configure individual interfaces before you enable multicast so that you can then explicitly disable
PIM and MLD protocol processing on those interfaces, as needed. Use the no ipv6 pim or the no ipv6 mld
router command to disable IPv6 PIM or MLD router-side processing, respectively.
Examples The following example enables multicast routing and turns on PIM and MLD on all interfaces:
(config)# ipv6 multicast-routing
Related Commands Command Description
ipv6 pim rp-address Configures the address of a PIM RP for a particular group range.
no ipv6 pim Turns off IPv6 PIM on a specified interface.
no ipv6 mld router Disables MLD router-side processing on a specified interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
536
IP Addressing Services
ipv6 multicast group-range
ipv6 multicast group-range
To disable multicast protocol actions and traffic forwarding for unauthorized groups or channels on all the
interfaces in a router, use the ipv6 multicast group-range command in global configuration mode. To return
to the command’s default settings, use the no form of this command.
ipv6 multicast [vrf vrf-name] group-range [access-list-name]
no ipv6 multicast [vrf vrf-name] group-range [access-list-name]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
access-list-name (Optional) Name of an access list that contains authenticated subscriber groups and
authorized channels that can send traffic to the router.
Command Default Multicast is enabled for groups and channels permitted by a specified access list and disabled for groups and
channels denied by a specified access list.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 multicast group-range command provides an access control mechanism for IPv6 multicast edge
routing. The access list specified by the access-list-name argument specifies the multicast groups or channels
that are to be permitted or denied. For denied groups or channels, the router ignores protocol traffic and actions
(for example, no Multicast Listener Discovery (MLD) states are created, no mroute states are created, no
Protocol Independent Multicast ( PIM) joins are forwarded), and drops data traffic on all interfaces in the
system, thus disabling multicast for denied groups or channels.
Using the ipv6 multicast group-range global configuration command is equivalent to configuring the MLD
access control and multicast boundary commands on all interfaces in the system. However, the ipv6 multicast
group-range command can be overridden on selected interfaces by using the following interface configuration
commands:
• ipv6 mld access-group access-list-name
• ipv6 multicast boundary scope scope-value
Because the no ipv6 multicast group-range command returns the router to its default configuration, existing
multicast deployments are not broken.
Examples The following example ensures that the router disables multicast for groups or channels denied by
an access list named list2:
(config)# ipv6 multicast group-range list2
The following example shows that the command in the previous example is overridden on an interface
specified by int2:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
537
IP Addressing Services
ipv6 multicast group-range
(config)# interface int2
(config-if)# ipv6 mld access-group int-list2
On int2, MLD states are created for groups or channels permitted by int-list2 but are not created for
groups or channels denied by int-list2. On all other interfaces, the access-list named list2 is used for
access control.
In this example, list2 can be specified to deny all or most multicast groups or channels, and int-list2
can be specified to permit authorized groups or channels only for interface int2.
Related Commands Command Description
ipv6 mld access-group Performs IPv6 multicast receiver access control.
ipv6 multicast boundary scope Configures a multicast boundary on the interface for a specified scope.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
538
IP Addressing Services
ipv6 multicast pim-passive-enable
ipv6 multicast pim-passive-enable
To enable the Protocol Independent Multicast (PIM) passive feature on an IPv6 router, use the ipv6 multicast
pim-passive-enable command in global configuration mode. To disable this feature, use the no form of this
command.
ipv6 multicast pim-passive-enable
no ipv6 multicast pim-passive-enable
Syntax Description This command has no arguments or keywords.
Command Default PIM passive mode is not enabled on the router.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 multicast pim-passive-enable command to configure IPv6 PIM passive mode on a router. Once
PIM passive mode is configured globally, use the ipv6 pim passive command in interface configuration mode
to configure PIM passive mode on a specific interface.
Examples The following example configures IPv6 PIM passive mode on a router:
(config)# ipv6 multicast pim-passive-enable
Related Commands Command Description
ipv6 pim passive Configures PIM passive mode on a specific interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
539
IP Addressing Services
ipv6 multicast rpf
ipv6 multicast rpf
To enable IPv6 multicast reverse path forwarding (RPF) check to use Border Gateway Protocol (BGP) unicast
routes in the Routing Information Base (RIB), use the ipv6 multicast rpf command in global configuration
mode. To disable this function, use the no form of this command.
ipv6 multicast [vrf vrf-name] rpf {backoff initial-delay max-delay | use-bgp}
no ipv6 multicast [vrf vrf-name] rpf {backoff initial-delay max-delay | use-bgp}
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
backoff Specifies the backoff delay after a unicast routing change.
initial-delay Initial RPF backoff delay, in milliseconds (ms). The range is from 200 to 65535.
max-delay Maximum RPF backoff delay, in ms. The range is from 200 to 65535.
use-bgp Specifies to use BGP routes for multicast RPF lookups.
Command Default The multicast RPF check does not use BGP unicast routes.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When the ipv6 multicast rpf command is configured, multicast RPF check uses BGP unicast routes in the
RIB. This is not done by default.
Examples The following example shows how to enable the multicast RPF check function:
(config)# ipv6 multicast rpf use-bgp
Related Commands Command Description
ipv6 multicast limit Configure per-interface multicast route (mroute) state limiters in IPv6.
ipv6 multicast multipath Enables load splitting of IPv6 multicast traffic across multiple equal-cost paths.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
540
IP Addressing Services
ipv6 nd cache expire
ipv6 nd cache expire
To configure the duration of time before an IPv6 neighbor discovery cache entry expires, use the ipv6 nd
cache expire command in the interface configuration mode. To remove this configuration, use the no form
of this command.
ipv6 nd cache expire expire-time-in-seconds [refresh]
no ipv6 nd cache expire expire-time-in-seconds [refresh]
Syntax Description expire-time-in-seconds The time range is from 1 through 65536 seconds. The default is
or 4 hours.
refresh (Optional) Automatically refreshes the neighbor discovery cach
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines By default, a neighbor discovery cache entry is expired and deleted if it remains in the STALE state for 14,400
seconds or 4 hours. The ipv6 nd cache expire command allows the expiry time to vary and to trigger auto
refresh of an expired entry before the entry is deleted.
When the refresh keyword is used, a neighbor discovery cache entry is auto refreshed. The entry moves into
the DELAY state and the neighbor unreachability detection process occurs, in which the entry transitions
from the DELAY state to the PROBE state after 5 seconds. When the entry reaches the PROBE state, a
neighbor solicitation is sent and then retransmitted as per the configuration.
Examples The following example shows that the neighbor discovery cache entry is configured to expire in 7200
seconds or 2 hours:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/4
Device(config-if)# ipv6 nd cache expire 7200
Related Commands Command Description
ipv6 nd na glean Configures neighbor discovery to glean an entry from
an unsolicited neighbor advertisement.
ipv6 nd nud retry Configures the number of times neighbor
unreachability detection resends neighbor solicitations.
show ipv6 interface Displays the usability status of interfaces that are
configured for IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
541
IP Addressing Services
ipv6 nd cache interface-limit (global)
ipv6 nd cache interface-limit (global)
To configure a neighbor discovery cache limit on all interfaces on the device, use the ipv6 nd cache
interface-limit command in global configuration mode. To remove the neighbor discovery from all interfaces
on the device, use the no form of this command.
ipv6 nd cache interface-limit size [log rate]
no ipv6 nd cache interface-limit size [log rate]
Syntax Description size Cache size.
log rate (Optional) Adjustable logging rate, in seconds. The valid values are 0 and 1.
Command Default Default logging rate for the device is one entry every second.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 nd cache interface-limit command in global configuration mode imposes a common per-interface
cache size limit on all interfaces on the device.
Issuing the no or default form of the command will remove the neighbor discovery limit from every interface
on the device that was configured using global configuration mode. It will not remove the neighbor discovery
limit from any interface configured using the ipv6 nd cache interface-limit command in interface configuration
mode.
The default (and maximum) logging rate for the device is one entry every second.
Examples The following example shows how to set a common per-interface cache size limit of 4 seconds on
all interfaces on the device:
(config)# ipv6 nd cache interface-limit 4
Related Commands Command Description
ipv6 nd cache interface-limit (interface) Configures a neighbor discovery cache limit on a specified
interface on the device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
542
IP Addressing Services
ipv6 nd host mode strict
ipv6 nd host mode strict
To enable the conformant, or strict, IPv6 host mode, use the ipv6 nd host mode strict command in global
configuration mode. To reenable conformant, or loose, IPv6 host mode, use the no form of this command.
ipv6 nd host mode strict
Syntax Description This command has no arguments or keywords.
Command Default Nonconformant, or loose, IPv6 host mode is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The default IPv6 host mode type is loose, or nonconformant. To enable IPv6 strict, or conformant, host mode,
use the ipv6 nd host mode strict command. You can change between the two IPv6 host modes using the no
form of this command.
The ipv6 nd host mode strict command selects the type of IPv6 host mode behavior and enters interface
configuration mode. However, the ipv6 nd host mode strict command is ignored if you have configured IPv6
routing with the ipv6 unicast-routing command. In this situation, the default IPv6 host mode type, loose, is
used.
Examples The following example shows how to configure the device as a strict IPv6 host and enables IPv6
address autoconfiguration on Ethernet interface 0/0:
(config)# ipv6 nd host mode strict
(config-if)# interface ethernet0/0
(config-if)# ipv6 address autoconfig
The following example shows how to configure the device as a strict IPv6 host and configures a
static IPv6 address on Ethernet interface 0/0:
(config)# ipv6 nd host mode strict
(config-if)# interface ethernet0/0
(config-if)# ipv6 address 2001::1/64
Related Commands Command Description
ipv6 unicast-routing Enables the forwarding of IPv6 unicast datagrams.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
543
IP Addressing Services
ipv6 nd na glean
ipv6 nd na glean
To configure the neighbor discovery to glean an entry from an unsolicited neighbor advertisement, use the
ipv6 nd na glean command in the interface configuration mode. To disable this feature, use the no form of
this command.
ipv6 nd na glean
no ipv6 nd na glean
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines IPv6 nodes may emit a multicast unsolicited neighbor advertisement packet following the successful completion
of duplicate address detection (DAD). By default, other IPv6 nodes ignore these unsolicited neighbor
advertisement packets. The ipv6 nd na glean command configures the router to create a neighbor advertisement
entry on receipt of an unsolicited neighbor advertisement packet (assuming no such entry already exists and
the neighbor advertisement has the link-layer address option). Use of this command allows a device to populate
its neighbor advertisement cache with an entry for a neighbor before data traffic exchange with the neighbor.
Examples The following example shows how to configure neighbor discovery to glean an entry from an
unsolicited neighbor advertisement:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/4
Device(config-if)# ipv6 nd na glean
Related Commands Command Description
ipv6 nd cache expire Configures the duration of time before an IPv6
neighbor discovery cache entry expires.
ipv6 nd nud retry Configures the number of times neighbor
unreachability detection resends neighbor solicitations.
show ipv6 interface Displays the usability status of interfaces that are
configured for IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
544
IP Addressing Services
ipv6 nd ns-interval
ipv6 nd ns-interval
To configure the interval between IPv6 neighbor solicitation (NS) retransmissions on an interface, use the
ipv6 nd ns-interval command in interface configuration mode. To restore the default interval, use the no
form of this command.
ipv6 nd ns-interval milliseconds
no ipv6 nd ns-interval
Syntax Description milliseconds The interval between IPv6 neighbor solicit transmissions for address resolution. The acceptable
range is from 1000 to 3600000 milliseconds.
Command Default 0 milliseconds (unspecified) is advertised in router advertisements and the value 1000 is used for the neighbor
discovery activity of the router itself.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines By default, using the ipv6 nd ns-interval command changes the NS retransmission interval for both address
resolution and duplicate address detection (DAD). To specify a different NS retransmission interval for DAD,
use the ipv6 nd dad time command.
This value will be included in all IPv6 router advertisements sent out this interface. Very short intervals are
not recommended in normal IPv6 operation. When a nondefault value is configured, the configured time is
both advertised and used by the router itself.
Examples The following example configures an IPv6 neighbor solicit transmission interval of 9000 milliseconds
for Ethernet interface 0/0:
(config)# interface ethernet 0/0
(config-if)# ipv6 nd ns-interval 9000
Related Commands Command Description
ipv6 nd dad time Configures the NS retransmit interval for DAD separately from the NS retransmit
interval for address resolution.
show ipv6 interface Displays the usability status of interfaces configured for IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
545
IP Addressing Services
ipv6 nd nud retry
ipv6 nd nud retry
To configure the number of times the neighbor unreachability detection process resends neighbor solicitations,
use the ipv6 nd nud retry command in the interface configuration mode. To disable this feature, use the no
form of this command.
ipv6 nd nud retry base interval max-attempts {final-wait-time}
no ipv6 nd nud retry base interval max-attempts {final-wait-time}
Syntax Description base The neighbor unreachability detection process base value.
interval The time interval, in milliseconds, between retries.
The range is from 1000 to 32000.
max-attempts The maximum number of retry attempts, depending on the base val
The range is from 1 to 128.
final-wait-time The waiting time, in milliseconds, on the last probe.
The range is from 1000 to 32000.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When a device runs neighbor unreachability detection to resolve the neighbor detection entry for a neighbor
again, it sends three neighbor solicitation packets 1 second apart. In certain situations, for example, spanning-tree
events, or high-traffic events, or end-host reloads), three neighbor solicitation packets that are sent at an
interval of 1 second may not be sufficient. To help maintain the neighbor cache in such situations, use the
ipv6 nd nud retry command to configure exponential timers for neighbor solicitation retransmits.
The maximum number of retry attempts is configured using the max-attempts argument. The retransmit interval
is calculated with the following formula:
tm^n
here,
• t = Time interval
• m = Base (1, 2, or 3)
• n = Current neighbor solicitation number (where the first neighbor solicitation is 0).
Therefore, ipv6 nd nud retry 3 1000 5 command retransmits at intervals of 1,3,9,27,81 seconds. If the final
wait time is not configured, the entry remains for 243 seconds before it is deleted.
The ipv6 nd nud retry command affects only the retransmit rate for the neighbor unreachability detection
process, and not for the initial resolution, which uses the default of three neighbor solicitation packets sent 1
second apart.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
546
IP Addressing Services
ipv6 nd nud retry
Examples The following example shows how to configure a fixed interval of 1 second and three retransmits:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/4
Device(config-if)# ipv6 nd nud retry 1 1000 3
The following example shows how to configure a retransmit interval of 1, 2, 4, and 8:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/4
Device(config-if)# ipv6 nd nud retry 2 1000 4
The following example shows how to configure the retransmit intervals of 1, 3, 9, 27, 81:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/4
Device(config-if)# ipv6 nd nud retry 3 1000 5
Related Commands Command Description
ipv6 nd cache expire Configures the duration of time before an IPv6
neighbor discovery (ND) cache entry expires.
ipv6 nd na glean Configures neighbor discovery to glean an entry from
an unsolicited neighbor advertisement.
show ipv6 interface Displays the usability status of interfaces that are
configured for IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
547
IP Addressing Services
ipv6 nd reachable-time
ipv6 nd reachable-time
To configure the amount of time that a remote IPv6 node is considered reachable after some reachability
confirmation event has occurred, use the ipv6 nd reachable-time command in interface configuration mode.
To restore the default time, use the no form of this command.
ipv6 nd reachable-time milliseconds
no ipv6 nd reachable-time
Syntax Description milliseconds The amount of time that a remote IPv6 node is considered reachable (in milliseconds).
Command Default 0 milliseconds (unspecified) is advertised in router advertisements and the value 30000 (30 seconds) is used
for the neighbor discovery activity of the router itself.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The configured time enables the router to detect unavailable neighbors. Shorter configured times enable the
router to detect unavailable neighbors more quickly; however, shorter times consume more IPv6 network
bandwidth and processing resources in all IPv6 network devices. Very short configured times are not
recommended in normal IPv6 operation.
The configured time is included in all router advertisements sent out of an interface so that nodes on the same
link use the same time value. A value of 0 means indicates that the configured time is unspecified by this
router.
Examples The following example configures an IPv6 reachable time of 1,700,000 milliseconds for Ethernet
interface 0/0:
(config)# interface ethernet 0/0
(config-if)# ipv6 nd reachable-time 1700000
Related Commands Command Description
show ipv6 interface Displays the usability status of interfaces configured for IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
548
IP Addressing Services
ipv6 nd resolution data limit
ipv6 nd resolution data limit
To configure the number of data packets queued pending Neighbor Discovery resolution, use the ipv6 nd
resolution data limit command in global configuration mode.
ipv6 nd resolution data limit number-of-packets
no ipv6 nd resolution data limit number-of-packets
Syntax Description number-of-packets The number of queued data packets. The range is from 16 to 2048 packets.
Command Default Queue limit is 16 packets.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 nd resolution data limit command allows the customer to configure the number of data packets
queued pending Neighbor Discovery resolution. IPv6 Neighbor Discovery queues a data packet that initiates
resolution for an unresolved destination. Neighbor Discovery will only queue one packet per destination.
Neighbor Discovery also enforces a global (per-router) limit on the number of packets queued. Once the global
queue limit is reached, further packets to unresolved destinations are discarded. The minimum (and default)
value is 16 packets, and the maximum value is 2048.
In most situations, the default value of 16 queued packets pending Neighbor Discovery resolution is sufficient.
However, in some high-scalability scenarios in which the router needs to initiate communication with a very
large number of neighbors almost simultaneously, then the value may be insufficient. This may lead to loss
of the initial packet sent to some neighbors. In most applications, the initial packet is retransmitted, so initial
packet loss generally is not a cause for concern. (Note that dropping the initial packet to an unresolved
destination is normal in IPv4.) However, there may be some high-scale configurations where loss of the initial
packet is inconvenient. In these cases, the customer can use the ipv6 nd resolution data limit command to
prevent the initial packet loss by increasing the unresolved packet queue size.
Examples The following example configures the global number of data packets held awaiting resolution to be
32:
(config)# ipv6 nd resolution data limit 32
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
549
IP Addressing Services
ipv6 nd route-owner
ipv6 nd route-owner
To insert Neighbor Discovery-learned routes into the routing table with "ND" status and to enable ND
autoconfiguration behavior, use the ipv6 nd route-owner command. To remove this information from the
routing table, use the no form of this command.
ipv6 ndroute-owner
Syntax Description This command has no arguments or keywords.
Command Default The status of Neighbor Discovery-learned routes is "Static."
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 nd route-owner command inserts routes learned by Neighbor Discovery into the routing table with
a status of "ND" rather than "Static" or "Connected."
This global command also enables you to use the ipv6 nd autoconfig default or ipv6 nd autoconfig prefix
commands in interface configuration mode. If the ipv6 nd route-owner command is not issued, then the
ipv6 nd autoconfig default and ipv6 nd autoconfig prefix commands are accepted by the router but will
not work.
Examples (config)# ipv6 nd route-owner
Related Commands Command Description
ipv6 nd autoconfig default Allows Neighbor Discovery to install a default route to the Neighbor
Discovery-derived default router.
ipv6 nd autoconfig prefix Uses Neighbor Discovery to install all valid on-link prefixes from RAs received
on the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
550
IP Addressing Services
ipv6 neighbor
ipv6 neighbor
To configure a static entry in the IPv6 neighbor discovery cache, use the ipv6 neighbor command in global
configuration mode. To remove a static IPv6 entry from the IPv6 neighbor discovery cache, use the no form
of this command.
ipv6 neighbor ipv6-address interface-type interface-number hardware-address
no ipv6 neighbor ipv6-address interface-type interface-number
Syntax Description ipv6-address The IPv6 address that corresponds to the local data-link address.
This argument must be in the form documented in RFC 2373 where the address is
specified in hexadecimal using 16-bit values between colons.
interface-type The specified interface type. For supported interface types, use the question mark (?)
online help function.
interface-number The specified interface number.
hardware-address The local data-link address (a 48-bit address).
Command Default Static entries are not configured in the IPv6 neighbor discovery cache.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 neighbor command is similar to the arp (global) command.
If an entry for the specified IPv6 address already exists in the neighbor discovery cache--learned through the
IPv6 neighbor discovery process--the entry is automatically converted to a static entry.
Use the show ipv6 neighbors command to view static entries in the IPv6 neighbor discovery cache. A static
entry in the IPv6 neighbor discovery cache can have one of the following states:
• INCMP (Incomplete)--The interface for this entry is down.
• REACH (Reachable)--The interface for this entry is up.
Note Reachability detection is not applied to static entries in the IPv6 neighbor discovery cache; therefore, the
descriptions for the INCMP and REACH states are different for dynamic and static cache entries. See the
show ipv6 neighbors command for descriptions of the INCMP and REACH states for dynamic cache entries.
The clear ipv6 neighbors command deletes all entries in the IPv6 neighbor discovery cache, except static
entries. The no ipv6 neighbor command deletes a specified static entry from the neighbor discovery cache;
the command does not remove dynamic entries--learned from the IPv6 neighbor discovery process--from the
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
551
IP Addressing Services
ipv6 neighbor
cache. Disabling IPv6 on an interface by using the no ipv6 enable command or the no ipv6 unnumbered
command deletes all IPv6 neighbor discovery cache entries configured for that interface, except static entries
(the state of the entry changes to INCMP).
Static entries in the IPv6 neighbor discovery cache are not modified by the neighbor discovery process.
Note Static entries for IPv6 neighbors can be configured only on IPv6-enabled LAN and ATM LAN Emulation
interfaces.
Examples The following example configures a static entry in the IPv6 neighbor discovery cache for a neighbor
with the IPv6 address 2001:0DB8::45A and link-layer address 0002.7D1A.9472 on Ethernet interface
1:
(config)# ipv6 neighbor 2001:0DB8::45A ethernet1 0002.7D1A.9472
Related Commands Command Description
arp (global) Adds a permanent entry in the ARP cache.
clear ipv6 neighbors Deletes all entries in the IPv6 neighbor discovery cache, except static entries.
no ipv6 enable Disables IPv6 processing on an interface that has not been configured with an
explicit IPv6 address.
no ipv6 unnumbered Disables IPv6 on an unnumbered interface.
show ipv6 neighbors Displays IPv6 neighbor discovery cache information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
552
IP Addressing Services
ipv6 ospf name-lookup
ipv6 ospf name-lookup
To display Open Shortest Path First (OSPF) router IDs as Domain Naming System (DNS) names, use the
ipv6 ospf name-lookup command in global configuration mode. To stop displaying OSPF router IDs as DNS
names, use the no form of this command.
ipv6 ospf name-lookup
no ipv6 ospf name-lookup
Syntax Description This command has no arguments or keywords.
Command Default This command is disabled by default
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command makes it easier to identify a router because the router is displayed by name rather than by its
router ID or neighbor ID.
Examples The following example configures OSPF to look up DNS names for use in all OSPF show EXEC
command displays:
(config)# ipv6 ospf name-lookup
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
553
IP Addressing Services
ipv6 pim
ipv6 pim
To reenable IPv6 Protocol Independent Multicast (PIM) on a specified interface, use the ipv6 pim command
in interface configuration mode. To disable PIM on a specified interface, use the no form of the command.
ipv6 pim
no ipv6 pim
Syntax Description This command has no arguments or keywords.
Command Default PIM is automatically enabled on every interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines After a user has enabled the ipv6 multicast-routing command, PIM is enabled to run on every interface.
Because PIM is enabled on every interface by default, use the no form of the ipv6 pim command to disable
PIM on a specified interface. When PIM is disabled on an interface, it does not react to any host membership
notifications from the Multicast Listener Discovery (MLD) protocol.
Examples The following example turns off PIM on Fast Ethernet interface 1/0:
(config)# interface FastEthernet 1/0
(config-if)# no ipv6 pim
Related Commands Command Description
ipv6 multicast-routing Enables multicast routing using PIM and MLD on all IPv6-enabled interfaces of
the router and enables multicast forwarding.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
554
IP Addressing Services
ipv6 pim accept-register
ipv6 pim accept-register
To accept or reject registers at the rendezvous point (RP), use the ipv6 pim accept-register command in
global configuration mode. To return to the default value, use the no form of this command.
ipv6 pim [vrf vrf-name] accept-register {list access-list | route-map map-name}
no ipv6 pim [vrf vrf-name] accept-register {list access-list | route-map map-name}
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
list access-list Defines the access list name.
route-map map-name Defines the route map.
Command Default All sources are accepted at the RP.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ipv6 pim accept-register command to configure a named access list or route map with match attributes.
When the permit conditions as defined by the access-list and map-name arguments are met, the register
message is accepted. Otherwise, the register message is not accepted, and an immediate register-stop message
is returned to the encapsulating designated router.
Examples The following example shows how to filter on all sources that do not have a local multicast Border
Gateway Protocol (BGP) prefix:
ipv6 pim accept-register route-map reg-filter
route-map reg-filter permit 20
match as-path 101
ip as-path access-list 101 permit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
555
IP Addressing Services
ipv6 pim allow-rp
ipv6 pim allow-rp
To enable the PIM Allow RP feature for all IP multicast-enabled interfaces in an IPv6 device, use the ip pim
allow-rp command in global configuration mode. To return to the default value, use the no form of this
command.
ipv6 pim allow-rp [{group-list access-list | rp-list access-list [group-list access-list]}]
no ipv6 pim allow-rp
Syntax Description group-list (Optional) Identifies an access control list (ACL) of allowed group ranges for PIM Allow RP.
rp-list (Optional) Specifies an ACL for allowed rendezvous-point (RP) addresses for PIM Allow RP.
access-list (Optional) Unique number or name of a standard ACL.
Command Default PIM Allow RP is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to enable the receiving device in an IP multicast network to accept a (*, G) Join from an
unexpected (different) RP address.
Before enabling PIM Allow RP, you must first use the ipv6 pim rp-address command to define an RP.
Related Commands Command Description
ipv6 pim rp-address Statically configures the address of a PIM RP for multicast groups.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
556
IP Addressing Services
ipv6 pim neighbor-filter list
ipv6 pim neighbor-filter list
To filter Protocol Independent Multicast (PIM) neighbor messages from specific IPv6 addresses, use the ipv6
pim neighbor-filter command in the global configuration mode. To return to the router default, use the no
form of this command.
ipv6 pim [vrf vrf-name] neighbor-filter list access-list
no ipv6 pim [vrf vrf-name] neighbor-filter list access-list
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
access-list Name of an IPv6 access list that denies PIM hello packets from a source.
Command Default PIM neighbor messages are not filtered.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ipv6 pim neighbor-filter list command is used to prevent unauthorized routers on the LAN from becoming
PIM neighbors. Hello messages from addresses specified in this command are ignored.
Examples The following example causes PIM to ignore all hello messages from IPv6 address
FE80::A8BB:CCFF:FE03:7200:
(config)# ipv6 pim neighbor-filter list nbr_filter_acl
(config)# ipv6 access-list nbr_filter_acl
(config-ipv6-acl)# deny ipv6 host FE80::A8BB:CCFF:FE03:7200 any
(config-ipv6-acl)# permit any any
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
557
IP Addressing Services
ipv6 pim rp-address
ipv6 pim rp-address
To configure the address of a Protocol Independent Multicast (PIM) rendezvous point (RP) for a particular
group range, use the ipv6 pim rp-address command in global configuration mode. To remove an RP address,
use the no form of this command.
ipv6 pim [vrf vrf-name] rp-address ipv6-address [group-access-list] [bidir]
no ipv6 pim rp-address ipv6-address [group-access-list] [bidir]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
ipv6-address The IPv6 address of a router to be a PIM RP.
The ipv6-addressargument must be in the form documented in RFC 2373 where the
address is specified in hexadecimal using 16-bit values between colons.
group-access-list (Optional) Name of an access list that defines for which multicast groups the RP should
be used.
If the access list contains any group address ranges that overlap the assigned
source-specific multicast (SSM) group address range (FF3x::/96), a warning message is
displayed, and the overlapping ranges are ignored. If no access list is specified, the
specified RP is used for all valid multicast non-SSM address ranges.
To support embedded RP, the router configured as the RP must use a configured access
list that permits the embedded RP group ranges derived from the embedded RP address.
Note that the embedded RP group ranges need not include all the scopes (for example,
3 through 7).
bidir (Optional) Indicates that the group range will be used for bidirectional shared-tree
forwarding; otherwise, it will be used for sparse-mode forwarding. A single IPv6 address
can be configured to be RP only for either bidirectional or sparse-mode group ranges.
A single group-range list can be configured to operate either in bidirectional or sparse
mode.
Command Default No PIM RPs are preconfigured. Embedded RP support is enabled by default when IPv6 PIM is enabled (where
embedded RP support is provided). Multicast groups operate in PIM sparse mode.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When PIM is configured in sparse mode, you must choose one or more routers to operate as the RP. An RP
is a single common root of a shared distribution tree and is statically configured on each router.
Where embedded RP support is available, only the RP needs to be statically configured as the RP for the
embedded RP ranges. No additional configuration is needed on other IPv6 PIM routers. The other routers will
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
558
IP Addressing Services
ipv6 pim rp-address
discover the RP address from the IPv6 group address. If these routers want to select a static RP instead of the
embedded RP, the specific embedded RP group range must be configured in the access list of the static RP.
The RP address is used by first-hop routers to send register packets on behalf of source multicast hosts. The
RP address is also used by routers on behalf of multicast hosts that want to become members of a group. These
routers send join and prune messages to the RP.
If the optional group-access-list argument is not specified, the RP is applied to the entire routable IPv6 multicast
group range, excluding SSM, which ranges from FFX[3-f]::/8 to FF3X::/96. If the group-access-list argument
is specified, the IPv6 address is the RP address for the group range specified in the group-access-list argument.
You can configure Cisco IOS software to use a single RP for more than one group. The conditions specified
by the access list determine which groups the RP can be used for. If no access list is configured, the RP is
used for all groups.
A PIM router can use multiple RPs, but only one per group.
Examples The following example shows how to set the PIM RP address to 2001::10:10 for all multicast groups:
(config)# ipv6 pim rp-address 2001::10:10
The following example sets the PIM RP address to 2001::10:10 for the multicast group FF04::/64
only:
(config)# ipv6 access-list acc-grp-1
(config-ipv6-acl)# permit ipv6 any ff04::/64
(config)# ipv6 pim rp-address 2001::10:10 acc-grp-1
The following example shows how to configure a group access list that permits the embedded RP
ranges derived from the IPv6 RP address 2001:0DB8:2::2:
(config)# ipv6 pim rp-address 2001:0DB8:2::2 embd-ranges
(config)# ipv6 access-list embd-ranges
(config-ipv6-acl)# permit ipv6 any ff73:240:2:2:2::/96
(config-ipv6-acl)# permit ipv6 any ff74:240:2:2:2::/96
(config-ipv6-acl)# permit ipv6 any ff75:240:2:2:2::/96
(config-ipv6-acl)# permit ipv6 any ff76:240:2:2:2::/96
(config-ipv6-acl)# permit ipv6 any ff77:240:2:2:2::/96
(config-ipv6-acl)# permit ipv6 any ff78:240:2:2:2::/96
The following example shows how to enable the address 100::1 as the bidirectional RP for the entries
multicast range FF::/8:
ipv6 pim rp-address 100::1 bidir
In the following example, the IPv6 address 200::1 is enabled as the bidirectional RP for the ranges
permitted by the access list named bidir-grps. The ranges permitted by this list are ff05::/16 and
ff06::/16.
(config)# ipv6 access-list bidir-grps
(config-ipv6-acl)# permit ipv6 any ff05::/16
(config-ipv6-acl)# permit ipv6 any ff06::/16
(config-ipv6-acl)# exit
(config)# ipv6 pim rp-address 200::1 bidir-grps bidir
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
559
IP Addressing Services
ipv6 pim rp-address
Related Commands Command Description
debug ipv6 pim df-election Displays debug messages for PIM bidirectional DF-election message
processing.
ipv6 access-list Defines an IPv6 access list and places the router in IPv6 access list
configuration mode.
show ipv6 pim df Displays the DF -election state of each interface for each RP.
show ipv6 pim df winner Displays the DF-election winner on each interface for each RP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
560
IP Addressing Services
ipv6 pim rp embedded
ipv6 pim rp embedded
To enable embedded rendezvous point (RP) support in IPv6 Protocol Independent Multicast (PIM), use the
ipv6 pim rp-embedded command in global configuration mode. To disable embedded RP support, use the
no form of this command.
ipv6 pim [vrf vrf-name] rp embedded
no ipv6 pim [vrf vrf-name] rp embedded
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Default Embedded RP support is enabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Because embedded RP support is enabled by default, users will generally use the no form of this command
to turn off embedded RP support.
The ipv6 pim rp embedded command applies only to the embedded RP group ranges ff7X::/16 and fffX::/16.
When the router is enabled, it parses groups in the embedded RP group ranges ff7X::/16 and fffX::/16, and
extracts the RP to be used from the group address.
Examples The following example disables embedded RP support in IPv6 PIM:
# no ipv6 pim rp embedded
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
561
IP Addressing Services
ipv6 pim spt-threshold infinity
ipv6 pim spt-threshold infinity
To configure when a Protocol Independent Multicast (PIM) leaf router joins the shortest path tree (SPT) for
the specified groups, use the ipv6 pim spt-threshold infinity command in global configuration mode. To
restore the default value, use the no form of this command.
ipv6 pim [vrf vrf-name] spt-threshold infinity [group-list access-list-name]
no ipv6 pim spt-threshold infinity
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
group-list access-list-name (Optional) Indicates to which groups the threshold applies. Must be a standard
IPv6 access list name. If the value is omitted, the threshold applies to all
groups.
Command Default When this command is not used, the PIM leaf router joins the SPT immediately after the first packet arrives
from a new source. Once the router has joined the SPT, configuring the ipv6 pim spt-threshold infinity
command will not cause it to switch to the shared tree.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Using the ipv6 pim spt-threshold infinitycommand enables all sources for the specified groups to use the
shared tree. The group-list keyword indicates to which groups the SPT threshold applies.
The access-list-nameargument refers to an IPv6 access list. When the access-list-nameargument is specified
with a value of 0, or the group-list keyword is not used, the SPT threshold applies to all groups. The default
setting (that is, when this command is not enabled) is to join the SPT immediately after the first packet arrives
from a new source.
Examples The following example configures a PIM last-hop router to stay on the shared tree and not switch to
the SPT for the group range ff04::/64.:
(config)# ipv6 access-list acc-grp-1
(config-ipv6-acl)# permit ipv6 any FF04::/64
(config-ipv6-acl)# exit
(config)# ipv6 pim spt-threshold infinity group-list acc-grp-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
562
IP Addressing Services
ipv6 prefix-list
ipv6 prefix-list
To create an entry in an IPv6 prefix list, use the ipv6 prefix-list command in global configuration mode. To
delete the entry, use the no form of this command.
ipv6 prefix-list list-name [seq seq-number] {deny ipv6-prefix/prefix-length | permit
ipv6-prefix/prefix-length | description text} [ge ge-value] [le le-value]
no ipv6 prefix-list list-name
Syntax Description list-name Name of the prefix list.
• Cannot be the same name as an existing access list.
• Cannot be the name “detail” or “summary” because they are keywords in the show
ipv6 prefix-list command.
seq seq-number (Optional) Sequence number of the prefix list entry being configured.
deny Denies networks that matches the condition.
permit Permits networks that matches the condition.
ipv6-prefix The IPv6 network assigned to the specified prefix list.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
/prefix-length The length of the IPv6 prefix. A decimal value that indicates how many of the high-order
contiguous bits of the address comprise the prefix (the network portion of the address). A
slash mark must precede the decimal value.
description A description of the prefix list that can be up to 80 characters in length.
text
ge ge-value (Optional) Specifies a prefix length greater than or equal to the ipv6-prefix/prefix-length
arguments. It is the lowest value of a range of the length (the “from” portion of the length
range).
le le-value (Optional) Specifies a prefix length less than or equal to the ipv6-prefix /prefix-length
arguments. It is the highest value of a range of the length (the “to” portion of the length
range).
Command Default No prefix list is created.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
563
IP Addressing Services
ipv6 prefix-list
Usage Guidelines The ipv6 prefix-list command is similar to the ip prefix-list command, except that it is IPv6-specific.
To suppress networks from being advertised in updates, use the distribute-list out command.
The sequence number of a prefix list entry determines the order of the entries in the list. The router compares
network addresses to the prefix list entries. The router begins the comparison at the top of the prefix list, with
the entry having the lowest sequence number.
If multiple entries of a prefix list match a prefix, the entry with the lowest sequence number is considered the
real match. Once a match or deny occurs, the router does not go through the rest of the prefix list. For efficiency,
you may want to put the most common permits or denies near the top of the list, using the seq-number argument.
The show ipv6 prefix-list command displays the sequence numbers of entries.
IPv6 prefix lists are used to specify certain prefixes or a range of prefixes that must be matched before a permit
or deny statement can be applied. Two operand keywords can be used to designate a range of prefix lengths
to be matched. A prefix length of less than, or equal to, a value is configured with the le keyword. A prefix
length greater than, or equal to, a value is specified using the ge keyword. The ge and le keywords can be
used to specify the range of the prefix length to be matched in more detail than the usual
ipv6-prefix/prefix-length argument. For a candidate prefix to match against a prefix list entry three conditions
can exist:
• The candidate prefix must match the specified prefix list and prefix length entry.
• The value of the optional le keyword specifies the range of allowed prefix lengths from the prefix-length
argument up to, and including, the value of the le keyword.
• The value of the optional ge keyword specifies the range of allowed prefix lengths from the value of the
ge keyword up to, and including, 128.
Note The first condition must match before the other conditions take effect.
An exact match is assumed when the ge or le keywords are not specified. If only one keyword operand is
specified then the condition for that keyword is applied, and the other condition is not applied. The prefix-length
value must be less than the ge value. The ge value must be less than, or equal to, the le value. The le value
must be less than or equal to 128.
Every IPv6 prefix list, including prefix lists that do not have any permit and deny condition statements, has
an implicit deny any any statement as its last match condition.
Examples The following example denies all routes with a prefix of ::/0.
(config)# ipv6 prefix-list abc deny ::/0
The following example permits the prefix 2002::/16:
(config)# ipv6 prefix-list abc permit 2002::/16
The following example shows how to specify a group of prefixes to accept any prefixes from prefix
5F00::/48 up to and including prefix 5F00::/64.
(config)# ipv6 prefix-list abc permit 5F00::/48 le 64
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
564
IP Addressing Services
ipv6 prefix-list
The following example denies prefix lengths greater than 64 bits in routes that have the prefix
2001:0DB8::/64.
(config)# ipv6 prefix-list abc permit 2001:0DB8::/64 le 128
The following example permits mask lengths from 32 to 64 bits in all address space.
(config)# ipv6 prefix-list abc permit ::/0 ge 32 le 64
The following example denies mask lengths greater than 32 bits in all address space.
(config)# ipv6 prefix-list abc deny ::/0 ge 32
The following example denies all routes with a prefix of 2002::/128.
(config)# ipv6 prefix-list abc deny 2002::/128
The following example permits all routes with a prefix of ::/0.
(config)# ipv6 prefix-list abc permit ::/0
Related Commands Command Description
clear ipv6 prefix-list Resets the hit count of the IPv6 prefix list entries.
distribute-list out Suppresses networks from being advertised in updates.
ipv6 prefix-list sequence-number Enables the generation of sequence numbers for entries in an IPv6 prefix
list.
match ipv6 address Distributes IPv6 routes that have a prefix permitted by a prefix list.
show ipv6 prefix-list Displays information about an IPv6 prefix list or IPv6 prefix list entries.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
565
IP Addressing Services
ipv6 source-guard attach-policy
ipv6 source-guard attach-policy
To apply IPv6 source guard policy on an interface, use the ipv6 source-guard attach-policy in interface
configuration mode. To remove this source guard from the interface, use the no form of this command.
ipv6 source-guard attach-policy[source-guard-policy ]
Syntax Description source-guard-policy (Optional) User-defined name of the source guard policy. The policy name can be a
symbolic string (such as Engineering) or an integer (such as 0).
Command Default An IPv6 source-guard policy is not applied on the interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If no policy is specified using the source-guard-policy argument, then the default source-guard policy is
applied.
A dependency exists between IPv6 source guard and IPv6 snooping. Whenever IPv6 source guard is configured,
when the ipv6 source-guard attach-policy command is entered, it verifies that snooping is enabled and issues
a warning if it is not. If IPv6 snooping is disabled, the software checks if IPv6 source guard is enabled and
sends a warning if it is.
Examples The following example shows how to apply IPv6 source guard on an interface:
(config)# interface gigabitethernet 0/0/1
(config-if)# ipv6 source-guard attach-policy mysnoopingpolicy
Related Commands Command Description
ipv6 snooping policy Configures an IPv6 snooping policy and enters IPv6 snooping configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
566
IP Addressing Services
ipv6 source-route
ipv6 source-route
To enable processing of the IPv6 type 0 routing header (the IPv6 source routing header), use the ipv6
source-route command in global configuration mode. To disable the processing of this IPv6 extension header,
use the no form of this command.
ipv6 source-route
no ipv6 source-route
Syntax Description This command has no arguments or keywords.
Command Default The no version of the ipv6 source-route command is the default. When the router receives a packet with a
type 0 routing header, the router drops the packet and sends an IPv6 Internet Control Message Protocol (ICMP)
error message back to the source and logs an appropriate debug message.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The default was changed to be the no version of the ipv6 source-route command, which means this
functionality is not enabled. Before this change, this functionality was enabled automatically. User who had
configured the no ipv6 source-route command before the default was changed will continue to see this
configuration in their show config command output, even though the no version of the command is the default.
The no ipv6 source-route command (which is the default) prevents hosts from performing source routing
using your routers. When the no ipv6 source-route command is configured and the router receives a packet
with a type0 source routing header, the router drops the packet and sends an IPv6 ICMP error message back
to the source and logs an appropriate debug message.
In IPv6, source routing is performed only by the destination of the packet. Therefore, in order to stop source
routing from occurring inside your network, you need to configure an IPv6 access control list (ACL) that
includes the following rule:
deny ipv6 any any routing
The rate at which the router generates all IPv6 ICMP error messages can be limited by using the ipv6 icmp
error-intervalcommand.
Examples The following example disables the processing of IPv6 type 0 routing headers:
no ipv6 source-route
Related Commands Command Description
deny (IPv6) Sets deny conditions for an IPv6 access list.
ipv6 icmp error-interval Configures the interval for IPv6 ICMP error messages.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
567
IP Addressing Services
ipv6 spd mode
ipv6 spd mode
To configure an IPv6 Selective Packet Discard (SPD) mode, use the ipv6 spd mode command in global
configuration mode. To remove the IPv6 SPD mode, use the no form of this command.
ipv6 spd mode {aggressive | tos protocol ospf}
no ipv6 spd mode {aggressive | tos protocol ospf}
Syntax Description aggressive Aggressive drop mode discards incorrectly formatted packets when the IPv6 SPD is
in random drop state.
tos protocol o spf OSPF mode allows OSPF packets to be handled with SPD priority.
Command Default No IPv6 SPD mode is configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The default setting for the IPv6 SPD mode is none, but you may want to use the ipv6 spd mode command to
configure a mode to be used when a certain SPD state is reached.
The aggressive keyword enables aggressive drop mode, which drops deformed packets when IPv6 SPD is in
random drop state. The ospf keyword enables OSPF mode, in which OSPF packets are handled with SPD
priority.
The size of the process input queue governs the SPD state: normal (no drop), random drop, or max. When the
process input queue is less than the SPD minimum threshold, SPD takes no action and enters normal state.
In the normal state, no packets are dropped. When the input queue reaches the maximum threshold, SPD
enters max state, in which normal priority packets are discarded. If the input queue is between the minimum
and maximum thresholds, SPD enters the random drop state, in which normal packets may be dropped.
Examples The following example shows how to enable the router to drop deformed packets when the router is
in the random drop state:
(config)# ipv6 spf mode aggressive
Related Commands Command Description
ipv6 spd queue max-threshold Configures the maximum number of packets in the IPv6 SPD process
input queue.
ipv6 spd queue min-threshold Configures the minimum number of packets in the IPv6 SPD process
input queue.
show ipv6 spd Displays the IPv6 SPD configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
568
IP Addressing Services
ipv6 spd queue max-threshold
ipv6 spd queue max-threshold
To configure the maximum number of packets in the IPv6 Selective Packet Discard (SPD) process input
queue, use the ipv6 spd queue max-threshold command in global configuration mode. To return to the
default value, use the no form of this command.
ipv6 spd queue max-threshold value
no ipv6 spd queue max-threshold
Syntax Description value Number of packets. The range is from 0 through 65535.
Command Default No SPD queue maximum threshold value is configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the ipv6 spd queue max-threshold command to configure the SPD queue maximum threshold value.
The size of the process input queue governs the SPD state: normal (no drop), random drop, or max. When the
process input queue is less than the SPD minimum threshold, SPD takes no action and enters normal state.
In the normal state, no packets are dropped. When the input queue reaches the maximum threshold, SPD
enters max state, in which normal priority packets are discarded. If the input queue is between the minimum
and maximum thresholds, SPD enters the random drop state, in which normal packets may be dropped.
Examples The following example shows how to set the maximum threshold value of the queue to 60,000:
(config)# ipv6 spd queue max-threshold 60000
Related Commands Command Description
ipv6 spd queue min-threshold Configures the minimum number of packets in the IPv6 SPD process
input queue.
show ipv6 spd Displays the IPv6 SPD configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
569
IP Addressing Services
ipv6 traffic interface-statistics
ipv6 traffic interface-statistics
To collect IPv6 forwarding statistics for all interfaces, use the ipv6 traffic interface-statistics command in
global configuration mode. To ensure that IPv6 forwarding statistics are not collected for any interface, use
the no form of this command.
ipv6 traffic interface-statistics [unclearable]
no ipv6 traffic interface-statistics [unclearable]
Syntax Description unclearable (Optional) IPv6 forwarding statistics are kept for all interfaces, but it is not possible to clear
the statistics on any interface.
Command Default IPv6 forwarding statistics are collected for all interfaces.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Using the optional unclearable keyword halves the per-interface statistics storage requirements.
Examples The following example does not allow statistics to be cleared on any interface:
(config)# ipv6 traffic interface-statistics unclearable
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
570
IP Addressing Services
ipv6 unicast-routing
ipv6 unicast-routing
To enable the forwarding of IPv6 unicast datagrams, use the ipv6 unicast-routing command in global
configuration mode. To disable the forwarding of IPv6 unicast datagrams, use the no form of this command.
ipv6 unicast-routing
no ipv6 unicast-routing
Syntax Description This command has no arguments or keywords.
Command Default IPv6 unicast routing is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Configuring the no ipv6 unicast-routing command removes all IPv6 routing protocol entries from the IPv6
routing table.
Examples The following example enables the forwarding of IPv6 unicast datagrams:
(config)# ipv6 unicast-routing
Related Commands Command Description
ipv6 address link-local Configures an IPv6 link-local address for an interface and enables IPv6 processing
on the interface.
ipv6 address eui-64 Configures an IPv6 address and enables IPv6 processing on an interface using an
EUI-64 interface ID in the low-order 64 bits of the address.
ipv6 enable Enables IPv6 processing on an interface that has not been configured with an
explicit IPv6 address.
ipv6 unnumbered Enables IPv6 processing on an interface without assigning an explicit IPv6 address
to the interface.
show ipv6 route Displays the current contents of the IPv6 routing table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
571
IP Addressing Services
key chain
key chain
To define an authentication key chain needed to enable authentication for routing protocols and enter key-chain
configuration mode, use the key chain command in global configuration mode. To remove the key chain, use
the no form of this command.
key chain name-of-chain
no key chain name-of-chain
Syntax Description name-of-chain Name of a key chain. A key chain must have at least one key and can have up to 2147483647
keys.
Command Default No key chain exists.
Command Modes Global configuration (config)
Usage Guidelines You must configure a key chain with keys to enable authentication.
Although you can identify multiple key chains, we recommend using one key chain per interface per routing
protocol. Upon specifying the key chain command, you enter key chain configuration mode.
Examples The following example shows how to specify key chain:
Device(config-keychain-key)# key-string chestnut
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key chain is
received as valid.
key Identifies an authentication key on a key chain.
key-string (authentication) Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain is
valid to be sent.
show key chain Displays authentication key information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
572
IP Addressing Services
key-string (authentication)
key-string (authentication)
To specify the authentication string for a key, use the key-string(authentication) command in key chain key
configuration mode. To remove the authentication string, use the no form of this command.
key-string key-string text
no key-string text
Syntax Description text Authentication string that must be sent and received in the packets using the routing protocol being
authenticated. The string can contain from 1 to 80 uppercase and lowercase alphanumeric characters.
Command Default No authentication string for a key exists.
Command Modes Key chain key configuration (config-keychain-key)
Examples The following example shows how to specify the authentication string for a key:
Device(config-keychain-key)# key-string key1
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key chain is received as
valid.
key Identifies an authentication key on a key chain.
key chain Defines an authentication key-chain needed to enable authentication for routing protocols.
send-lifetime Sets the time period during which an authentication key on a key chain is valid to be sent.
show key chain Displays authentication key information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
573
IP Addressing Services
key
key
To identify an authentication key on a key chain, use the key command in key-chain configuration mode. To
remove the key from the key chain, use the no form of this command.
key key-id
no key key-id
Syntax Description key-id Identification number of an authentication key on a key chain. The range of keys is from 0 to
2147483647. The key identification numbers need not be consecutive.
Command Default No key exists on the key chain.
Command Modes Key-chain configuration (config-keychain)
Usage Guidelines It is useful to have multiple keys on a key chain so that the software can sequence through the keys as they
become invalid after time, based on the accept-lifetime and send-lifetime key chain key command settings.
Each key has its own key identifier, which is stored locally. The combination of the key identifier and the
interface associated with the message uniquely identifies the authentication algorithm and Message Digest 5
(MD5) authentication key in use. Only one authentication packet is sent, regardless of the number of valid
keys. The software starts looking at the lowest key identifier number and uses the first valid key.
If the last key expires, authentication will continue and an error message will be generated. To disable
authentication, you must manually delete the last valid key.
To remove all keys, remove the key chain by using the no key chain command.
Examples The following example shows how to specify a key to identify authentication on a key-chain:
Device(config-keychain)# key 1
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key chain is
received as valid.
key chain Defines an authentication key chain needed to enable authentication for
routing protocols.
key-string (authentication) Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain is
valid to be sent.
show key chain Displays authentication key information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
574
IP Addressing Services
show ip nat translations
show ip nat translations
To display active Network Address Translation ( NAT) translations, use the show ip nat translations command
in EXEC mode.
show ip nat translations [ inside global-ip ] [ outside local-ip ] [icmp] [tcp] [udp]
[verbose] [ vrf vrf-name ]
Syntax Description icmp (Optional) Displays Internet Control Message Protocol (ICMP) entries.
inside global-ip (Optional) Displays entries for only a specific inside global IP address.
outside local-ip (Optional) Displays entries for only a specific outside local IP address.
tcp (Optional) Displays TCP protocol entries.
udp (Optional) Displays User Datagram Protocol (UDP) entries.
verbose (Optional) Displays additional information for each translation table entry, including
how long ago the entry was created and used.
vrf vrf-name (Optional) Displays VPN routing and forwarding (VRF) traffic-related information.
Command Modes EXEC
Command History
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was
introduced.
Examples The following is sample output from the show ip nat translations command. Without overloading,
two inside hosts are exchanging packets with some number of outside hosts.
Router# show ip nat translations
Pro Inside global Inside local Outside local Outside global
--- 10.69.233.209 192.168.1.95 --- ---
--- 10.69.233.210 192.168.1.89 --- --
With overloading, a translation for a Domain Name Server (DNS) transaction is still active, and
translations for two Telnet sessions (from two different hosts) are also active. Note that two different
inside hosts appear on the outside with a single IP address.
Router# show ip nat translations
Pro Inside global Inside local Outside local Outside global
udp 10.69.233.209:1220 192.168.1.95:1220 172.16.2.132:53 172.16.2.132:53
tcp 10.69.233.209:11012 192.168.1.89:11012 172.16.1.220:23 172.16.1.220:23
tcp 10.69.233.209:1067 192.168.1.95:1067 172.16.1.161:23 172.16.1.161:23
The following is sample output that includes the verbose keyword:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
575
IP Addressing Services
show ip nat translations
Router# show ip nat translations verbose
Pro Inside global Inside local Outside local Outside global
udp 172.16.233.209:1220 192.168.1.95:1220 172.16.2.132:53 172.16.2.132:53
create 00:00:02, use 00:00:00, flags: extended
tcp 172.16.233.209:11012 192.168.1.89:11012 172.16.1.220:23 172.16.1.220:23
create 00:01:13, use 00:00:50, flags: extended
tcp 172.16.233.209:1067 192.168.1.95:1067 172.16.1.161:23 172.16.1.161:23
create 00:00:02, use 00:00:00, flags: extended
The following is sample output that includes the vrf keyword:
Router# show ip nat translations vrf
abc
Pro Inside global Inside local Outside local Outside global
--- 10.2.2.1 192.168.121.113 --- ---
--- 10.2.2.2 192.168.122.49 --- ---
--- 10.2.2.11 192.168.11.1 --- ---
--- 10.2.2.12 192.168.11.3 --- ---
--- 10.2.2.13 172.16.5.20 --- ---
Pro Inside global Inside local Outside local Outside global
--- 10.2.2.3 192.168.121.113 --- ---
--- 10.2.2.4 192.168.22.49 --- ---
The following is sample output that includes the insidekeyword:
Router# show ip nat translations inside 10.69.233.209
Pro Inside global Inside local Outside local Outside global
udp 10.69.233.209:1220 192.168.1.95:1220 172.16.2.132:53 172.16.2.132:53
The following is sample output when NAT that includes the insidekeyword:
Router# show ip nat translations inside 10.69.233.209
Pro Inside global Inside local Outside local Outside global
udp 10.69.233.209:1220 192.168.1.95:1220 172.16.2.132:53 172.16.2.132:53
The following is a sample output that displays information about NAT port parity and conservation:
Router# show ip nat translations
Pro Inside global Inside local Outside local Outside global
udp 200.200.0.100:5066 100.100.0.56:5066 200.200.0.56:5060 200.200.0.56:5060
udp 200.200.0.100:1025 100.100.0.57:10001 200.200.0.57:10001 200.200.0.57:10001
udp 200.200.0.100:10000 100.100.0.56:10000 200.200.0.56:10000 200.200.0.56:10000
udp 200.200.0.100:1024 100.100.0.57:10000 200.200.0.57:10000 200.200.0.57:10000
udp 200.200.0.100:10001 100.100.0.56:10001 200.200.0.56:10001 200.200.0.56:10001
udp 200.200.0.100:9985 100.100.0.57:5066 200.200.0.57:5060 200.200.0.57:5060
Total number of translations: 6
The table below describes the significant fields shown in the display.
Table 32: show ip nat translations Field Descriptions
Field Description
Pro Protocol of the port identifying the address.
Inside global The legitimate IP address that represents one or more inside local IP addresses to the outside
world.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
576
IP Addressing Services
show ip nat translations
Field Description
Inside local The IP address assigned to a host on the inside network; probably not a legitimate address
assigned by the Network Interface Card (NIC) or service provider.
Outside local IP address of an outside host as it appears to the inside network; probably not a legitimate
address assigned by the NIC or service provider.
Outside global The IP address assigned to a host on the outside network by its owner.
create How long ago the entry was created (in hours:minutes:seconds).
use How long ago the entry was last used (in hours:minutes:seconds).
flags Indication of the type of translation. Possible flags are:
• extended--Extended translation
• static--Static translation
• destination--Rotary translation
• outside--Outside translation
• timing out--Translation will no longer be used, due to a TCP finish (FIN) or reset (RST)
flag.
Related Commands Command Description
clear ip nat translation Clears dynamic NAT translations from the translation table.
ip nat Designates that traffic originating from or destined for the interface is subject
to NAT.
ip nat inside destination Enables NAT of the inside destination address.
ip nat inside source Enables NAT of the inside source address.
ip nat outside source Enables NAT of the outside source address.
ip nat pool Defines a pool of IP addresses for NAT.
ip nat service Enables a port other than the default port.
show ip nat statistics Displays NAT statistics.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
577
IP Addressing Services
show ip nhrp nhs
show ip nhrp nhs
To display Next Hop Resolution Protocol (NHRP) next hop server (NHS) information, use the show ip nhrp
nhscommand in user EXEC or privileged EXEC mode.
show ip nhrp nhs [{interface}] [detail] [{redundancy [{cluster number | preempted | running |
waiting}]}]
Syntax Description interface (Optional) Displays NHS information currently configured on the interface. See the table
below for types, number ranges, and descriptions.
detail (Optional) Displays detailed NHS information.
redundancy (Optional) Displays information about NHS redundancy stacks.
cluster number (Optional) Displays redundancy cluster information.
preempted (Optional) Displays information about NHS that failed to become active and is preempted.
running (Optional) Displays NHSs that are currently in Responding or Expecting replies states.
waiting (Optional) Displays NHSs awaiting to be scheduled.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The table below lists the valid types, number ranges, and descriptions for the optional interfaceargument.
Note The valid types can vary according to the platform and interfaces on the platform.
Table 33: Valid Types, Number Ranges, and Interface Descriptions
Valid Types Number Ranges Interface Descriptions
ANI 0 to 1000 Autonomic-Networking virtual interface
Auto-Template 1 to 999 Auto-Template interface
Capwap 0 to 2147483647 Control and Provisioning of Wireless Access
Points protocol (CAPWAP) tunnel interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
578
IP Addressing Services
show ip nhrp nhs
Valid Types Number Ranges Interface Descriptions
GMPLS 0 to 1000 Multiprotocol Label Switching (MPLS)
interface
GigabitEthernet 0 to 9 GigabitEthernet IEEE 802.3z
InternalInterface 0 to 9 Internal interface
LISP 0 to 65520 Locator/ID Separation Protocol (LISP) virtual
interface
loopback 0 to 2147483647 Loopback interface
Null 0 to 0 Null interface
PROTECTION_GROUP 0 to 0 Protection-group controller
Port-channel 1 to 128 Port channel interface
TenGigabitEthernet 0 to 9 TenGigabitEthernet interface
Tunnel 0 to 2147483647 Tunnel interface
Tunnel-tp 0 to 65535 MPLS Transport Profile interface
Vlan 1 to 4094 VLAN interface
Examples The following is sample output from the show ip nhrp nhs detail command:
Switch# show ip nhrp nhs detail
Legend:
E=Expecting replies
R=Responding
Tunnel1:
10.1.1.1 E req-sent 128 req-failed 1 repl-recv 0
Pending Registration Requests:
Registration Request: Reqid 1, Ret 64 NHS 10.1.1.1
The table below describes the significant field shown in the display.
Table 34: show ip nhrp nhs Field Descriptions
Field Description
Tunnel1 Interface through which the target network is reached.
Related Commands Command Description
ip nhrp map Statically configures the IP-to-NBMA address mapping of IP destinations connected to an
NBMA network.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
579
IP Addressing Services
show ip nhrp nhs
Command Description
show ip nhrp Displays NHRP mapping information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
580
IP Addressing Services
show ip ports all
show ip ports all
To display all the open ports on a device, use the show ip ports all in user EXEC or privileged EXEC mode.
show ip ports all
Syntax Description Syntax Description
This command has no arguments or keywords.
Command Default No default behavior or values.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines This command provides a list of all open TCP/IP ports on the system including the ports opened using Cisco
networking stack.
To close open ports, you can use one of the following methods:
• Use Access Control List (ACL).
• To close the UDP 2228 port, use the no l2 traceroute command.
• To close TCP 80, TCP 443, TCP 6970, TCP 8090 ports, use the no ip http server and no ip http
secure-server commands.
Examples The following is sample output from the show ip ports all command:
Device#
show ip ports all
Proto Local Address Foreign Address State PID/Program Name
TCB Local Address Foreign Address (state)
tcp *:4786 *:* LISTEN 224/[IOS]SMI IBC server process
tcp *:443 *:* LISTEN 286/[IOS]HTTP CORE
tcp *:443 *:* LISTEN 286/[IOS]HTTP CORE
tcp *:80 *:* LISTEN 286/[IOS]HTTP CORE
tcp *:80 *:* LISTEN 286/[IOS]HTTP CORE
udp *:10002 *:* 0/[IOS] Unknown
udp *:2228 10.0.0.0:0 318/[IOS]L2TRACE SERVER
The table below describes the significant fields shown in the display
Table 35: Field Descriptions of show ip ports all
Field Description
Protocol Transport protocol used.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
581
IP Addressing Services
show ip ports all
Field Description
Local Address. Device IP Address.
Foreign Address Remote or peer address.
State State of the connection. It can be listen, established
or connected.
PID/Program Name Process ID or name
Related Commands Command Description
show tcp brief all Displays information about TCP connection endpoints.
show ip sockets Displays IP sockets information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
582
IP Addressing Services
show ip wccp
show ip wccp
To display the IPv4 Web Cache Communication Protocol (WCCP) global configuration and statistics, use
the show ip wccp command in user EXEC or privileged EXEC mode.
show ip wccp [ all ] [capabilities] [summary] [ interfaces [{ cef | counts
| detail }] ] [ vrf vrf-name ] [ { web-cache service-number } [assignment] [clients]
[counters] [detail] [service] [view] ]
Syntax Description all (Optional) Displays statistics for all known services.
capabilities (Optional) Displays WCCP platform capabilities information.
summary (Optional) Displays a summary of WCCP services.
interfaces (Optional) Displays WCCP redirect interfaces.
cef (Optional) Displays Cisco Express Forwarding interface statistics, including the number
of input, output, dynamic, static, and multicast services.
counts (Optional) Displays WCCP interface count statistics, including the number of Cisco
Express Forwarding and process-switched output and input packets redirected.
detail (Optional) Displays WCCP interface configuration statistics, including the number of
input, output, dynamic, static, and multicast services.
vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) instance associated with a
service group to display.
web-cache (Optional) Displays statistics for the web cache service.
service-number (Optional) Identification number of the web cache service group being controlled by the
cache. The number can be from 0 to 254. For web caches using Cisco cache engines, the
reverse proxy service is indicated by a value of 99.
assignment (Optional) Displays service group assignment information.
clients (Optional) Displays detailed information about the clients of a service, including all
per-client information. No per-service information is displayed.
counters (Optional) Displays traffic counters.
detail (Optional) Displays detailed information about the clients of a service, including all
per-client information. No per-service information is displayed. Assignment information
is also displayed.
service (Optional) Displays detailed information about a service, including the service definition
and all other per-service information.
view (Optional) Displays other members of a particular service group, or all service groups,
that have or have not been detected.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
583
IP Addressing Services
show ip wccp
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 The vrf keyword and vrf-name argument pair were added.
Usage Guidelines Use the clear ip wccp command to reset all WCCP counters.
Use the show ip wccp service-number detail command to display information about the WCCP client timeout
interval and the redirect assignment timeout interval if those intervals are not set to their default value of 10
seconds.
Use the show ip wccp summary command to display the configured WCCP services and a summary of their
current state.
Examples This section contains examples and field descriptions for the following forms of this command:
• show ip wccp service-number (service mode displayed)
• show ip wccp service-number view
• show ip wccp service-number detail
• show ip wccp service-number clients
• show ip wccp interfaces
• show ip wccp web-cache
• show ip wccp web-cache counters
• show ip wccp web-cache detail
• show ip wccp web-cache detail (bypass counters displayed)
• show ip wccp web-cache clients
• show ip wccp web-cache service
• show ip wccp summary
show ip wccp service-number (Service Mode Displayed)
The following is sample output from the show ip wccp service-number command:
Device# show ip wccp 90
Global WCCP information:
Router information:
Router Identifier: 10.10.0.0
Service Identifier: 90
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
584
IP Addressing Services
show ip wccp
Protocol Version: 2.00
Number of Service Group Clients: 2
Number of Service Group Routers: 1
Total Packets Redirected: 0
Process: 0
CEF: 0
Service mode: Open
Service Access-list: -none-
Total Packets Dropped Closed: 0
Redirect access-list: -none-
Total Packets Denied Redirect: 0
Total Packets Unassigned: 0
Group access-list: -none-
Total Messages Denied to Group: 0
Total Authentication failures: 0
Total GRE Bypassed Packets Received: 0
Process: 0
CEF: 0
The table below describes the significant fields shown in the display.
Table 36: show ip wccp service-number Field Descriptions
Field Description
Router information A list of routers detected by the current router.
Protocol Version The version of WCCP being used by the router in the service group.
Service Identifier Indicates which service is detailed.
Number of Service Group Clients The number of clients that are visible to the router and other clients
in the service group.
Number of Service Group Routers The number of routers in the service group.
Total Packets Redirected Total number of packets redirected by the router.
Service mode Identifies the WCCP service mode. Options are Open or Closed.
Service Access-list A named extended IP access list that defines the packets that will
match the service.
Total Packets Dropped Closed Total number of packets that were dropped when WCCP is configured
for closed services and an intermediary device is not available to
process the service.
Redirect access-list The name or number of the access list that determines which packets
will be redirected.
Total Packets Denied Redirect Total number of packets that were not redirected because they did
not match the access list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
585
IP Addressing Services
show ip wccp
Field Description
Total Packets Unassigned Number of packets that were not redirected because they were not
assigned to any cache engine. Packets may not be assigned during
initial discovery of cache engines or when a cache is dropped from
a cluster.
Group access-list Indicates which cache engine is allowed to connect to the router.
Total Messages Denied to Group Indicates the number of packets denied by the group-list access list.
Total Authentication failures The number of instances where a password did not match.
Total GRE Bypassed Packets The number of generic routing encapsulation (GRE) packets that
Received have been bypassed. Process and Cisco Express Forwarding are
switching paths within Cisco IOS software.
show ip wccp service-number view
The following is sample output from the show ip wccp service-number view command for service
group 1:
Device# show ip wccp 90 view
WCCP Routers Informed of:
209.165.200.225
209.165.200.226
WCCP Clients Visible
209.165.200.227
209.165.200.228
WCCP Clients Not Visible:
-none-
Note The number of maximum service groups that can be configured is 256.
If any web cache is displayed under the WCCP Cache Engines Not Visible field, the router needs to
be reconfigured to map the web cache that is not visible to it.
The table below describes the significant fields shown in the display.
Table 37: show ip wccp service-number view Field Descriptions
Field Description
WCCP Router Informed of A list of routers detected by the current router.
WCCP Clients Visible A list of clients that are visible to the router and other clients in the service
group.
WCCP Clients Not Visible A list of clients in the service group that are not visible to the router and other
clients in the service group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
586
IP Addressing Services
show ip wccp
show ip wccp service-number detail
The following example displays WCCP client information and WCCP router statistics that include
the type of services:
Device# show ip wccp 91 detail
WCCP Client information:
WCCP Client ID: 209.165.200.226
Protocol Version: 2.0
State: Usable
Redirection: L2
Packet Return: L2
Assignment: MASK
Connect Time: 6d20h
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Mask Allotment: 32 of 64 (50.00%)
Assigned masks/values: 1/32
Mask SrcAddr DstAddr SrcPort DstPort
---- ------- ------- ------- -------
0000: 0x00000000 0x00001741 0x0000 0x0000
Value SrcAddr DstAddr SrcPort DstPort
----- ------- ------- ------- -------
0000: 0x00000000 0x00000001 0x0000 0x0000
0001: 0x00000000 0x00000041 0x0000 0x0000
0002: 0x00000000 0x00000101 0x0000 0x0000
0003: 0x00000000 0x00000141 0x0000 0x0000
0004: 0x00000000 0x00000201 0x0000 0x0000
0005: 0x00000000 0x00000241 0x0000 0x0000
0006: 0x00000000 0x00000301 0x0000 0x0000
0007: 0x00000000 0x00000341 0x0000 0x0000
0008: 0x00000000 0x00000401 0x0000 0x0000
0009: 0x00000000 0x00000441 0x0000 0x0000
0010: 0x00000000 0x00000501 0x0000 0x0000
0011: 0x00000000 0x00000541 0x0000 0x0000
0012: 0x00000000 0x00000601 0x0000 0x0000
0013: 0x00000000 0x00000641 0x0000 0x0000
0014: 0x00000000 0x00000701 0x0000 0x0000
0015: 0x00000000 0x00000741 0x0000 0x0000
0016: 0x00000000 0x00001001 0x0000 0x0000
0017: 0x00000000 0x00001041 0x0000 0x0000
0018: 0x00000000 0x00001101 0x0000 0x0000
0019: 0x00000000 0x00001141 0x0000 0x0000
0020: 0x00000000 0x00001201 0x0000 0x0000
0021: 0x00000000 0x00001241 0x0000 0x0000
0022: 0x00000000 0x00001301 0x0000 0x0000
0023: 0x00000000 0x00001341 0x0000 0x0000
0024: 0x00000000 0x00001401 0x0000 0x0000
0025: 0x00000000 0x00001441 0x0000 0x0000
0026: 0x00000000 0x00001501 0x0000 0x0000
0027: 0x00000000 0x00001541 0x0000 0x0000
0028: 0x00000000 0x00001601 0x0000 0x0000
0029: 0x00000000 0x00001641 0x0000 0x0000
0030: 0x00000000 0x00001701 0x0000 0x0000
0031: 0x00000000 0x00001741 0x0000 0x0000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
587
IP Addressing Services
show ip wccp
WCCP Client ID: 192.0.2.11
Protocol Version: 2.01
State: Usable
Redirection: L2
Packet Return: L2
Assignment: MASK
Connect Time: 6d20h
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Mask Allotment: 32 of 64 (50.00%)
Assigned masks/values: 1/32
Mask SrcAddr DstAddr SrcPort DstPort
---- ------- ------- ------- -------
0000: 0x00000000 0x00001741 0x0000 0x0000
Value SrcAddr DstAddr SrcPort DstPort
----- ------- ------- ------- -------
0000: 0x00000000 0x00000000 0x0000 0x0000
0001: 0x00000000 0x00000040 0x0000 0x0000
0002: 0x00000000 0x00000100 0x0000 0x0000
0003: 0x00000000 0x00000140 0x0000 0x0000
0004: 0x00000000 0x00000200 0x0000 0x0000
0005: 0x00000000 0x00000240 0x0000 0x0000
0006: 0x00000000 0x00000300 0x0000 0x0000
0007: 0x00000000 0x00000340 0x0000 0x0000
0008: 0x00000000 0x00000400 0x0000 0x0000
0009: 0x00000000 0x00000440 0x0000 0x0000
0010: 0x00000000 0x00000500 0x0000 0x0000
0011: 0x00000000 0x00000540 0x0000 0x0000
0012: 0x00000000 0x00000600 0x0000 0x0000
0013: 0x00000000 0x00000640 0x0000 0x0000
0014: 0x00000000 0x00000700 0x0000 0x0000
0015: 0x00000000 0x00000740 0x0000 0x0000
0016: 0x00000000 0x00001000 0x0000 0x0000
0017: 0x00000000 0x00001040 0x0000 0x0000
0018: 0x00000000 0x00001100 0x0000 0x0000
0019: 0x00000000 0x00001140 0x0000 0x0000
0020: 0x00000000 0x00001200 0x0000 0x0000
0021: 0x00000000 0x00001240 0x0000 0x0000
0022: 0x00000000 0x00001300 0x0000 0x0000
0023: 0x00000000 0x00001340 0x0000 0x0000
0024: 0x00000000 0x00001400 0x0000 0x0000
0025: 0x00000000 0x00001440 0x0000 0x0000
0026: 0x00000000 0x00001500 0x0000 0x0000
0027: 0x00000000 0x00001540 0x0000 0x0000
0028: 0x00000000 0x00001600 0x0000 0x0000
0029: 0x00000000 0x00001640 0x0000 0x0000
0030: 0x00000000 0x00001700 0x0000 0x0000
0031: 0x00000000 0x00001740 0x0000 0x0000
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
588
IP Addressing Services
show ip wccp
Table 38: show ip wccp service-number detail Field Descriptions
Field Description
Protocol Version Indicates whether WCCPv1 or WCCPv2 is enabled.
State Indicates whether the WCCP client is operating properly and can be contacted by a router
and other clients in the service group.
When a WCCP client has an incompatible message interval setting, the state of the client
is shown as "NOT Usable," followed by a status message describing the reason why the
client is not usable.
Redirection Indicates the redirection method used. WCCP uses GRE or L2 to redirect IP traffic.
Assignment Indicates the load-balancing method used. WCCP uses HASH or MASK assignment.
Connect Time The amount of time the client has been connected to the router.
Redirected Packets The number of packets that have been redirected to the content engine.
show ip wccp service-number clients
The following example displays WCCP client information and WCCP router statistics that include
the type of services:
Device# show ip wccp 91 clients
WCCP Client information:
WCCP Client ID: 10.1.1.14
Protocol Version: 2.0
State: Usable
Redirection: L2
Packet Return: L2
Assignment: MASK
Connect Time: 6d20h
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Mask Allotment: 32 of 64 (50.00%)
WCCP Client ID: 192.0.2.11
Protocol Version: 2.01
State: Usable
Redirection: L2
Packet Return: L2
Assignment: MASK
Connect Time: 6d20h
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
589
IP Addressing Services
show ip wccp
Mask Allotment: 32 of 64 (50.00%)
The table below describes the significant fields shown in the display.
Table 39: show ip wccp service-number clients Field Descriptions
Field Description
Protocol Version Indicates whether WCCPv1 or WCCPv2 is enabled.
State Indicates whether the WCCP client is operating properly and can be contacted by a router
and other clients in the service group.
When a WCCP client has an incompatible message interval setting, the state of the client
is shown as "NOT Usable," followed by a status message describing the reason why the
client is not usable.
Redirection Indicates the redirection method used. WCCP uses GRE or L2 to redirect IP traffic.
Assignment Indicates the load-balancing method used. WCCP uses HASH or MASK assignment.
Connect Time The amount of time (in seconds) the client has been connected to the router.
Redirected Packets The number of packets that have been redirected to the content engine.
show ip wccp interfaces
The following is sample output from the show ip wccp interfaces command:
Device# show ip wccp interfaces
IPv4 WCCP interface configuration:
FastEthernet2/1
Output services: 0
Input services: 1
Mcast services: 0
Exclude In: FALSE
The table below describes the significant fields shown in the display.
Table 40: show ip wccp interfaces Field Descriptions
Field Description
Output services Indicates the number of output services configured on the interface.
Input services Indicates the number of input services configured on the interface.
Mcast services Indicates the number of multicast services configured on the interface.
Exclude In Displays whether traffic on the interface is excluded from redirection.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
590
IP Addressing Services
show ip wccp
show ip wccp web-cache
The following is sample output from the show ip wccp web-cache command:
Device# show ip wccp web-cache
Global WCCP information:
Router information:
Router Identifier: 209.165.200.225
Service Identifier: web-cache
Protocol Version: 2.00
Number of Service Group Clients: 2
Number of Service Group Routers: 1
Total Packets Redirected: 0
Process: 0
CEF: 0
Service mode: Open
Service Access-list: -none-
Total Packets Dropped Closed: 0
Redirect access-list: -none-
Total Packets Denied Redirect: 0
Total Packets Unassigned: 0
Group access-list: -none-
Total Messages Denied to Group: 0
Total Authentication failures: 0
Total GRE Bypassed Packets Received: 0
Process: 0
CEF: 0
GRE tunnel interface: Tunnel0
The table below describes the significant fields shown in the display.
Table 41: show ip wccp web-cache Field Descriptions
Field Description
Service Identifier Indicates which service is detailed.
Protocol Version Indicates whether WCCPv1 or WCCPv2 is enabled.
Number of Service Group Clients Number of clients using the router as their home router.
Number of Service Group Routers The number of routers in the service group.
Total Packets Redirected Total number of packets redirected by the router.
Service mode Indicates whether WCCP open or closed mode is configured.
Service Access-list The name or number of the service access list that determines which
packets will be redirected.
Redirect access-list The name or number of the access list that determines which packets
will be redirected.
Total Packets Denied Redirect Total number of packets that were not redirected because they did not
match the access list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
591
IP Addressing Services
show ip wccp
Field Description
Total Packets Unassigned Number of packets that were not redirected because they were not
assigned to any cache engine. Packets may not be assigned during initial
discovery of cache engines or when a cache is dropped from a cluster.
Group access-list Indicates which cache engine is allowed to connect to the router.
Total Messages Denied to Group Indicates the number of packets denied by the group-list access list.
Total Authentication failures The number of instances where a password did not match.
show ip wccp web-cache counters
The following example displays web cache engine information and WCCP traffic counters:
Device# show ip wccp web-cache counters
WCCP Service Group Counters:
Redirected Packets:
Process: 0
CEF: 0
Non-Redirected Packets:
Action - Forward:
Reason - no assignment:
Process: 0
CEF: 0
Action - Ignore (forward):
Reason - redir ACL check:
Process: 0
CEF: 0
Action - Discard:
Reason - closed services:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
GRE Bypassed Packet Errors:
Total Errors:
Process: 0
CEF: 0
WCCP Client Counters:
WCCP Client ID: 192.0.2.12
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
WCCP Client ID: 192.0.2.11
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
592
IP Addressing Services
show ip wccp
The table below describes the significant fields shown in the display.
Table 42: show ip wccp web-cache counters Field Descriptions
Field Description
Redirected Packets Total number of packets redirected by the router.
Non-Redirected Packets Total number of packets not redirected by the router.
show ip wccp web-cache detail
The following example displays web cache engine information and WCCP router statistics for the
web cache service:
Device# show ip wccp web-cache detail
WCCP Client information:
WCCP Client ID: 209.165.200.225
Protocol Version: 2.0
State: Usable
Redirection: GRE
Packet Return: GRE
Assignment: HASH
Connect Time: 1w5d
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Hash Allotment: 128 of 256 (50.00%)
Initial Hash Info: 00000000000000000000000000000000
00000000000000000000000000000000
Assigned Hash Info: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
WCCP Client ID: 192.0.2.11
Protocol Version: 2.01
State: Usable
Redirection: GRE
Packet Return: GRE
Assignment: HASH
Connect Time: 1w5d
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Hash Allotment: 128 of 256 (50.00%)
Initial Hash Info: 00000000000000000000000000000000
00000000000000000000000000000000
Assigned Hash Info: 55555555555555555555555555555555
55555555555555555555555555555555
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
593
IP Addressing Services
show ip wccp
Table 43: show ip wccp web-cache detail Field Descriptions
Field Description
WCCP Client Information The header for the area that contains fields for information on clients.
Protocol Version The version of WCCP being used by the cache engine in the service group.
State Indicates whether the cache engine is operating properly and can be contacted
by a router and other cache engines in the service group.
Connect Time The amount of time the cache engine has been connected to the router.
Redirected Packets The number of packets that have been redirected to the cache engine.
show ip wccp web-cache detail (Bypass Counters Displayed)
The following example displays web cache engine information and WCCP router statistics that
include the bypass counters:
Device# show ip wccp web-cache detail
WCCP Client information:
WCCP Client ID: 209.165.200.225
Protocol Version: 2.01
State: Usable
Redirection: GRE
Packet Return: GRE
Assignment: HASH
Connect Time: 1w5d
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Hash Allotment: 128 of 256 (50.00%)
Initial Hash Info: 00000000000000000000000000000000
00000000000000000000000000000000
Assigned Hash Info: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
WCCP Client ID: 209.165.200.226
Protocol Version: 2.01
State: Usable
Redirection: GRE
Packet Return: GRE
Assignment: HASH
Connect Time: 1w5d
Redirected Packets:
Process: 0
CEF: 0
GRE Bypassed Packets:
Process: 0
CEF: 0
Hash Allotment: 128 of 256 (50.00%)
Initial Hash Info: 00000000000000000000000000000000
00000000000000000000000000000000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
594
IP Addressing Services
show ip wccp
Assigned Hash Info: 55555555555555555555555555555555
55555555555555555555555555555555
The table below describes the significant fields shown in the display.
Table 44: show ip wccp web-cache detail Field Descriptions
Field Description
WCCP Client Information The header for the area that contains fields for information on clients.
Protocol Version The version of WCCP that is being used by the router in the service group.
State Indicates whether the cache engine is operating properly and can be contacted
by a router and other cache engines in the service group.
Connect Time The amount of time the cache engine has been connected to the router.
Hash Allotment The percent of buckets assigned to the current cache engine. Both a value and
a percent figure are displayed.
Initial Hash Info The initial state of the hash bucket assignment.
Assigned Hash Info The current state of the hash bucket assignment.
Redirected Packets The number of packets that have been redirected to the cache engine.
GRE Bypassed Packets The number of packets that have been bypassed. Process and Cisco Express
Forwarding are switching paths within Cisco IOS software.
show ip wccp web-cache service
The following example displays information about a service, including the service definition and all
other per-service information:
Device# show ip wccp web-cache service
WCCP service information definition:
Type: Standard
Id: 0
Priority: 240
Protocol: 6
Flags: 0x00000512
Hash: DstIP
Alt Hash: SrcIP SrcPort
Ports used: Destination
Ports: 80
show ip wccp summary
The following example displays information about the configured WCCP services and a summary
of their current state:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
595
IP Addressing Services
show ip wccp
Device# show ip wccp summary
WCCP version 2 enabled, 2 services
Service Clients Routers Assign Redirect Bypass
------- ------- ------- ------ -------- ------
Default routing table (Router Id: 209.165.200.225):
web-cache 2 1 HASH GRE GRE
90 0 0 HASH/MASK GRE/L2 GRE/L2
The table below describes the significant fields shown in the display.
Table 45: show ip wccp summary Field Descriptions
Field Description
Service Indicates which service is detailed.
Clients Indicates the number of cache engines participating in the WCCP service.
Routers Indicates the number of routers participating in the WCCP service.
Assign Indicates the load-balancing method used. WCCP uses HASH or MASK assignment.
Redirect Indicates the redirection method used. WCCP uses GRE or L2 to redirect IP traffic.
Bypass Indicates the bypass method used. WCCP uses GRE or L2 to return packets to the router.
Related Commands Command Description
clear ip wccp Clears the counter for packets redirected using WCCP.
ip wccp Enables support of the WCCP service for participation in a service
group.
ip wccp redirect Enables packet redirection on an outbound or inbound interface using
WCCP.
show ip interface Lists a summary of the IP information and status of an interface.
show ip wccp global counters Displays global WCCP information for packets that are processed in
software.
show ip wccp service-number detail Displays information about the WCCP client timeout interval and the
redirect assignment timeout interval if those intervals are not set to
their default value of 10 seconds.
show ip wccp summary Displays the configured WCCP services and a summary of their current
state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
596
IP Addressing Services
show ipv6 access-list
show ipv6 access-list
To display the contents of all the current IPv6 access lists, use the show ipv6 access-list command in user
EXEC or privileged EXEC mode.
show ipv6 access-list [access-list-name]
Syntax Description access-list-name (Optional) Name of the access list.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show ipv6 access-list command provides output similar to the show ip access-list command, except that
it is IPv6-specific.
Examples The following output from the show ipv6 access-list command shows IPv6 access lists named
inbound, tcptraffic, and outbound:
Device# show ipv6 access-list
IPv6 access list inbound
permit tcp any any eq bgp reflect tcptraffic (8 matches) sequence 10
permit tcp any any eq telnet reflect tcptraffic (15 matches) sequence 20
permit udp any any reflect udptraffic sequence 30
IPv6 access list tcptraffic (reflexive) (per-user)
permit tcp host 2001:0DB8:1::1 eq bgp host 2001:0DB8:1::2 eq 11000 timeout 300 (time
left 243) sequence 1
permit tcp host 2001:0DB8:1::1 eq telnet host 2001:0DB8:1::2 eq 11001 timeout 300 (time
left 296) sequence 2
IPv6 access list outbound
evaluate udptraffic
evaluate tcptraffic
The following sample output shows IPv6 access list information for use with IPSec:
Device# show ipv6 access-list
IPv6 access list Tunnel0-head-0-ACL (crypto)
permit ipv6 any any (34 matches) sequence 1
IPv6 access list Ethernet2/0-ipsecv6-ACL (crypto)
permit 89 FE80::/10 any (85 matches) sequence 1
The following sample output shows all the types of IPv6 access lists that are configured for the facl
ACL name:
Device# show ipv6 access-list facl
IPv6 FQDN access list facl
permit ipv6 host 2001:DB8::1 host dynamic www.google.com sequence 10
permit tcp 2001:2:2::2/64 eq ftp host dynamic www.cisco.com log sequence 20
permit udp host dynamic www.youtube.com any sequence 30
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
597
IP Addressing Services
show ipv6 access-list
deny tcp any any eq www sequence 40
IPv6 access list facl
permit tcp 2001:2:2::2/64 eq ftp host 2001:DB8:ACAD:B:: log sequence 200000
permit tcp 2001:2:2::2/64 eq ftp host 2001:DB8:ACAD:A:: log sequence 200001
permit udp host dynamic 2001:4860:4860::8844 any sequence 300001
permit udp host dynamic 2001:4860:4860::8888 any sequence 300002
deny tcp any any eq www sequence 400000
The table below describes the significant fields shown in the display.
Table 46: show ipv6 access-list Field Descriptions
Field Description
IPv6 access list inbound Name of the IPv6 access list, for example, inbound.
permit Permits any packet that matches the specified protocol type.
tcp Transmission Control Protocol. The higher-level protocol (Layer 4) type that
the packet must match.
any Equal to ::/0.
eq An equal operand that compares the source or destination ports of TCP or UDP
packets.
bgp Border Gateway Protocol. The lower-level protocol (Layer 3) type that the packet
must be equal to.
reflect Indicates a reflexive IPv6 access list.
tcptraffic (8 matches) The name of the reflexive IPv6 access list and the number of matches for the
access list. The clear ipv6 access-list privileged EXEC command resets the
IPv6 access list match counters.
sequence 10 Sequence in which an incoming packet is compared to the lines in an access list.
Lines in an access list are ordered from first priority (lowest number, for example,
10) to last priority (highest number, for example, 80).
host 2001:0DB8:1::1 The source IPv6 host address that the source address of the packet must match.
host 2001:0DB8:1::2 The destination IPv6 host address that the destination address of the packet must
match.
11000 The ephemeral source port number for the outgoing connection.
timeout 300 The total interval of idle time (in seconds) after which the temporary IPv6
reflexive access list named tcptraffic times out for the indicated session.
(time left 243) The amount of idle time (in seconds) remaining before the temporary IPv6
reflexive access list named tcptraffic is deleted for the indicated session.
Additional received traffic that matches the indicated session resets this value
to 300 seconds.
evaluate udptraffic Indicates that the IPv6 reflexive access list named udptraffic is nested in the
IPv6 access list named outbound.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
598
IP Addressing Services
show ipv6 access-list
Field Description
IPv6 FQDN access list facl Name of the IPv6 FQDN access list, for example, facl.
Related Commands Command Description
clear ipv6 access-list Resets the IPv6 access list match counters.
hardware statistics Enables the collection of hardware statistics.
show ip access-list Displays the contents of all the current IP access lists.
show ip prefix-list Displays information about a prefix list or prefix list entries.
show ipv6 prefix-list Displays information about an IPv6 prefix list or IPv6 prefix list entries.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
599
IP Addressing Services
show ipv6 destination-guard policy
show ipv6 destination-guard policy
To display destination guard information, use the show ipv6 destination-guard policy command in privileged
EXEC mode.
show ipv6 destination-guard policy [policy-name]
Syntax Description policy-name (Optional) Name of the destination guard policy.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If the policy-name argument is specified, only the specified policy information is displayed. If the policy-name
argument is not specified, information is displayed for all policies.
Examples The following is sample output from the show ipv6 destination-guard policy command when the
policy is applied to a VLAN:
# show ipv6 destination-guard policy pol1
Destination guard policy destination:
enforcement always
Target: vlan 300
The following is sample output from the show ipv6 destination-guard policy command when the
policy is applied to an interface:
# show ipv6 destination-guard policy pol1
Destination guard policy destination:
enforcement always
Target: Gi0/0/1
Related Commands Command Description
ipv6 destination-guard policy Defines the destination guard policy.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
600
IP Addressing Services
show ipv6 dhcp
show ipv6 dhcp
To display the Dynamic Host Configuration Protocol (DHCP) unique identifier (DUID) on a specified device,
use the show ipv6 dhcp command in user EXEC or privileged EXEC mode.
show ipv6 dhcp
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 dhcp command uses the DUID based on the link-layer address for both client and server
identifiers. The device uses the MAC address from the lowest-numbered interface to form the DUID. The
network interface is assumed to be permanently attached to the device. Use the show ipv6 dhcp command
to display the DUID of a device.
Examples The following is sample output from the show ipv6 dhcp command. The output is self-explanatory:
# show ipv6 dhcp
This device's DHCPv6 unique identifier(DUID): 000300010002FCA5DC1C
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
601
IP Addressing Services
show ipv6 dhcp binding
show ipv6 dhcp binding
To display automatic client bindings from the Dynamic Host Configuration Protocol (DHCP) for IPv6 server
binding table, use the show ipv6 dhcp binding command in user EXEC or privileged EXEC mode.
show ipv6 dhcp binding [ipv6-address] [vrf vrf-name]
Syntax Description ipv6-address (Optional) The address of a DHCP for IPv6 client.
vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 dhcp binding command displays all automatic client bindings from the DHCP for IPv6 server
binding table if the ipv6-address argument is not specified. When the ipv6-address argument is specified,
only the binding for the specified client is displayed.
If the vrf vrf-namekeyword and argument combination is specified, all bindings that belong to the specified
VRF are displayed.
Note The ipv6 dhcp server vrf enable command must be enabled for the configured VRF to work. If the command
is not configured, the output of the show ipv6 dhcp binding command will not display the configured VRF;
it will only display the default VRF details.
Examples The following sample output displays all automatic client bindings from the DHCP for IPv6 server
binding table:
# show ipv6 dhcp binding
Client: FE80::A8BB:CCFF:FE00:300
DUID: 00030001AABBCC000300
Username : client_1
Interface: Virtual-Access2.1
IA PD: IA ID 0x000C0001, T1 75, T2 135
Prefix: 2001:380:E00::/64
preferred lifetime 150, valid lifetime 300
expires at Dec 06 2007 12:57 PM (262 seconds)
Client: FE80::A8BB:CCFF:FE00:300 (Virtual-Access2.2)
DUID: 00030001AABBCC000300
IA PD: IA ID 0x000D0001, T1 75, T2 135
Prefix: 2001:0DB8:E00:1::/64
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
602
IP Addressing Services
show ipv6 dhcp binding
preferred lifetime 150, valid lifetime 300
expires at Dec 06 2007 12:58 PM (288 seconds)
The table below describes the significant fields shown in the display.
Table 47: show ipv6 dhcp binding Field Descriptions
Field Description
Client Address of a specified client.
DUID DHCP unique identifier (DUID).
Virtual-Access2.1 First virtual client. When an IPv6 DHCP client requests two prefixes with
the same DUID but a different identity association for prefix delegation
(IAPD ) on two different interfaces, these prefixes are considered to be for
two different clients, and interface information is maintained for both.
Username : client_1 The username associated with the binding.
IA PD Collection of prefixes assigned to a client.
IA ID Identifier for this IAPD.
Prefix Prefixes delegated to the indicated IAPD on the specified client.
preferred lifetime, valid The preferred lifetime and valid lifetime settings, in seconds, for the specified
lifetime client.
Expires at Date and time at which the valid lifetime expires.
Virtual-Access2.2 Second virtual client. When an IPv6 DHCP client requests two prefixes with
the same DUID but different IAIDs on two different interfaces, these prefixes
are considered to be for two different clients, and interface information is
maintained for both.
When the DHCPv6 pool on the Cisco IOS DHCPv6 server is configured to obtain prefixes for
delegation from an authentication, authorization, and accounting (AAA) server, it sends the PPP
username from the incoming PPP session to the AAA server for obtaining the prefixes. The PPP
username is associated with the binding is displayed in output from the show ipv6 dhcp binding
command. If there is no PPP username associated with the binding, this field value is displayed as
"unassigned."
The following example shows that the PPP username associated with the binding is "client_1":
# show ipv6 dhcp binding
Client: FE80::2AA:FF:FEBB:CC
DUID: 0003000100AA00BB00CC
Username : client_1
Interface : Virtual-Access2
IA PD: IA ID 0x00130001, T1 75, T2 135
Prefix: 2001:0DB8:1:3::/80
preferred lifetime 150, valid lifetime 300
expires at Aug 07 2008 05:19 AM (225 seconds)
The following example shows that the PPP username associated with the binding is unassigned:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
603
IP Addressing Services
show ipv6 dhcp binding
# show ipv6 dhcp binding
Client: FE80::2AA:FF:FEBB:CC
DUID: 0003000100AA00BB00CC
Username : unassigned
Interface : Virtual-Access2
IA PD: IA ID 0x00130001, T1 150, T2 240
Prefix: 2001:0DB8:1:1::/80
preferred lifetime 300, valid lifetime 300
expires at Aug 11 2008 06:23 AM (233 seconds)
Related Commands Command Description
ipv6 dhcp server vrf enable Enables the DHCPv6 server VRF-aware feature.
clear ipv6 dhcp binding Deletes automatic client bindings from the DHCP for IPv6 binding table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
604
IP Addressing Services
show ipv6 dhcp conflict
show ipv6 dhcp conflict
To display address conflicts found by a Dynamic Host Configuration Protocol for IPv6 (DHCPv6) server
when addresses are offered to the client, use the show ipv6 dhcp conflict command in privileged EXEC
mode.
show ipv6 dhcp conflict [ipv6-address] [vrf vrf-name]
Syntax Description ipv6-address (Optional) The address of a DHCP for IPv6 client.
vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1aCisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you configure the DHCPv6 server to detect conflicts, it uses ping. The client uses neighbor discovery
to detect clients and reports to the server through a DECLINE message. If an address conflict is detected, the
address is removed from the pool, and the address is not assigned until the administrator removes the address
from the conflict list.
Examples The following is a sample output from the show ipv6 dhcp conflict command. This command shows
the pool and prefix values for DHCP conflicts.:
# show ipv6 dhcp conflict
Pool 350, prefix 2001:0DB8:1005::/48
2001:0DB8:1005::10
Related Commands Command Description
clear ipv6 dhcp conflict Clears an address conflict from the DHCPv6 server database.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
605
IP Addressing Services
show ipv6 dhcp database
show ipv6 dhcp database
To display the Dynamic Host Configuration Protocol (DHCP) for IPv6 binding database agent information,
use the show ipv6 dhcp database command in user EXEC or privileged EXEC mode.
show ipv6 dhcp database [agent-URL]
Syntax Description agent-URL (Optional) A flash, NVRAM, FTP, TFTP, or remote copy protocol (RCP) uniform resource
locator.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Each permanent storage to which the binding database is saved is called the database agent. An agent can be
configured using the ipv6 dhcp database command. Supported database agents include FTP and TFTP
servers, RCP, Flash file system, and NVRAM.
The show ipv6 dhcp database command displays DHCP for IPv6 binding database agent information. If the
agent-URL argument is specified, only the specified agent is displayed. If the agent-URL argument is not
specified, all database agents are shown.
Examples The following is sample output from the show ipv6 dhcp database command:
# show ipv6 dhcp database
Database agent tftp://172.19.216.133/db.tftp:
write delay: 69 seconds, transfer timeout: 300 seconds
last written at Jan 09 2003 01:54 PM,
write timer expires in 56 seconds
last read at Jan 06 2003 05:41 PM
successful read times 1
failed read times 0
successful write times 3172
failed write times 2
Database agent nvram:/dhcpv6-binding:
write delay: 60 seconds, transfer timeout: 300 seconds
last written at Jan 09 2003 01:54 PM,
write timer expires in 37 seconds
last read at never
successful read times 0
failed read times 0
successful write times 3325
failed write times 0
Database agent flash:/dhcpv6-db:
write delay: 82 seconds, transfer timeout: 3 seconds
last written at Jan 09 2003 01:54 PM,
write timer expires in 50 seconds
last read at never
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
606
IP Addressing Services
show ipv6 dhcp database
successful read times 0
failed read times 0
successful write times 2220
failed write times 614
The table below describes the significant fields shown in the display.
Table 48: show ipv6 dhcp database Field Descriptions
Field Description
Database agent Specifies the database agent.
Write delay The amount of time (in seconds) to wait before updating the database.
transfer timeout Specifies how long (in seconds) the DHCP server should wait before canceling
a database transfer. Transfers that exceed the timeout period are canceled.
Last written The last date and time bindings were written to the file server.
Write timer expires... The length of time, in seconds, before the write timer expires.
Last read The last date and time bindings were read from the file server.
Successful/failed read times The number of successful or failed read times.
Successful/failed write times The number of successful or failed write times.
Related Commands Command Description
ipv6 dhcp database Specifies DHCP for IPv6 binding database agent parameters.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
607
IP Addressing Services
show ipv6 dhcp guard policy
show ipv6 dhcp guard policy
To display Dynamic Host Configuration Protocol for IPv6 (DHCPv6) guard information, use the show ipv6
dhcp guard policy command in privileged EXEC mode.
show ipv6 dhcp guard policy [policy-name]
Syntax Description policy-name (Optional) DHCPv6 guard policy name.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If the policy-name argument is specified, only the specified policy information is displayed. If the policy-name
argument is not specified, information is displayed for all policies.
Examples The following is sample output from the show ipv6 dhcp guard guard command:
# show ipv6 dhcp guard policy
Dhcp guard policy: default
Device Role: dhcp client
Target: Et0/3
Dhcp guard policy: test1
Device Role: dhcp server
Target: vlan 0 vlan 1 vlan 2 vlan 3 vlan 4
Max Preference: 200
Min Preference: 0
Source Address Match Access List: acl1
Prefix List Match Prefix List: pfxlist1
Dhcp guard policy: test2
Device Role: dhcp relay
Target: Et0/0 Et0/1 Et0/2
The table below describes the significant fields shown in the display.
Table 49: show ipv6 dhcp guard Field Descriptions
Field Description
Device The role of the device. The role is either client, server or relay.
Role
Target The name of the target. The target is either an interface or a VLAN.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
608
IP Addressing Services
show ipv6 dhcp guard policy
Related Commands Command Description
ipv6 dhcp guard policy Defines the DHCPv6 guard policy name.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
609
IP Addressing Services
show ipv6 dhcp interface
show ipv6 dhcp interface
To display Dynamic Host Configuration Protocol (DHCP) for IPv6 interface information, use the show ipv6
dhcp interface command in user EXEC or privileged EXEC mode.
show ipv6 dhcp interface [type number]
Syntax Description type number (Optional) Interface type and number. For more information, use the question mark (?) online
help function.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If no interfaces are specified, all interfaces on which DHCP for IPv6 (client or server) is enabled are shown.
If an interface is specified, only information about the specified interface is displayed.
Examples The following is sample output from the show ipv6 dhcp interface command. In the first example,
the command is used on a router that has an interface acting as a DHCP for IPv6 server. In the second
example, the command is used on a router that has an interface acting as a DHCP for IPv6 client:
# show ipv6 dhcp interface
Ethernet2/1 is in server mode
Using pool: svr-p1
Preference value: 20
Rapid-Commit is disabled
Router2# show ipv6 dhcp interface
Ethernet2/1 is in client mode
State is OPEN (1)
List of known servers:
Address: FE80::202:FCFF:FEA1:7439, DUID 000300010002FCA17400
Preference: 20
IA PD: IA ID 0x00040001, T1 120, T2 192
Prefix: 3FFE:C00:C18:1::/72
preferred lifetime 240, valid lifetime 54321
expires at Nov 08 2002 09:10 AM (54319 seconds)
Prefix: 3FFE:C00:C18:2::/72
preferred lifetime 300, valid lifetime 54333
expires at Nov 08 2002 09:11 AM (54331 seconds)
Prefix: 3FFE:C00:C18:3::/72
preferred lifetime 280, valid lifetime 51111
expires at Nov 08 2002 08:17 AM (51109 seconds)
DNS server: 1001::1
DNS server: 1001::2
Domain name: domain1.net
Domain name: domain2.net
Domain name: domain3.net
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
610
IP Addressing Services
show ipv6 dhcp interface
Prefix name is cli-p1
Rapid-Commit is enabled
The table below describes the significant fields shown in the display.
Table 50: show ipv6 dhcp interface Field Descriptions
Field Description
Ethernet2/1 is in server/client mode Displays whether the specified interface is in server or client mode.
Preference value: The advertised (or default of 0) preference value for the indicated server.
Prefix name is cli-p1 Displays the IPv6 general prefix pool name, in which prefixes
successfully acquired on this interface are stored.
Using pool: svr-p1 The name of the pool that is being used by the interface.
State is OPEN State of the DHCP for IPv6 client on this interface. "Open" indicates
that configuration information has been received.
List of known servers Lists the servers on the interface.
Address, DUID Address and DHCP unique identifier (DUID) of a server heard on the
specified interface.
Rapid commit is disabled Displays whether the rapid-commit keyword has been enabled on the
interface.
The following example shows the DHCP for IPv6 relay agent configuration on FastEthernet interface
0/0, and use of the show ipv6 dhcp interface command displays relay agent information on
FastEthernet interface 0/0:
(config-if)# ipv6 dhcp relay destination FE80::250:A2FF:FEBF:A056 FastEthernet0/1
# show ipv6 dhcp interface FastEthernet 0/0
FastEthernet0/0 is in relay mode
Relay destinations:
FE80::250:A2FF:FEBF:A056 via FastEthernet0/1
Related Commands Command Description
ipv6 dhcp client pd Enables the DHCP for IPv6 client process and enables requests for prefix
delegation through a specified interface.
ipv6 dhcp relay destination Specifies a destination address to which client messages are forwarded and
enables DHCP for IPv6 relay service on the interface.
ipv6 dhcp server Enables DHCP for IPv6 service on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
611
IP Addressing Services
show ipv6 dhcp relay binding
show ipv6 dhcp relay binding
To display DHCPv6 Internet Assigned Numbers Authority (IANA) and DHCPv6 Identity Association for
Prefix Delegation (IAPD) bindings on a relay agent, use the show ipv6 dhcp relay binding command in user
EXEC or privileged EXEC mode.
show ipv6 dhcp relay binding [vrf vrf-name]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If the vrf vrf-name keyword-argument pair is specified, all bindings belonging to the specified VRF are
displayed.
Note Only the DHCPv6 IAPD bindings on a relay agent are displayed on the Cisco uBR10012 and Cisco uBR7200
series universal broadband devices.
Examples The following is sample output from the show ipv6 dhcp relay binding command:
Device# show ipv6 dhcp relay binding
The following example shows output from the show ipv6 dhcp relay binding command with a
specified VRF name on a Cisco uBR10012 universal broadband device:
Device# show ipv6 dhcp relay binding vrf vrf1
Prefix: 2001:DB8:0:1:/64 (Bundle100.600)
DUID: 000300010023BED94D31
IAID: 3201912114
lifetime: 600
The table below describes the significant fields shown in the display.
Table 51: show ipv6 dhcp relay binding Field Descriptions
Field Description
Prefix IPv6 prefix for DHCP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
612
IP Addressing Services
show ipv6 dhcp relay binding
Field Description
DUID DHCP Unique Identifier (DUID) for the IPv6 relay binding.
IAID Identity Association Identification (IAID) for DHCP.
lifetime Lifetime of the prefix, in seconds.
Related Commands Command Description
clear ipv6 dhcp relay binding Clears a specific IPv6 address or IPv6
prefix of a DHCP for IPv6 relay binding.
debug ipv6 dhcp relay Enables debugging for IPv6 DHCP relay
agent.
debug ipv6 dhcp relay bulk-lease Enables bulk lease query debugging for
IPv6 DHCP relay agent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
613
IP Addressing Services
show ipv6 eigrp events
show ipv6 eigrp events
To display Enhanced Interior Gateway Routing Protocol (EIGRP) events logged for IPv6, use the show ipv6
eigrp events command in user EXEC or privileged EXEC mode.
show ipv6 eigrp events [{[{errmsg | sia}] [event-num-start event-num-end] | type}]
Syntax Description errmsg (Optional) Displays error messages being logged.
sia (Optional) Displays Stuck In Active (SIA) messages.
event-num-start (Optional) Starting number of the event range. The range is from 1 to 4294967295.
event-num-end (Optional) Ending number of the event range. The range is from 1 to 4294967295.
type (Optional) Displays event types being logged.
Command Default If no event range is specified, information for all IPv6 EIGRP events is displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 eigrp events command is used to analyze a network failure by the Cisco support team and is
not intended for general use. This command provides internal state information about EIGRP and how it
processes route notifications and changes.
Examples The following is sample output from the show ipv6 eigrp events command. The fields are
self-explanatory.
# show ipv6 eigrp events
Event information for AS 65535:
1 00:56:41.719 State change: Successor Origin Local origin
2 00:56:41.719 Metric set: 2555:5555::/32 4294967295
3 00:56:41.719 Poison squashed: 2555:5555::/32 lost if
4 00:56:41.719 Poison squashed: 2555:5555::/32 rt gone
5 00:56:41.719 Route installing: 2555:5555::/32 FE80::ABCD:4:EF00:1
6 00:56:41.719 RDB delete: 2555:5555::/32 FE80::ABCD:4:EF00:2
7 00:56:41.719 Send reply: 2555:5555::/32 FE80::ABCD:4:EF00:1
8 00:56:41.719 Find FS: 2555:5555::/32 4294967295
9 00:56:41.719 Free reply status: 2555:5555::/32
10 00:56:41.719 Clr handle num/bits: 0 0x0
11 00:56:41.719 Clr handle dest/cnt: 2555:5555::/32 0
12 00:56:41.719 Rcv reply met/succ met: 4294967295 4294967295
13 00:56:41.719 Rcv reply dest/nh: 2555:5555::/32 FE80::ABCD:4:EF00:2
14 00:56:41.687 Send reply: 2555:5555::/32 FE80::ABCD:4:EF00:2
15 00:56:41.687 Rcv query met/succ met: 4294967295 4294967295
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
614
IP Addressing Services
show ipv6 eigrp events
16 00:56:41.687 Rcv query dest/nh: 2555:5555::/32 FE80::ABCD:4:EF00:2
17 00:56:41.687 State change: Local origin Successor Origin
18 00:56:41.687 Metric set: 2555:5555::/32 4294967295
19 00:56:41.687 Active net/peers: 2555:5555::/32 65536
20 00:56:41.687 FC not sat Dmin/met: 4294967295 2588160
21 00:56:41.687 Find FS: 2555:5555::/32 2588160
22 00:56:41.687 Rcv query met/succ met: 4294967295 4294967295
23 00:56:41.687 Rcv query dest/nh: 2555:5555::/32 FE80::ABCD:4:EF00:1
24 00:56:41.659 Change queue emptied, entries: 1
25 00:56:41.659 Metric set: 2555:5555::/32 2588160
Related Commands Command Description
clear ipv6 eigrp Deletes entries from EIGRP for IPv6 routing tables.
debug ipv6 eigrp Displays information about EIGRP for IPv6 protocol.
ipv6 eigrp Enables EIGRP for IPv6 on a specified interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
615
IP Addressing Services
show ipv6 eigrp interfaces
show ipv6 eigrp interfaces
To display information about interfaces configured for the Enhanced Interior Gateway Routing Protocol
(EIGRP) in IPv6 topologies, use the show ipv6 eigrp interfaces command in user EXEC or privileged EXEC
mode.
show ipv6 eigrp [as-number] interfaces [type number] [detail]
Syntax Description as-number (Optional) Autonomous system number.
type (Optional) Interface type. For more information, use the question mark (?) online help function.
number (Optional) Interface number. For more information about the numbering syntax for your
networking device, use the question mark (?) online help function.
detail (Optional) Displays detailed interface information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 eigrp interfaces command to determine the interfaces on which EIGRP is active and to
get information about EIGRP processes related to those interfaces. The optional type number argument and
the detail keyword can be entered in any order.
If an interface is specified, only that interface is displayed. Otherwise, all interfaces on which EIGRP is running
are displayed.
If an autonomous system is specified, only the routing process for the specified autonomous system is displayed.
Otherwise, all EIGRP processes are displayed.
Examples The following is sample output from the show ipv6 eigrp interfaces command:
# show ipv6 eigrp 1 interfaces
IPv6-EIGRP interfaces for process 1
Xmit Queue Mean Pacing Time Multicast Pending
Interface Peers Un/Reliable SRTT Un/Reliable Flow Timer Routes
Et0/0 0 0/0 0 0/10 0 0
The following is sample output from the show ipv6 eigrp interfaces detail command:
# show ipv6 eigrp interfaces detail
IPv6-EIGRP interfaces for process 1
Xmit Queue Mean Pacing Time Multicast Pending
Interface Peers Un/Reliable SRTT Un/Reliable Flow Timer Routes
Et0/0 0 0/0 0 0/10 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
616
IP Addressing Services
show ipv6 eigrp interfaces
Hello interval is 5 sec
Next xmit serial <none>
Un/reliable mcasts: 0/0 Un/reliable ucasts: 0/0
Mcast exceptions: 0 CR packets: 0 ACKs suppressed: 0
Retransmissions sent: 0 Out-of-sequence rcvd: 0
Authentication mode is not set
The following sample output from the show ipv6 eigrp interface detail command displays detailed
information about a specific interface on which the no ipv6 next-hop self command is configured
with the no-ecmp-mode option:
Device# show ipv6 eigrp interfaces detail tunnel 0
EIGRP-IPv6 Interfaces for AS(1)
Xmit Queue PeerQ Mean Pacing Time Multicast Pending
Interface Peers Un/Reliable Un/Reliable SRTT Un/Reliable Flow Timer Routes
Tu0/0 2 0/0 0/0 29 0/0 136 0
Hello-interval is 5, Hold-time is 15
Split-horizon is disabled
Next xmit serial <none>
Packetized sent/expedited: 48/1
Hello's sent/expedited: 13119/49
Un/reliable mcasts: 0/20 Un/reliable ucasts: 31/398
Mcast exceptions: 5 CR packets: 5 ACKs suppressed: 1
Retransmissions sent: 355 Out-of-sequence rcvd: 6
Next-hop-self disabled, next-hop info forwarded, ECMP mode Enabled
Topology-ids on interface - 0
Authentication mode is not set
The table below describes the significant fields shown in the displays.
Table 52: show ipv6 eigrp interfaces Field Descriptions
Field Description
Interface Interface over which EIGRP is configured.
Peers Number of directly connected EIGRP neighbors.
Xmit Queue Un/Reliable Number of packets remaining in the Unreliable and Reliable transmit queues.
Mean SRTT Mean smooth round-trip time (SRTT) interval (in seconds).
Pacing Time Un/Reliable Pacing time (in seconds) used to determine when EIGRP packets (unreliable and
reliable) should be sent out of the interface.
Multicast Flow Timer Maximum number of seconds in which the device will send multicast EIGRP
packets.
Pending Routes Number of routes in the transmit queue waiting to be sent.
Hello interval is 5 sec Length (in seconds) of the hello interval.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
617
IP Addressing Services
show ipv6 eigrp topology
show ipv6 eigrp topology
To display Enhanced Interior Gateway Routing Protocol (EIGRP) IPv6 topology table entries, use the show
ipv6 eigrp topology command in user EXEC or privileged EXEC mode.
show ipv6 eigrp topology [{as-number ipv6-address}] [{active | all-links | pending | summary |
zero-successors}]
Syntax Description as-number (Optional) Autonomous system number.
ipv6-address (Optional) IPv6 address.
active (Optional) Displays only active entries in the EIGRP topology table.
all-links (Optional) Displays all entries in the EIGRP topology table (including
nonfeasible-successor sources).
pending (Optional) Displays all entries in the EIGRP topology table that are either waiting for an
update from a neighbor or waiting to reply to a neighbor.
summary (Optional) Displays a summary of the EIGRP topology table.
zero-successors (Optional) Displays the available routes that have zero successors.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If this command is used without any keywords or arguments, only routes that are feasible successors are
displayed. The show ipv6 eigrp topology command can be used to determine Diffusing Update Algorithm
(DUAL) states and to debug possible DUAL problems.
Examples The following is sample output from the show ipv6 eigrp topology command. The fields in the
display are self-explanatory.
# show ipv6 eigrp topology
IPv6-EIGRP Topology Table for AS(1)/ID(2001:0DB8:10::/64)
Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply,
r - reply Status, s - sia Status
P 2001:0DB8:3::/64, 1 successors, FD is 281600
via Connected, Ethernet1/0
The following sample output from the show ipv6 eigrp topology prefix command displays ECMP
mode information when the no ipv6 next-hop-self command is configured without the no-ecmp-mode
option in the EIGRP topology. The ECMP mode provides information about the path that is being
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
618
IP Addressing Services
show ipv6 eigrp topology
advertised. If there is more than one successor, the top most path will be advertised as the default
path over all interfaces, and the message “ECMP Mode: Advertise by default” will be displayed in
the output. If any path other than the default path is advertised, the message “ECMP Mode: Advertise
out <Interface name>” will be displayed. The fields in the display are self-explanatory.
# show ipv6 eigrp topology 2001:DB8:10::1/128
EIGRP-IPv6 Topology Entry for AS(1)/ID(192.0.2.100) for 2001:DB8:10::1/128
State is Passive, Query origin flag is 1, 2 Successor(s), FD is 284160
Descriptor Blocks:
FE80::A8BB:CCFF:FE01:2E01 (Tunnel0), from FE80::A8BB:CCFF:FE01:2E01, Send flag is 0x0
Composite metric is (284160/281600), route is Internal
Vector metric:
Minimum bandwidth is 10000 Kbit
Total delay is 1100 microseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1400
Hop count is 1
Originating router is 10.10.1.1
ECMP Mode: Advertise by default
FE80::A8BB:CCFF:FE01:3E01 (Tunnel1), from FE80::A8BB:CCFF:FE01:3E01, Send flag is 0x0
Composite metric is (284160/281600), route is Internal
Vector metric:
Minimum bandwidth is 10000 Kbit
Total delay is 1100 microseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1400
Hop count is 1
Originating router is 10.10.2.2
ECMP Mode: Advertise out Tunnel1
Related Commands Command Description
show eigrp address-family topology Displays entries in the EIGRP topology table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
619
IP Addressing Services
show ipv6 eigrp traffic
show ipv6 eigrp traffic
To display the number of Enhanced Interior Gateway Routing Protocol (EIGRP) for IPv6 packets sent and
received, use the show ipv6 eigrp traffic command in user EXEC or privileged EXEC mode.
show ipv6 eigrp traffic [as-number]
Syntax Description as-number (Optional) Autonomous system number.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 eigrp traffic command to provide information on packets received and sent.
Examples The following is sample output from the show ipv6 eigrp traffic command:
# show ipv6 eigrp traffic
IPv6-EIGRP Traffic Statistics for process 9
Hellos sent/received: 218/205
Updates sent/received: 7/23
Queries sent/received: 2/0
Replies sent/received: 0/2
Acks sent/received: 21/14
The table below describes the significant fields shown in the display.
Table 53: show ipv6 eigrp traffic Field Descriptions
Field Description
process 9 Autonomous system number specified in the ipv6 router eigrpcommand.
Hellos sent/received Number of hello packets sent and received.
Updates sent/received Number of update packets sent and received.
Queries sent/received Number of query packets sent and received.
Replies sent/received Number of reply packets sent and received.
Acks sent/received Number of acknowledgment packets sent and received.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
620
IP Addressing Services
show ipv6 eigrp traffic
Related Commands Command Description
ipv6 router eigrp Configures the EIGRP for IPv6 routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
621
IP Addressing Services
show ipv6 general-prefix
show ipv6 general-prefix
To display information on IPv6 general prefixes, use the show ipv6 general-prefix command in user EXEC
or privileged EXEC mode.
show ipv6 general-prefix
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 general-prefix command to view information on IPv6 general prefixes.
Examples The following example shows an IPv6 general prefix called my-prefix, which has been defined based
on a 6to4 interface. The general prefix is also being used to define an address on interface loopback42.
# show ipv6 general-prefix
IPv6 Prefix my-prefix, acquired via 6to4
2002:B0B:B0B::/48
Loopback42 (Address command)
The table below describes the significant fields shown in the display.
Table 54: show ipv6 general-prefix Field Descriptions
Field Description
IPv6 Prefix User-defined name of the IPv6 general prefix.
Acquired via The general prefix has been defined based on a 6to4 interface. A general
prefix can also be defined manually or acquired using DHCP for IPv6
prefix delegation.
2002:B0B:B0B::/48 The prefix value for this general prefix.
Loopback42 (Address command) List of interfaces where this general prefix is used.
Related Commands Command Description
ipv6 general-prefix Defines a general prefix for an IPv6 address manually.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
622
IP Addressing Services
show ipv6 interface
show ipv6 interface
To display the usability status of interfaces configured for IPv6, use the show ipv6 interface command in
user EXEC or privileged EXEC mode.
show ipv6 interface [brief ][type number][prefix]
Syntax Description brief (Optional) Displays a brief summary of IPv6 status and configuration for each interface.
type (Optional) The interface type about which to display information.
number (Optional) The interface number about which to display information.
prefix (Optional) Prefix generated from a local IPv6 prefix pool.
Command Default All IPv6 interfaces are displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 interface command provides output similar to the show ip interface command, except that it
is IPv6-specific.
Use the show ipv6 interface command to validate the IPv6 status of an interface and its configured addresses.
The show ipv6 interface command also displays the parameters that IPv6 is using for operation on this interface
and any configured features.
If the interface’s hardware is usable, the interface is marked up. If the interface can provide two-way
communication for IPv6, the line protocol is marked up.
If you specify an optional interface type and number, the command displays information only about that
specific interface. For a specific interface, you can enter the prefix keyword to see the IPv6 neighbor discovery
(ND) prefixes that are configured on the interface.
Interface Information for a Specific Interface with IPv6 Configured
The show ipv6 interface command displays information about the specified interface.
(config)# show ipv6 interface ethernet0/0
Ethernet0/0 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::A8BB:CCFF:FE00:6700
No Virtual link-local address(es):
Global unicast address(es):
2001::1, subnet is 2001::/64 [DUP]
2001::A8BB:CCFF:FE00:6700, subnet is 2001::/64 [EUI]
2001:100::1, subnet is 2001:100::/64
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
623
IP Addressing Services
show ipv6 interface
Joined group address(es):
FF02::1
FF02::2
FF02::1:FF00:1
FF02::1:FF00:6700
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
ICMP unreachables are sent
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds (using 30000)
ND advertised reachable time is 0 (unspecified)
ND advertised retransmit interval is 0 (unspecified)
ND router advertisements are sent every 200 seconds
ND router advertisements live for 1800 seconds
ND advertised default router preference is Medium
Hosts use stateless autoconfig for addresses.
The table below describes the significant fields shown in the display.
Table 55: show ipv6 interface Field Descriptions
Field Description
Ethernet0/0 is up, line protocol is Indicates whether the interface hardware is active (whether line signal is
up present) and whether it has been taken down by an administrator. If the
interface hardware is usable, the interface is marked "up." For an interface
to be usable, both the interface hardware and line protocol must be up.
line protocol is up, down (down Indicates whether the software processes that handle the line protocol
is not shown in sample output) consider the line usable (that is, whether keepalives are successful or
IPv6 CP has been negotiated). If the interface can provide two-way
communication, the line protocol is marked up. For an interface to be
usable, both the interface hardware and line protocol must be up.
IPv6 is enabled, stalled, disabled Indicates that IPv6 is enabled, stalled, or disabled on the interface. If IPv6
(stalled and disabled are not is enabled, the interface is marked "enabled." If duplicate address detection
shown in sample output) processing identified the link-local address of the interface as being a
duplicate address, the processing of IPv6 packets is disabled on the
interface and the interface is marked "stalled." If IPv6 is not enabled, the
interface is marked "disabled."
link-local address Displays the link-local address assigned to the interface.
Global unicast address(es): Displays the global unicast addresses assigned to the interface.
Joined group address(es): Indicates the multicast groups to which this interface belongs.
MTU Maximum transmission unit of the interface.
ICMP error messages Specifies the minimum interval (in milliseconds) between error messages
sent on this interface.
ICMP redirects The state of Internet Control Message Protocol (ICMP) IPv6 redirect
messages on the interface (the sending of the messages is enabled or
disabled).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
624
IP Addressing Services
show ipv6 interface
Field Description
ND DAD The state of duplicate address detection on the interface (enabled or
disabled).
number of DAD attempts: Number of consecutive neighbor solicitation messages that are sent on
the interface while duplicate address detection is performed.
ND reachable time Displays the neighbor discovery reachable time (in milliseconds) assigned
to this interface.
ND advertised reachable time Displays the neighbor discovery reachable time (in milliseconds)
advertised on this interface.
ND advertised retransmit interval Displays the neighbor discovery retransmit interval (in milliseconds)
advertised on this interface.
ND router advertisements Specifies the interval (in seconds) for neighbor discovery router
advertisements (RAs) sent on this interface and the amount of time before
the advertisements expire.
As of Cisco IOS Release 12.4(2)T, this field displays the default router
preference (DRP) value sent by this device on this interface.
ND advertised default router The DRP for the device on a specific interface.
preference is Medium
The show ipv6 interface command displays information about attributes that may be associated
with an IPv6 address assigned to the interface.
Attribute Description
ANY Anycast. The address is an anycast address, as
specified when configured using the ipv6 address
command.
CAL Calendar. The address is timed and has valid and
preferred lifetimes.
DEP Deprecated. The timed address is deprecated.
DUP Duplicate. The address is a duplicate, as determined
by duplicate address detection (DAD). To re-attampt
DAD, the user must use the shutdown or no
shutdown command on the interface.
EUI EUI-64 based. The address was generated using
EUI-64.
OFF Offlink. The address is offlink.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
625
IP Addressing Services
show ipv6 interface
Attribute Description
OOD Overly optimistic DAD. DAD will not be performed
for this address. This attribute applies to virtual
addresses.
PRE Preferred. The timed address is preferred.
TEN Tentative. The address is in a tentative state per DAD.
UNA Unactivated. The virtual address is not active and is
in a standby state.
VIRT Virtual. The address is virtual and is managed by
HSRP, VRRP, or GLBP.
show ipv6 interface Command Using the brief Keyword
The following is sample output from the show ipv6 interface command when entered with the brief
keyword:
# show ipv6 interface brief
Ethernet0 is up, line protocol is up
Ethernet0 [up/up]
unassigned
Ethernet1 [up/up]
2001:0DB8:1000:/29
Ethernet2 [up/up]
2001:0DB8:2000:/29
Ethernet3 [up/up]
2001:0DB8:3000:/29
Ethernet4 [up/down]
2001:0DB8:4000:/29
Ethernet5 [administratively down/down]
2001:123::210:7BFF:FEC2:ACD8
Interface Status IPv6 Address
Ethernet0 up 3FFE:C00:0:1:260:3EFF:FE11:6770
Ethernet1 up unassigned
Fddi0 up 3FFE:C00:0:2:260:3EFF:FE11:6772
Serial0 administratively down unassigned
Serial1 administratively down unassigned
Serial2 administratively down unassigned
Serial3 administratively down unassigned
Tunnel0 up unnumbered (Ethernet0)
Tunnel1 up 3FFE:700:20:1::12
IPv6 Interface with ND Prefix Configured
This sample output shows the characteristics of an interface that has generated a prefix from a local
IPv6 prefix pool:
# show ipv6 interface Ethernet 0/0 prefix
interface Ethernet0/0
ipv6 address 2001:0DB8::1/64
ipv6 address 2001:0DB8::2/64
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
626
IP Addressing Services
show ipv6 interface
ipv6 nd prefix 2001:0DB8:2::/64
ipv6 nd prefix 2001:0DB8:3::/64 2592000 604800 off-link
end
.
.
.
IPv6 Prefix Advertisements Ethernet0/0
Codes: A - Address, P - Prefix-Advertisement, O - Pool
U - Per-user prefix, D - Default
N - Not advertised, C - Calendar
default [LA] Valid lifetime 2592000, preferred lifetime 604800
AD 2001:0DB8:1::/64 [LA] Valid lifetime 2592000, preferred lifetime 604800
APD 2001:0DB8:2::/64 [LA] Valid lifetime 2592000, preferred lifetime 604800
P 2001:0DB8:3::/64 [A] Valid lifetime 2592000, preferred lifetime 604800
The default prefix shows the parameters that are configured using the ipv6 nd prefix default command.
IPv6 Interface with DRP Configured
This sample output shows the state of the DRP preference value as advertised by this device through
an interface:
# show ipv6 interface gigabitethernet 0/1
GigabitEthernet0/1 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::130
Description: Management network (dual stack)
Global unicast address(es):
FEC0:240:104:1000::130, subnet is FEC0:240:104:1000::/64
Joined group address(es):
FF02::1
FF02::2
FF02::1:FF00:130
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND router advertisements are sent every 200 seconds
ND router advertisements live for 1800 seconds
ND advertised default router preference is Low
Hosts use stateless autoconfig for addresses.
IPv6 Interface with HSRP Configured
When HSRP IPv6 is first configured on an interface, the interface IPv6 link-local address is marked
unactive (UNA) because it is no longer advertised, and the HSRP IPv6 virtual link-local address is
added to the virtual link-local address list with the UNA and tentative DAD (TEN) attributes set.
The interface is also programmed to listen for the HSRP IPv6 multicast address.
This sample output shows the status of UNA and TEN attributes, when HSRP IPv6 is configured on
an interface:
# show ipv6 interface ethernet 0/0
Ethernet0/0 is up, line protocol is up
IPv6 is enabled, link-local address is FE80:2::2 [UNA]
Virtual link-local address(es):
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
627
IP Addressing Services
show ipv6 interface
FE80::205:73FF:FEA0:1 [UNA/TEN]
Global unicast address(es):
2001:2::2, subnet is 2001:2::/64
Joined group address(es):
FF02::1
FF02::2
FF02::66
FF02::1:FF00:2
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ND DAD is enabled, number of DAD attempts: 1
After the HSRP group becomes active, the UNA and TEN attributes are cleared, and the overly
optimistic DAD (OOD) attribute is set. The solicited node multicast address for the HSRP virtual
IPv6 address is also added to the interface.
This sample output shows the status of UNA, TEN and OOD attributes, when HSRP group is activated:
# show ipv6 interface ethernet 0/0
Ethernet0/0 is up, line protocol is up
IPv6 is enabled, link-local address is FE80:2::2 [UNA]
Virtual link-local address(es):
FE80::205:73FF:FEA0:1 [OPT]
Global unicast address(es):
2001:2::2, subnet is 2001:2::/64
Joined group address(es):
FF02::1
FF02::2
FF02::66
FF02::1:FF00:2
FF02::1:FFA0:1
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
ND DAD is enabled, number of DAD attempts: 1
The table below describes additional significant fields shown in the displays for the show ipv6
interface command with HSRP configured.
Table 56: show ipv6 interface Command with HSRP Configured Field Descriptions
Field Description
IPv6 is enabled, link-local address is The interface IPv6 link-local address is marked UNA because
FE80:2::2 [UNA] it is no longer advertised.
FE80::205:73FF:FEA0:1 [UNA/TEN] The virtual link-local address list with the UNA and TEN
attributes set.
FF02::66 HSRP IPv6 multicast address.
FE80::205:73FF:FEA0:1 [OPT] HSRP becomes active, and the HSRP virtual address marked
OPT.
FF02::1:FFA0:1 HSRP solicited node multicast address.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
628
IP Addressing Services
show ipv6 interface
IPv6 Interface with Minimum RA Interval Configured
When you enable Mobile IPv6 on an interface, you can configure a minimum interval between IPv6
router advertisement (RA) transmissions. The show ipv6 interface command output reports the
minimum RA interval, when configured. If the minimum RA interval is not explicitly configured,
then it is not displayed.
In the following example, the maximum RA interval is configured as 100 seconds, and the minimum
RA interval is configured as 60 seconds on Ethernet interface 1/0:
(config-if)# ipv6 nd ra-interval 100 60
Subsequent use of the show ipv6 interface then displays the interval as follows:
(config)# show ipv6 interface ethernet 1/0
Ethernet1/0 is administratively down, line protocol is down
IPv6 is enabled, link-local address is FE80::A8BB:CCFF:FE00:5A01 [TEN]
No Virtual link-local address(es):
No global unicast address is configured
Joined group address(es):
FF02::1
FF02::2
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
ICMP unreachables are sent
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND router advertisements are sent every 60 to 100 seconds
ND router advertisements live for 1800 seconds
ND advertised default router preference is Medium
Hosts use stateless autoconfig for addresses.
In the following example, the maximum RA interval is configured as 100 milliseconds (ms), and the
minimum RA interval is configured as 60 ms on Ethernet interface 1/0:
(config)# show ipv6 interface ethernet 1/0
Ethernet1/0 is administratively down, line protocol is down
IPv6 is enabled, link-local address is FE80::A8BB:CCFF:FE00:5A01 [TEN]
No Virtual link-local address(es):
No global unicast address is configured
Joined group address(es):
FF02::1
FF02::2
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
ICMP unreachables are sent
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND router advertisements are sent every 60 to 100 milliseconds
ND router advertisements live for 1800 seconds
ND advertised default router preference is Medium
Hosts use stateless autoconfig for addresses.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
629
IP Addressing Services
show ipv6 interface
The table below describes additional significant fields shown in the displays for the show ipv6
interface command with minimum RA interval information configured.
Table 57: show ipv6 interface Command with Minimum RA Interval Information Configuration Field Descriptions
Field Description
ND router advertisements are sent ND RAs are sent at an interval randomly selected from a value
every 60 to 100 seconds between the minimum and maximum values. In this example, the
minimum value is 60 seconds, and the maximum value is 100
seconds.
ND router advertisements are sent ND RAs are sent at an interval randomly selected from a value
every 60 to 100 milliseconds between the minimum and maximum values. In this example, the
minimum value is 60 ms, and the maximum value is 100 ms.
Related Commands Command Description
ipv6 nd prefix Configures which IPv6 prefixes are included in IPv6 router advertisements.
ipv6 nd ra interval Configures the interval between IPv6 RA transmissions on an interface.
show ip interface Displays the usability status of interfaces configured for IP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
630
IP Addressing Services
show ipv6 mfib
show ipv6 mfib
To display the forwarding entries and interfaces in the IPv6 Multicast Forwarding Information Base (MFIB),
use the show ipv6 mfib command in user EXEC or privileged EXEC mode.
show ipv6 mfib [vrf vrf-name] [{all | linkscope | verbose group-address-name | ipv6-prefix/ prefix-length
source-address-name | interface | status | summary}]
show ipv6 mfib [vrf vrf-name] [{all | linkscope | verbose | interface | status | summary}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
all (Optional) Displays all forwarding entries and interfaces in the IPv6 MFIB.
linkscope (Optional) Displays the link-local groups.
verbose (Optional) Provides additional information, such as the MAC encapsulation header
and platform-specific information.
ipv6-prefix (Optional) The IPv6 network assigned to the interface. The default IPv6 prefix is
128.
This argument must be in the form documented in RFC 2373 where the address is
specified in hexadecimal using 16-bit values between colons.
/ prefix-length (Optional) The length of the IPv6 prefix. A decimal value that indicates how many
of the high-order contiguous bits of the address comprise the prefix (the network
portion of the address). A slash mark must precede the decimal value.
group-address-name (Optional) IPv6 address or name of the multicast group.
source-address-name (Optional) IPv6 address or name of the multicast group.
interface (Optional) Interface settings and status.
status (Optional) General settings and status.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 mfib command to display MFIB entries; and forwarding interfaces, and their traffic
statistics. This command can be enabled on virtual IP (VIP) if the router is operating in distributed mode.
A forwarding entry in the MFIB has flags that determine the default forwarding and signaling behavior to use
for packets matching the entry. The entry also has per-interface flags that further specify the forwarding
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
631
IP Addressing Services
show ipv6 mfib
behavior for packets received or forwarded on specific interfaces. The table below describes the MFIB
forwarding entries and interface flags.
Table 58: MFIB Entries and Interface Flags
Flag Description
F Forward--Data is forwarded out of this interface.
A Accept--Data received on this interface is accepted for forwarding.
IC Internal copy--Deliver to the router a copy of the packets received or forwarded on this interface.
NS Negate signal--Reverse the default entry signaling behavior for packets received on this interface.
DP Do not preserve--When signaling the reception of a packet on this interface, do not preserve a copy of
it (discard it instead).
SP Signal present--The reception of a packet on this interface was just signaled.
S Signal--By default, signal the reception of packets matching this entry.
C Perform directly connected check for packets matching this entry. Signal the reception if packets were
originated by a directly connected source.
Examples The following example displays the forwarding entries and interfaces in the MFIB. The router is
configured for fast switching, and it has a receiver joined to FF05::1 on Ethernet1/1 and a source
(2001::1:1:20) sending on Ethernet1/2:
# show ipv6 mfib
IP Multicast Forwarding Information Base
Entry Flags: C - Directly Connected, S - Signal, IA - Inherit A flag,
AR - Activity Required, D - Drop
Forwarding Counts: Pkt Count/Pkts per second/Avg Pkt Size/Kbits per second
Other counts: Total/RPF failed/Other drops
Interface Flags: A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts: FS Pkt Count/PS Pkt Count
(*,FF00::/8) Flags: C
Forwarding: 0/0/0/0, Other: 0/0/0
Tunnel0 Flags: NS
(*,FF00::/15) Flags: D
Forwarding: 0/0/0/0, Other: 0/0/0
(*,FF05::1) Flags: C
Forwarding: 2/0/100/0, Other: 0/0/0
Tunnel0 Flags: A NS
Ethernet1/1 Flags: F NS
Pkts: 0/2
(2001::1:1:200,FF05::1) Flags:
Forwarding: 5/0/100/0, Other: 0/0/0
Ethernet1/2 Flags: A
Ethernet1/1 Flags: F NS
Pkts: 3/2
(*,FF10::/15) Flags: D
Forwarding: 0/0/0/0, Other: 0/0/0
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
632
IP Addressing Services
show ipv6 mfib
Table 59: show ipv6 mfib Field Descriptions
Field Description
Entry Flags Information about the entry.
Forwarding Counts Statistics on the packets that are received from and forwarded to at least one interface.
Pkt Count/ Total number of packets received and forwarded since the creation of the multicast
forwarding state to which this counter applies.
Pkts per second/ Number of packets received and forwarded per second.
Avg Pkt Size/ Total number of bytes divided by the total number of packets for this multicast
forwarding state. There is no direct display for the total number of bytes. You can
calculate the total number of bytes by multiplying the average packet size by the packet
count.
Kbits per second Bytes per second divided by packets per second divided by 1000.
Other counts: Statistics on the received packets. These counters include statistics about the packets
received and forwarded and packets received but not forwarded.
Interface Flags: Information about the interface.
Interface Counts: Interface statistics.
The following example shows forwarding entries and interfaces in the MFIB, with a group address
of FF03:1::1 specified:
# show ipv6 mfib FF03:1::1
IP Multicast Forwarding Information Base
Entry Flags:C - Directly Connected, S - Signal, IA - Inherit A
flag,
AR - Activity Required, D - Drop
Forwarding Counts:Pkt Count/Pkts per second/Avg Pkt Size/Kbits per
second
Other counts:Total/RPF failed/Other drops
Interface Flags:A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts:FS Pkt Count/PS Pkt Count
*,FF03:1::1) Flags:C
Forwarding:0/0/0/0, Other:0/0/0
Tunnel1 Flags:A NS
GigabitEthernet5/0.25 Flags:F NS
Pkts:0/0
GigabitEthernet5/0.24 Flags:F NS
Pkts:0/0
(5002:1::2,FF03:1::1) Flags:
Forwarding:71505/0/50/0, Other:42/0/42
GigabitEthernet5/0 Flags:A
GigabitEthernet5/0.19 Flags:F NS
Pkts:239/24
GigabitEthernet5/0.20 Flags:F NS
Pkts:239/24
GigabitEthernet5/0.21 Flags:F NS
Pkts:238/24
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
633
IP Addressing Services
show ipv6 mfib
.
.
GigabitEthernet5/0.16 Flags:F NS
Pkts:71628/24
The following example shows forwarding entries and interfaces in the MFIB, with a group address
of FF03:1::1 and a source address of 5002:1::2 specified:
# show ipv6 mfib FF03:1::1 5002:1::2
IP Multicast Forwarding Information Base
Entry Flags:C - Directly Connected, S - Signal, IA - Inherit A flag,
AR - Activity Required, D - Drop
Forwarding Counts:Pkt Count/Pkts per second/Avg Pkt Size/Kbits per second
Other counts:Total/RPF failed/Other drops
Interface Flags:A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts:FS Pkt Count/PS Pkt Count
(5002:1::2,FF03:1::1) Flags:
Forwarding:71505/0/50/0, Other:42/0/42
GigabitEthernet5/0 Flags:A
GigabitEthernet5/0.19 Flags:F NS
Pkts:239/24
GigabitEthernet5/0.20 Flags:F NS
Pkts:239/24
.
.
.
GigabitEthernet5/0.16 Flags:F NS
Pkts:71628/24
The following example shows forwarding entries and interfaces in the MFIB, with a group address
of FF03:1::1 and a default prefix of 128:
# show ipv6 mfib FF03:1::1/128
IP Multicast Forwarding Information Base
Entry Flags:C - Directly Connected, S - Signal, IA - Inherit A flag,
AR - Activity Required, D - Drop
Forwarding Counts:Pkt Count/Pkts per second/Avg Pkt Size/Kbits per second
Other counts:Total/RPF failed/Other drops
Interface Flags:A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts:FS Pkt Count/PS Pkt Count
(*,FF03:1::1) Flags:C
Forwarding:0/0/0/0, Other:0/0/0
Tunnel1 Flags:A NS
GigabitEthernet5/0.25 Flags:F NS
Pkts:0/0
GigabitEthernet5/0.24 Flags:F NS
Pkts:0/0
.
.
.
GigabitEthernet5/0.16 Flags:F NS
Pkts:0/0
The following example shows forwarding entries and interfaces in the MFIB, with a group address
of FFE0 and a prefix of 15:
# show ipv6 mfib FFE0::/15
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
634
IP Addressing Services
show ipv6 mfib
IP Multicast Forwarding Information Base
Entry Flags:C - Directly Connected, S - Signal, IA - Inherit A flag,
AR - Activity Required, D - Drop
Forwarding Counts:Pkt Count/Pkts per second/Avg Pkt Size/Kbits per second
Other counts:Total/RPF failed/Other drops
Interface Flags:A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts:FS Pkt Count/PS Pkt Count
(*,FFE0::/15) Flags:D
Forwarding:0/0/0/0, Other:0/0/0
The following example shows output of the show ipv6 mfib command used with the verbose keyword.
It shows forwarding entries and interfaces in the MFIB and additional information such as the MAC
encapsulation header and platform-specific information.
# show ipv6 mfib ff33::1:1 verbose
IP Multicast Forwarding Information Base
Entry Flags: C - Directly Connected, S - Signal, IA - Inherit A flag,
AR - Activity Required, K - Keepalive
Forwarding Counts: Pkt Count/Pkts per second/Avg Pkt Size/Kbits per second
Other counts: Total/RPF failed/Other drops
Platform per slot HW-Forwarding Counts: Pkt Count/Byte Count
Platform flags: HF - Forwarding entry,HB - Bridge entry,HD - NonRPF Drop entry,
NP - Not platform switchable,RPL - RPF-ltl linkage,
MCG - Metset change,ERR - S/w Error Flag,RTY - In RetryQ,
LP - L3 pending,MP - Met pending,AP - ACL pending
Interface Flags: A - Accept, F - Forward, NS - Negate Signalling
IC - Internal Copy, NP - Not platform switched
SP - Signal Present
Interface Counts: Distributed FS Pkt Count/FS Pkt Count/PS Pkt Count
(10::2,FF33::1:1) Flags: K
RP Forwarding: 0/0/0/0, Other: 0/0/0
LC Forwarding: 0/0/0/0, Other: 0/0/0
HW Forwd: 0/0/0/0, Other: NA/NA/NA
Slot 6: HW Forwarding: 0/0, Platform Flags: HF RPL
Slot 1: HW Forwarding: 0/0, Platform Flags: HF RPL
Vlan10 Flags: A
Vlan30 Flags: F NS
Pkts: 0/0/0 MAC: 33330001000100D0FFFE180086DD
The table below describes the fields shown in the display.
Table 60: show ipv6 mfib verbose Field Descriptions
Field Description
Platform flags Information about the platform.
Platform per slot HW-Forwarding Counts Total number of packets per bytes forwarded.
Related Commands Command Description
show ipv6 mfib active Displays the rate at which active sources are sending to multicast groups.
show ipv6 mfib count Displays summary traffic statistics from the MFIB about the group and source.
show ipv6 mfib interface Displays information about IPv6 multicast-enabled interfaces and their
forwarding status.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
635
IP Addressing Services
show ipv6 mfib
Command Description
show ipv6 mfib status Displays the general MFIB configuration and operational status.
show ipv6 mfib summary Displays summary information about the number of IPv6 MFIB entries
(including link-local groups) and interfaces.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
636
IP Addressing Services
show ipv6 mld groups
show ipv6 mld groups
To display the multicast groups that are directly connected to the router and that were learned through Multicast
Listener Discovery (MLD), use the show ipv6 mld groups command in user EXEC or privileged EXEC
mode.
show ipv6 mld [vrf vrf-name] groups [link-local] [{group-namegroup-address}] [interface-type
interface-number] [{detail | explicit}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
link-local (Optional) Displays the link-local groups.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
interface-type interface-number (Optional) Interface type and number.
detail (Optional) Displays detailed information about individual sources.
explicit (Optional) Displays information about the hosts being explicitly tracked
on each interface for each group.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If you omit all optional arguments, the show ipv6 mld groups command displays by group address and
interface type and number all directly connected multicast groups, including link-local groups (where the
link-local keyword is not available) used.
Examples The following is sample output from the show ipv6 mld groups command. It shows all of the groups
joined by Fast Ethernet interface 2/1, including link-local groups used by network protocols.
# show ipv6 mld groups FastEthernet 2/1
MLD Connected Group Membership
Group Address Interface Uptime Expires
FF02::2 FastEthernet2/1 3d18h never
FF02::D FastEthernet2/1 3d18h never
FF02::16 FastEthernet2/1 3d18h never
FF02::1:FF00:1 FastEthernet2/1 3d18h 00:00:27
FF02::1:FF00:79 FastEthernet2/1 3d18h never
FF02::1:FF23:83C2 FastEthernet2/1 3d18h 00:00:22
FF02::1:FFAF:2C39 FastEthernet2/1 3d18h never
FF06:7777::1 FastEthernet2/1 3d18h 00:00:26
The following is sample output from the show ipv6 mld groups command using the detail keyword:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
637
IP Addressing Services
show ipv6 mld groups
# show ipv6 mld groups detail
Interface: Ethernet2/1/1
Group: FF33::1:1:1
Uptime: 00:00:11
Router mode: INCLUDE
Host mode: INCLUDE
Last reporter: FE80::250:54FF:FE60:3B14
Group source list:
Source Address Uptime Expires Fwd Flags
2004:4::6 00:00:11 00:04:08 Yes Remote Ac 4
The following is sample output from the show ipv6 mld groups command using the explicit keyword:
# show ipv6 mld groups explicit
Ethernet1/0, FF05::1
Up:00:43:11 EXCLUDE(0/1) Exp:00:03:17
Host Address Uptime Expires
FE80::A8BB:CCFF:FE00:800 00:43:11 00:03:17
Mode:EXCLUDE
Ethernet1/0, FF05::6
Up:00:42:22 INCLUDE(1/0) Exp:not used
Host Address Uptime Expires
FE80::A8BB:CCFF:FE00:800 00:42:22 00:03:17
Mode:INCLUDE
300::1
300::2
300::3
Ethernet1/0 - Interface
ff05::1 - Group address
Up:Uptime for the group
EXCLUDE/INCLUDE - The mode the group is in on the router.
(0/1) (1/0) - (Number of hosts in INCLUDE mode/Number of hosts in EXCLUDE moe)
Exp:Expiry time for the group.
FE80::A8BB:CCFF:FE00:800 - Host ipv6 address.
00:43:11 - Uptime for the host.
00:03:17 - Expiry time for the host
Mode:INCLUDE/EXCLUDE - Mode the Host is operating in.
300::1, 300::2, 300::3 - Sources that the host has joined in the above specified mode.
The table below describes the significant fields shown in the display.
Table 61: show ipv6 mld groups Field Descriptions
Field Description
Group Address Address of the multicast group.
Interface Interface through which the group is reachable.
Uptime How long (in hours, minutes, and seconds) this multicast group has been known.
Expires How long (in hours, minutes, and seconds) until the entry is removed from the MLD groups
table.
The expiration timer shows "never" if the router itself has joined the group, and the expiration
timer shows "not used" when the router mode of the group is INCLUDE. In this situation,
the expiration timers on the source entries are used.
Last reporter: Last host to report being a member of the multicast group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
638
IP Addressing Services
show ipv6 mld groups
Field Description
Flags Ac 4 Flags counted toward the MLD state limits configured.
Related Commands Command Description
ipv6 mld query-interval Configures the frequency at which the Cisco IOS software sends MLD host-query
messages.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
639
IP Addressing Services
show ipv6 mld interface
show ipv6 mld interface
To display multicast-related information about an interface, use the show ipv6 mld interface command in
user EXEC or privileged EXEC mode.
show ipv6 mld [vrf vrf-name] interface [type number]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
type number (Optional) Interface type and number.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If you omit the optional type and number arguments, the show ipv6 mld interface command displays
information about all interfaces.
Examples The following is sample output from the show ipv6 mld interface command for Ethernet interface
2/1/1:
# show ipv6 mld interface Ethernet 2/1/1
Global State Limit : 2 active out of 2 max
Loopback0 is administratively down, line protocol is down
Internet address is ::/0
.
.
.
Ethernet2/1/1 is up, line protocol is up
Internet address is FE80::260:3EFF:FE86:5649/10
MLD is enabled on interface
Current MLD version is 2
MLD query interval is 125 seconds
MLD querier timeout is 255 seconds
MLD max query response time is 10 seconds
Last member query response interval is 1 seconds
Interface State Limit : 2 active out of 3 max
State Limit permit access list:
MLD activity: 83 joins, 63 leaves
MLD querying router is FE80::260:3EFF:FE86:5649 (this system)
The table below describes the significant fields shown in the display.
Table 62: show ipv6 mld interface Field Descriptions
Field Description
Global State Limit: 2 active out of 2 max Two globally configured MLD states are active.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
640
IP Addressing Services
show ipv6 mld interface
Field Description
Ethernet2/1/1 is up, line protocol is up Interface type, number, and status.
Internet address is... Internet address of the interface and subnet mask being applied
to the interface.
MLD is enabled in interface Indicates whether Multicast Listener Discovery (MLD) has been
enabled on the interface with the ipv6 multicast-routing
command.
Current MLD version is 2 The current MLD version.
MLD query interval is 125 seconds Interval (in seconds) at which the Cisco IOS software sends MLD
query messages, as specified with the ipv6 mld query-interval
command.
MLD querier timeout is 255 seconds The length of time (in seconds) before the router takes over as
the querier for the interface, as specified with the ipv6 mld
query-timeout command.
MLD max query response time is 10 The length of time (in seconds) that hosts have to answer an MLD
seconds Query message before the router deletes their group, as specified
with the ipv6 mld query-max-response-time command.
Last member query response interval is 1 Used to calculate the maximum response code inserted in group
seconds and source-specific query. Also used to tune the "leave latency"
of the link. A lower value results in reduced time to detect the
last member leaving the group.
Interface State Limit : 2 active out of 3 Two out of three configured interface states are active.
max
State Limit permit access list: change Activity for the state permit access list.
MLD activity: 83 joins, 63 leaves Number of groups joins and leaves that have been received.
MLD querying router is IPv6 address of the querying router.
FE80::260:3EFF:FE86:5649 (this system)
Related Commands Command Description
ipv6 mld join-group Configures MLD reporting for a specified group and source.
ipv6 mld query-interval Configures the frequency at which the Cisco IOS software sends MLD host-query
messages.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
641
IP Addressing Services
show ipv6 mld snooping
show ipv6 mld snooping
Use the show ipv6 mld snooping command in EXEC mode to display IP version 6 (IPv6) Multicast Listener
Discovery (MLD) snooping configuration of the switch or the VLAN.
show ipv6 mld snooping [vlan vlan-id]
Syntax Description vlan vlan-id (Optional) Specify a VLAN; the range is 1 to 1001 and 1006 to 4094.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to display MLD snooping configuration for the switch or for a specific VLAN.
VLAN numbers 1002 through 1005 are reserved for Token Ring and FDDI VLANs and cannot be used in
MLD snooping.
To configure the dual IPv4 and IPv6 template, enter the sdm prefer dual-ipv4-and-ipv6 global configuration
command and reload the switch.
Examples This is an example of output from the show ipv6 mld snooping vlan command. It shows snooping
characteristics for a specific VLAN.
# show ipv6 mld snooping vlan 100
Global MLD Snooping configuration:
-------------------------------------------
MLD snooping : Enabled
MLDv2 snooping (minimal) : Enabled
Listener message suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Robustness variable : 3
Last listener query count : 2
Last listener query interval : 1000
Vlan 100:
--------
MLD snooping : Disabled
MLDv1 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
Robustness variable : 3
Last listener query count : 2
Last listener query interval : 1000
This is an example of output from the show ipv6 mld snooping command. It displays snooping
characteristics for all VLANs on the switch.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
642
IP Addressing Services
show ipv6 mld snooping
# show ipv6 mld snooping
Global MLD Snooping configuration:
-------------------------------------------
MLD snooping : Enabled
MLDv2 snooping (minimal) : Enabled
Listener message suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Robustness variable : 3
Last listener query count : 2
Last listener query interval : 1000
Vlan 1:
--------
MLD snooping : Disabled
MLDv1 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
Robustness variable : 1
Last listener query count : 2
Last listener query interval : 1000
<output truncated>
Vlan 951:
--------
MLD snooping : Disabled
MLDv1 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
Robustness variable : 3
Last listener query count : 2
Last listener query interval : 1000
Related Commands Command Description
ipv6 mld snooping Enables and configures MLD snooping on the switch or on a VLAN.
sdm prefer Configures an SDM template to optimize system resources based on how the switch
is being used.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
643
IP Addressing Services
show ipv6 mld ssm-map
show ipv6 mld ssm-map
To display Source Specific Multicast (SSM) mapping information, use the show ipv6 mld ssm-map static
command in user EXEC or privileged EXEC mode.
show ipv6 mld [vrf vrf-name] ssm-map [source-address]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
source-address (Optional) Source address associated with an MLD membership for a group identified by
the access list.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If the optional source-address argument is not used, all SSM mapping information is displayed.
Examples The following example shows all SSM mappings for the router:
# show ipv6 mld ssm-map
SSM Mapping : Enabled
DNS Lookup : Enabled
The following examples show SSM mapping for the source address 2001:0DB8::1:
# show ipv6 mld ssm-map 2001:0DB8::1
Group address : 2001:0DB8::1
Group mode ssm : TRUE
Database : STATIC
Source list : 2001:0DB8::2
2001:0DB8::3
Router# show ipv6 mld ssm-map 2001:0DB8::2
Group address : 2001:0DB8::2
Group mode ssm : TRUE
Database : DNS
Source list : 2001:0DB8::3
2001:0DB8::1
The table below describes the significant fields shown in the displays.
Table 63: show ipv6 mld ssm-map Field Descriptions
Field Description
SSM Mapping The SSM mapping feature is enabled.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
644
IP Addressing Services
show ipv6 mld ssm-map
Field Description
DNS Lookup The DNS lookup feature is automatically enabled when the SSM mapping feature
is enabled.
Group address Group address identified by a specific access list.
Group mode ssm : TRUE The identified group is functioning in SSM mode.
Database : STATIC The router is configured to determine source addresses by checking static SSM
mapping configurations.
Database : DNS The router is configured to determine source addresses using DNS-based SSM
mapping.
Source list Source address associated with a group identified by the access list.
Related Commands Command Description
debug ipv6 mld ssm-map Displays debug messages for SSM mapping.
ipv6 mld ssm-map enable Enables the SSM mapping feature for groups in the configured SSM range
ipv6 mld ssm-map query dns Enables DNS-based SSM mapping.
ipv6 mld ssm-map static Configures static SSM mappings.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
645
IP Addressing Services
show ipv6 mld traffic
show ipv6 mld traffic
To display the Multicast Listener Discovery (MLD) traffic counters, use the show ipv6 mld traffic command
in user EXEC or privileged EXEC mode.
show ipv6 mld [vrf vrf-name] traffic
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 mld traffic command to check if the expected number of MLD protocol messages have
been received and sent.
Examples The following example displays the MLD protocol messages received and sent.
# show ipv6 mld traffic
MLD Traffic Counters
Elapsed time since counters cleared:00:00:21
Received Sent
Valid MLD Packets 3 1
Queries 1 0
Reports 2 1
Leaves 0 0
Mtrace packets 0 0
Errors:
Malformed Packets 0
Bad Checksums 0
Martian source 0
Packets Received on MLD-disabled Interface 0
The table below describes the significant fields shown in the display.
Table 64: show ipv6 mld traffic Field Descriptions
Field Description
Elapsed time since counters cleared Indicates the amount of time (in hours, minutes, and seconds) since the
counters cleared.
Valid MLD packets Number of valid MLD packets received and sent.
Queries Number of valid queries received and sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
646
IP Addressing Services
show ipv6 mld traffic
Field Description
Reports Number of valid reports received and sent.
Leaves Number of valid leaves received and sent.
Mtrace packets Number of multicast trace packets received and sent.
Errors Types of errors and the number of errors that have occurred.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
647
IP Addressing Services
show ipv6 mrib client
show ipv6 mrib client
To display information about the clients of the Multicast Routing Information Base (MRIB), use the show
ipv6 mrib client command in user EXEC or privileged EXEC mode.
show ipv6 mrib [vrf vrf-name] client [filter] [name {client-name | client-name : client-id}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
filter (Optional) Displays information about MRIB flags that each client owns and that
each client is interested in.
name (Optional) The name of a multicast routing protocol that acts as a client of MRIB,
such as Multicast Listener Discovery (MLD) and Protocol Independent Multicast
(PIM).
client-name : client-id The name and ID of a multicast routing protocol that acts as a client of MRIB,
such as MLD and PIM. The colon is required.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the filter keyword to display information about the MRIB flags each client owns and the flags in which
each client is interested.
Examples The following is sample output from the show ipv6 mrib client command:
# show ipv6 mrib client
IP MRIB client-connections
igmp:145 (connection id 0)
pim:146 (connection id 1)
mfib ipv6:3 (connection id 2)
slot 3 mfib ipv6 rp agent:16 (connection id 3)
slot 1 mfib ipv6 rp agent:16 (connection id 4)
slot 0 mfib ipv6 rp agent:16 (connection id 5)
slot 4 mfib ipv6 rp agent:16 (connection id 6)
slot 2 mfib ipv6 rp agent:16 (connection id 7)
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
648
IP Addressing Services
show ipv6 mrib client
Table 65: show ipv6 mrib client Field Descriptions
Field Description
igmp:145 (connection id 0) pim:146 (connection id 1) mfib ipv6:3 Client ID (client name:process ID)
(connection id 2) mfib ipv6 rp agent:16 (connection id 3)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
649
IP Addressing Services
show ipv6 mrib route
show ipv6 mrib route
To display Multicast Routing Information Base (MRIB) route information, use the show ipv6 mrib route
command in user EXEC or privileged EXEC mode.
show ipv6 mrib [vrf vrf-name] route [{link-local | summary | [{source-addresssource-name | *}]
[groupname-or-address [prefix-length]]}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
link-local (Optional) Displays the link-local groups.
summary (Optional) Displays the number of MRIB entries (including link-local groups)
and interfaces present in the MRIB table.
source address-or-name (Optional) IPv6 address or name of the source.
* (Optional) Displays all MRIB route information.
groupname or-address (Optional) IPv6 address or name of the multicast group.
prefix-length (Optional) IPv6 prefix length.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines All entries are created by various clients of the MRIB, such as Multicast Listener Discovery (MLD), Protocol
Independent Multicast (PIM), and Multicast Forwarding Information Base (MFIB). The flags on each entry
or interface serve as a communication mechanism between various clients of the MRIB. The entries reveal
how PIM sends register messages for new sources and the action taken.
The summary keyword shows the count of all entries, including link-local entries.
The interface flags are described in the table below.
Table 66: Description of Interface Flags
Flag Description
F Forward--Data is forwarded out of this interface
A Accept--Data received on this interface is accepted for forwarding
IC Internal copy
NS Negate signal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
650
IP Addressing Services
show ipv6 mrib route
Flag Description
DP Do not preserve
SP Signal present
II Internal interest
ID Internal uninterest
LI Local interest
LD Local uninterest
C Perform directly connected check
Special entries in the MRIB indicate exceptions from the normal behavior. For example, no signaling or
notification is necessary for arriving data packets that match any of the special group ranges. The special
group ranges are as follows:
• Undefined scope (FFX0::/16)
• Node local groups (FFX1::/16)
• Link-local groups (FFX2::/16)
• Source Specific Multicast (SSM) groups (FF3X::/32).
For all the remaining (usually sparse-mode) IPv6 multicast groups, a directly connected check is performed
and the PIM notified if a directly connected source arrives. This procedure is how PIM sends register messages
for new sources.
Examples The following is sample output from the show ipv6 mrib route command using the summary
keyword:
# show ipv6 mrib route summary
MRIB Route-DB Summary
No. of (*,G) routes = 52
No. of (S,G) routes = 0
No. of Route x Interfaces (RxI) = 10
The table below describes the significant fields shown in the display.
Table 67: show ipv6 mrib route Field Descriptions
Field Description
No. of (*, G) routes Number of shared tree routes in the MRIB.
No. of (S, G) routes Number of source tree routes in the MRIB.
No. of Route x Interfaces (RxI) Sum of all the interfaces on each MRIB route entry.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
651
IP Addressing Services
show ipv6 mroute
show ipv6 mroute
To display the information in the PIM topology table in a format similar to the show ip mroute command,
use the show ipv6 mroute command in user EXEC or privileged EXEC mode.
show ipv6 mroute [vrf vrf-name] [{link-local | [{group-name | group-address
[{source-addresssource-name}]}]}] [summary] [count]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
link-local (Optional) Displays the link-local groups.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
source-address | source-name (Optional) IPv6 address or name of the source.
summary (Optional) Displays a one-line, abbreviated summary of each entry in the
IPv6 multicast routing table.
count (Optional) Displays statistics from the Multicast Forwarding Information
Base (MFIB) about the group and source, including number of packets,
packets per second, average packet size, and bytes per second.
Command Default The show ipv6 mroute command displays all groups and sources.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The IPv6 multicast implementation does not have a separate mroute table. For this reason, the show ipv6
mroute command enables you to display the information in the PIM topology table in a format similar to the
show ip mroute command.
If you omit all optional arguments and keywords, the show ipv6 mroute command displays all the entries in
the PIM topology table (except link-local groups where the link-local keyword is available).
The Cisco IOS software populates the PIM topology table by creating (S,G) and (*,G) entries based on PIM
protocol messages, MLD reports, and traffic. The asterisk (*) refers to all source addresses, the "S" refers to
a single source address, and the "G" is the destination multicast group address. In creating (S, G) entries, the
software uses the best path to that destination group found in the unicast routing table (that is, through Reverse
Path Forwarding [RPF]).
Use the show ipv6 mroute command to display the forwarding status of each IPv6 multicast route.
Examples The following is sample output from the show ipv6 mroute command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
652
IP Addressing Services
show ipv6 mroute
# show ipv6 mroute ff07::1
Multicast Routing Table
Flags:D - Dense, S - Sparse, B - Bidir Group, s - SSM Group,
C - Connected, L - Local, I - Received Source Specific Host Report,
P - Pruned, R - RP-bit set, F - Register flag, T - SPT-bit set,
J - Join SPT
Timers:Uptime/Expires
Interface state:Interface, State
(*, FF07::1), 00:04:45/00:02:47, RP 2001:0DB8:6::6, flags:S
Incoming interface:Tunnel5
RPF nbr:6:6:6::6
Outgoing interface list:
POS4/0, Forward, 00:04:45/00:02:47
(2001:0DB8:999::99, FF07::1), 00:02:06/00:01:23, flags:SFT
Incoming interface:POS1/0
RPF nbr:2001:0DB8:999::99
Outgoing interface list:
POS4/0, Forward, 00:02:06/00:03:27
The following is sample output from the show ipv6 mroute command with the summary keyword:
# show ipv6 mroute ff07::1 summary
Multicast Routing Table
Flags:D - Dense, S - Sparse, B - Bidir Group, s - SSM Group,
C - Connected, L - Local, I - Received Source Specific Host Report,
P - Pruned, R - RP-bit set, F - Register flag, T - SPT-bit set,
J - Join SPT
Timers:Uptime/Expires
Interface state:Interface, State
(*, FF07::1), 00:04:55/00:02:36, RP 2001:0DB8:6::6, OIF count:1, flags:S
(2001:0DB8:999::99, FF07::1), 00:02:17/00:01:12, OIF count:1, flags:SFT
The following is sample output from the show ipv6 mroute command with the count keyword:
# show ipv6 mroute ff07::1 count
IP Multicast Statistics
71 routes, 24 groups, 0.04 average sources per group
Forwarding Counts:Pkt Count/Pkts per second/Avg Pkt Size/Kilobits per second
Other counts:Total/RPF failed/Other drops(OIF-null, rate-limit etc)
Group:FF07::1
RP-tree:
RP Forwarding:0/0/0/0, Other:0/0/0
LC Forwarding:0/0/0/0, Other:0/0/0
Source:2001:0DB8:999::99,
RP Forwarding:0/0/0/0, Other:0/0/0
LC Forwarding:0/0/0/0, Other:0/0/0
HW Forwd: 20000/0/92/0, Other:0/0/0
Tot. shown:Source count:1, pkt count:20000
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
653
IP Addressing Services
show ipv6 mroute
Table 68: show ipv6 mroute Field Descriptions
Field Description
Flags: Provides information about the entry.
• S--sparse. Entry is operating in sparse mode.
• s--SSM group. Indicates that a multicast group is within the SSM range of IP
addresses. This flag is reset if the SSM range changes.
• C--connected. A member of the multicast group is present on the directly
connected interface.
• L--local. The router itself is a member of the multicast group.
• I--received source specific host report. Indicates that an (S, G) entry was created
by an (S, G) report. This flag is set only on the designated router (DR).
• P--pruned. Route has been pruned. The Cisco IOS software keeps this information
so that a downstream member can join the source.
• R--RP-bit set. Indicates that the (S, G) entry is pointing toward the RP. This is
typically prune state along the shared tree for a particular source.
• F--register flag. Indicates that the software is registering for a multicast source.
• T--SPT-bit set. Indicates that packets have been received on the shortest path
source tree.
• J--join SPT. For (*, G) entries, indicates that the rate of traffic flowing down the
shared tree is exceeding the SPT-Threshold value set for the group. (The default
SPT-Threshold setting is 0 kbps.) When the J - Join shortest path tree (SPT) flag
is set, the next (S, G) packet received down the shared tree triggers an (S, G) join
in the direction of the source, thereby causing the router to join the source tree.
The default SPT-Threshold value of 0 kbps is used for the group, and the J - Join
SPT flag is always set on (*, G) entries and is never cleared. The router
immediately switches to the shortest path source tree when traffic from a new
source is received
Timers: "Uptime" indicates per interface how long (in hours, minutes, and seconds) the entry
Uptime/Expires has been in the IPv6 multicast routing table. "Expires" indicates per interface how long
(in hours, minutes, and seconds) until the entry will be removed from the IPv6 multicast
routing table.
Interface state: Indicates the state of the incoming or outgoing interface.
• Interface. Indicates the type and number of the interface listed in the incoming
or outgoing interface list.
• Next-Hop. "Next-Hop" specifies the IP address of the downstream neighbor.
• State/Mode. "State" indicates that packets will either be forwarded, pruned, or
null on the interface depending on whether there are restrictions due to access
lists. "Mode" indicates that the interface is operating in sparse mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
654
IP Addressing Services
show ipv6 mroute
Field Description
(*, FF07::1) and Entry in the IPv6 multicast routing table. The entry consists of the IPv6 address of the
(2001:0DB8:999::99) source router followed by the IPv6 address of the multicast group. An asterisk (*) in
place of the source router indicates all sources.
Entries in the first format are referred to as (*, G) or "star comma G" entries. Entries
in the second format are referred to as (S, G) or "S comma G" entries; (*, G) entries
are used to build (S, G) entries.
RP Address of the RP router.
flags: Information set by the MRIB clients on this MRIB entry.
Incoming interface: Expected interface for a multicast packet from the source. If the packet is not received
on this interface, it is discarded.
RPF nbr IP address of the upstream router to the RP or source.
Outgoing interface Interfaces through which packets will be forwarded. For (S,G) entries, this list will
list: not include the interfaces inherited from the (*,G) entry.
Related Commands Command Description
ipv6 multicast-routing Enables multicast routing using PIM and MLD on all IPv6-enabled interfaces of
the router and enables multicast forwarding.
show ipv6 mfib Displays the forwarding entries and interfaces in the IPv6 MFIB.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
655
IP Addressing Services
show ipv6 mtu
show ipv6 mtu
To display maximum transmission unit (MTU) cache information for IPv6 interfaces, use the show ipv6 mtu
command in user EXEC or privileged EXEC mode.
show ipv6 mtu [vrf vrfname]
Syntax Description vrf (Optional) Displays an IPv6 Virtual Private Network (VPN) routing/forwarding instance (VRF).
vrfname (Optional) Name of the IPv6 VRF.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The vrf keyword and vrfname argument allow you to view MTUs related to a specific VRF.
Examples The following is sample output from the show ipv6 mtu command:
# show ipv6 mtu
MTU Since Destination Address
1400 00:04:21 5000:1::3
1280 00:04:50 FE80::203:A0FF:FED6:141D
The following is sample output from the show ipv6 mtu command using the vrf keyword and vrfname
argument. This example provides information about the VRF named vrfname1:
# show ipv6 mtu vrf vrfname1
MTU Since Source Address Destination Address
1300 00:00:04 2001:0DB8:2 2001:0DB8:7
The table below describes the significant fields shown in the display.
Table 69: show ipv6 mtu Field Descriptions
Field Description
MTU MTU, which was contained in the Internet Control Message Protocol (ICMP)
packet-too-big message, used for the path to the destination address.
Since Age of the entry since the ICMP packet-too-big message was received.
Destination Address Address contained in the received ICMP packet-too-big message. Packets originating
from this router to this address should be no bigger than the given MTU.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
656
IP Addressing Services
show ipv6 mtu
Related Commands Command Description
ipv6 mtu Sets the MTU size of IPv6 packets sent on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
657
IP Addressing Services
show ipv6 nd destination
show ipv6 nd destination
To display information about IPv6 host-mode destination cache entries, use the show ipv6 nd destination
command in user EXEC or privileged EXEC mode.
show ipv6 nd destination[vrf vrf-name][interface-type interface-number]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface- type (Optional) Specifies the Interface type.
interface- number (Optional) Specifies the Interface number.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 nd destination command to display information about IPv6 host-mode destination cache
entries. If the vrf vrf-name keyword and argument pair is used, then only information about the specified VRF
is displayed. If the interface-type and interface-number arguments are used, then only information about the
specified interface is displayed.
Examples
# show ipv6 nd destination
IPv6 ND destination cache (table: default)
Code: R - Redirect
2001::1 [8]
via FE80::A8BB:CCFF:FE00:5B00/Ethernet0/0
The following table describes the significant fields shown in the display.
Table 70: show ipv6 nd destination Field Descriptions
Field Description
Code: R - Redirect Destinations learned through redirect.
2001::1 [8] The value displayed in brackets is the time, in seconds, since the destination cache entry
was last used.
Related Commands Command Description
ipv6 nd host mode strict Enables the conformant, or strict, IPv6 host mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
658
IP Addressing Services
show ipv6 nd on-link prefix
show ipv6 nd on-link prefix
To display information about on-link prefixes learned through router advertisements (RAs), use the show
ipv6 nd on-link prefix command in user EXEC or privileged EXEC mode.
show ipv6 nd on-link prefix[vrf vrf-name][interface-type interface-number]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface -type (Optional) Specifies the Interface type.
interface -number (Optional) Specifies the Interface number.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 nd on-link prefix command to display information about on-link prefixes learned through
RAs.
Prefixes learned from an RA may be inspected using the show ipv6 nd on-link prefix command. If the vrf
vrf-name keyword and argument pair is used, then only information about the specified VRF is displayed. If
the interface-type and interface-number arguments are used, then only information about the specified
interface is displayed.
Examples The following example displays information about on-link prefixes learned through RAs:
# show ipv6 nd on-link prefix
IPv6 ND on-link Prefix (table: default), 2 prefixes
Code: A - Autonomous Address Config
A 2001::/64 [2591994/604794]
router FE80::A8BB:CCFF:FE00:5A00/Ethernet0/0
2001:1:2::/64 [2591994/604794]
router FE80::A8BB:CCFF:FE00:5A00/Ethernet0/0
Related Commands Command Description
ipv6 nd host mode strict Enables the conformant, or strict, IPv6 host mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
659
IP Addressing Services
show ipv6 neighbors
show ipv6 neighbors
To display IPv6 neighbor discovery (ND) cache information, use the show ipv6 neighbors command in user
EXEC or privileged EXEC mode.
show ipv6 neighbors [{interface-type interface-numberipv6-addressipv6-hostname | statistics}]
Syntax Description interface-type (Optional) Specifies the type of the interface from which IPv6 neighbor information is to
be displayed.
interface-number (Optional) Specifies the number of the interface from which IPv6 neighbor information
is to be displayed.
ipv6-address (Optional) Specifies the IPv6 address of the neighbor.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
ipv6-hostname (Optional) Specifies the IPv6 hostname of the remote networking device.
statistics (Optional) Displays ND cache statistics.
Command Default All IPv6 ND cache entries are listed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When the interface-type and interface-number arguments are not specified, cache information for all IPv6
neighbors is displayed. Specifying the interface-type and interface-number arguments displays only cache
information about the specified interface.
Specifying the statistics keyword displays ND cache statistics.
The following is sample output from the show ipv6 neighbors command when entered with an
interface type and number:
# show ipv6 neighbors ethernet 2
IPv6 Address Age Link-layer Addr State Interface
2000:0:0:4::2 0 0003.a0d6.141e REACH Ethernet2
FE80::203:A0FF:FED6:141E 0 0003.a0d6.141e REACH Ethernet2
3001:1::45a - 0002.7d1a.9472 REACH Ethernet2
The following is sample output from the show ipv6 neighbors command when entered with an IPv6
address:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
660
IP Addressing Services
show ipv6 neighbors
# show ipv6 neighbors 2000:0:0:4::2
IPv6 Address Age Link-layer Addr State Interface
2000:0:0:4::2 0 0003.a0d6.141e REACH Ethernet2
The table below describes the significant fields shown in the displays.
Table 71: show ipv6 neighbors Field Descriptions
Field Description
IPv6 Address IPv6 address of neighbor or interface.
Age Time (in minutes) since the address was confirmed to be reachable. A hyphen (-) indicates
a static entry.
Link-layer MAC address. If the address is unknown, a hyphen (-) is displayed.
Addr
State The state of the neighbor cache entry. Following are the states for dynamic entries in the
IPv6 neighbor discovery cache:
• INCMP (Incomplete)--Address resolution is being performed on the entry. A neighbor
solicitation message has been sent to the solicited-node multicast address of the target,
but the corresponding neighbor advertisement message has not yet been received.
• REACH (Reachable)--Positive confirmation was received within the last ReachableTime
milliseconds that the forward path to the neighbor was functioning properly. While in
REACH state, the device takes no special action as packets are sent.
• STALE--More than ReachableTime milliseconds have elapsed since the last positive
confirmation was received that the forward path was functioning properly. While in
STALE state, the device takes no action until a packet is sent.
• DELAY--More than ReachableTime milliseconds have elapsed since the last positive
confirmation was received that the forward path was functioning properly. A packet
was sent within the last DELAY_FIRST_PROBE_TIME seconds. If no reachability
confirmation is received within DELAY_FIRST_PROBE_TIME seconds of entering
the DELAY state, send a neighbor solicitation message and change the state to PROBE.
• PROBE--A reachability confirmation is actively sought by resending neighbor
solicitation messages every RetransTimer milliseconds until a reachability confirmation
is received.
• ????--Unknown state.
Following are the possible states for static entries in the IPv6 neighbor discovery cache:
• INCMP (Incomplete)--The interface for this entry is down.
• REACH (Reachable)--The interface for this entry is up.
Note Reachability detection is not applied to static entries in the IPv6 neighbor
discovery cache; therefore, the descriptions for the INCMP (Incomplete) and
REACH (Reachable) states are different for dynamic and static cache entries.
Interface Interface from which the address was reachable.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
661
IP Addressing Services
show ipv6 neighbors
The following is sample output from the show ipv6 neighbors command with the statistics keyword:
# show ipv6 neighbor statistics
IPv6 ND Statistics
Entries 2, High-water 2, Gleaned 1, Scavenged 0
Entry States
INCMP 0 REACH 0 STALE 2 GLEAN 0 DELAY 0 PROBE 0
Resolutions (INCMP)
Requested 1, timeouts 0, resolved 1, failed 0
In-progress 0, High-water 1, Throttled 0, Data discards 0
Resolutions (PROBE)
Requested 3, timeouts 0, resolved 3, failed 0
The table below describes the significant fields shown in this display:
Table 72: show ipv6 neighbors statistics Field Descriptions
Field Description
Entries Total number of ND neighbor entries in the ND cache.
High-Water Maximum amount (so far) of ND neighbor entries in ND cache.
Gleaned Number of ND neighbor entries gleaned (that is, learned from a neighbor NA or
other ND packet).
Scavenged Number of stale ND neighbor entries that have timed out and been removed from
the cache.
Entry States Number of ND neighbor entries in each state.
Resolutions (INCMP) Statistics for neighbor resolutions attempted in INCMP state (that is, resolutions
prompted by a data packet). Details about the resolutions attempted in INCMP state
are follows:
• Requested--Total number of resolutions requested.
• Timeouts--Number of timeouts during resolutions.
• Resolved--Number of successful resolutions.
• Failed--Number of unsuccessful resolutions.
• In-progress--Number of resolutions in progress.
• High-water--Maximum number (so far) of resolutions in progress.
• Throttled--Number of times resolution request was ignored due to maximum
number of resolutions in progress limit.
• Data discards--Number of data packets discarded that are awaiting neighbor
resolution.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
662
IP Addressing Services
show ipv6 neighbors
Field Description
Resolutions (PROBE) Statistics for neighbor resolutions attempted in PROBE state (that is, re-resolutions
of existing entries prompted by a data packet):
• Requested--Total number of resolutions requested.
• Timeouts--Number of timeouts during resolutions.
• Resolved--Number of successful resolutions.
• Failed--Number of unsuccessful resolutions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
663
IP Addressing Services
show ipv6 nhrp
show ipv6 nhrp
To display Next Hop Resolution Protocol (NHRP) mapping information, use the show ipv6 nhrp command
in user EXEC or privileged EXEC mode.
show ipv6 nhrp [{dynamic [ipv6-address] | incomplete | static}] [{address | interface}] [{brief |
detail}] [purge]
Syntax Description dynamic (Optional) Displays dynamic (learned) IPv6-to-nonbroadcast multiaccess address (NBMA)
mapping entries. Dynamic NHRP mapping entries are obtained from NHRP
resolution/registration exchanges. See the table below for types, number ranges, and
descriptions.
ipv6-address (Optional) The IPv6 address of the cache entry.
incomplete (Optional) Displays information about NHRP mapping entries for which the IPv6-to-NBMA
is not resolved. See the table below for types, number ranges, and descriptions.
static (Optional) Displays static IPv6-to-NBMA address mapping entries. Static NHRP mapping
entries are configured using the ipv6 nhrp map command. See the table below for types,
number ranges, and descriptions.
address (Optional) NHRP mapping entry for specified protocol addresses.
interface (Optional) NHRP mapping entry for the specified interface. See the table below for types,
number ranges, and descriptions.
brief (Optional) Displays a short output of the NHRP mapping.
detail (Optional) Displays detailed information about NHRP mapping.
purge (Optional) Displays NHRP purge information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The table below lists the valid types, number ranges, and descriptions for the optional interface argument.
Note The valid types can vary according to the platform and interfaces on the platform.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
664
IP Addressing Services
show ipv6 nhrp
Table 73: Valid Types, Number Ranges, and Interface Description
Valid Types Number Ranges Interface Descriptions
async 1 Async
atm 0 to 6 ATM
bvi 1 to 255 Bridge-Group Virtual Interface
cdma-ix 1 CDMA Ix
ctunnel 0 to 2147483647 C-Tunnel
dialer 0 to 20049 Dialer
ethernet 0 to 4294967295 Ethernet
fastethernet 0 to 6 FastEthernet IEEE 802.3
lex 0 to 2147483647 Lex
loopback 0 to 2147483647 Loopback
mfr 0 to 2147483647 Multilink Frame Relay bundle
multilink 0 to 2147483647 Multilink-group
null 0 Null
port-channel 1 to 64 Port channel
tunnel 0 to 2147483647 Tunnel
vif 1 PGM multicast host
virtual-ppp 0 to 2147483647 Virtual PPP
virtual-template 1 to 1000 Virtual template
virtual-tokenring 0 to 2147483647 Virtual Token Ring
xtagatm 0 to 2147483647 Extended tag ATM
Examples The following is sample output from the show ipv6 nhrp command:
# show ipv6 nhrp
2001:0db8:3c4d:0015::1a2f:3d2c/48 via
2001:0db8:3c4d:0015::1a2f:3d2c
Tunnel0 created 6d05h, never expire
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
665
IP Addressing Services
show ipv6 nhrp
Table 74: show ipv6 nhrp Field Descriptions
Field Description
2001:0db8:3c4d:0015::1a2f: 3d2c/48 Target network.
2001:0db8:3c4d:0015::1a2f:3d2c Next hop to reach the target network.
Tunnel0 Interface through which the target network is reached.
created 6d05h Length of time since the entry was created (dayshours).
never expire Indicates that static entries never expire.
The following is sample output from the show ipv6 nhrp command using the brief keyword:
# show ipv6 nhrp brief
2001:0db8:3c4d:0015:0000:0000:1a2f:3d2c/48
via 2001:0db8:3c4d:0015:0000:0000:1a2f:3d2c
Interface: Tunnel0 Type: static
NBMA address: 10.11.11.99
The table below describes the significant fields shown in the display.
Table 75: show ipv6 nhrp brief Field Descriptions
Field Description
2001:0db8:3c4d:0015:0000:0000: Target network.
1a2f:3d2c/48
via Next Hop to reach the target network.
2001:0db8:3c4d:0015:0000:0000:
1a2f:3d2c
Interface: Tunnel0 Interface through which the target network is reached.
Type: static Type of tunnel. The types can be one of the following:
• dynamic--NHRP mapping is obtained dynamically. The mapping
entry is created using information from the NHRP resolution and
registrations.
• static--NHRP mapping is configured statically. Entries configured
by the ipv6 nhrp map command are marked static.
• incomplete--The NBMA address is not known for the target
network.
Related Commands Command Description
ipv6 nhrp map Statically configures the IPv6-to-NBMA address mapping of IP destinations connected
to an NBMA network.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
666
IP Addressing Services
show ipv6 ospf
show ipv6 ospf
To display general information about Open Shortest Path First ( OSPF) routing processes, use the show ipv6
ospf command in user EXEC or privileged EXEC mode.
show ipv6 ospf [process-id] [area-id] [rate-limit]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when the OSPF routing process is
enabled.
area-id (Optional) Area ID. This argument displays information about a specified area only.
rate-limit (Optional) Rate-limited link-state advertisements (LSAs). This keyword displays LSAs that
are currently being rate limited, together with the remaining time to the next generation.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
show ipv6 ospf Output Example
The following is sample output from the show ipv6 ospf command:
# show ipv6 ospf
Routing Process "ospfv3 1" with ID 10.10.10.1
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x000000
Number of areas in this device is 1. 1 normal 0 stub 0 nssa
Area BACKBONE(0)
Number of interfaces in this area is 1
MD5 Authentication, SPI 1000
SPF algorithm executed 2 times
Number of LSA 5. Checksum Sum 0x02A005
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
667
IP Addressing Services
show ipv6 ospf
Table 76: show ipv6 ospf Field Descriptions
Field Description
Routing process "ospfv3 1" with ID 10.10.10.1 Process ID and OSPF device ID.
LSA group pacing timer Configured LSA group pacing timer (in seconds).
Interface flood pacing timer Configured LSA flood pacing timer (in milliseconds).
Retransmission pacing timer Configured LSA retransmission pacing timer (in
milliseconds).
Number of areas Number of areas in device, area addresses, and so on.
show ipv6 ospf With Area Encryption Example
The following sample output shows the show ipv6 ospf command with area encryption information:
# show ipv6 ospf
Routing Process "ospfv3 1" with ID 10.0.0.1
It is an area border device
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x000000
Number of areas in this device is 2. 2 normal 0 stub 0 nssa
Reference bandwidth unit is 100 mbps
Area BACKBONE(0)
Number of interfaces in this area is 2
SPF algorithm executed 3 times
Number of LSA 31. Checksum Sum 0x107493
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 20
Flood list length 0
Area 1
Number of interfaces in this area is 2
NULL Encryption SHA-1 Auth, SPI 1001
SPF algorithm executed 7 times
Number of LSA 20. Checksum Sum 0x095E6A
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
The table below describes the significant fields shown in the display.
Table 77: show ipv6 ospf with Area Encryption Information Field Descriptions
Field Description
Area 1 Subsequent fields describe area 1.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
668
IP Addressing Services
show ipv6 ospf
Field Description
NULL Encryption SHA-1 Auth, SPI Displays the encryption algorithm (in this case, null, meaning no
1001 encryption algorithm is used), the authentication algorithm (SHA-1),
and the security policy index (SPI) value (1001).
The following example displays the configuration values for SPF and LSA throttling timers:
# show ipv6 ospf
Routing Process "ospfv3 1" with ID 10.9.4.1
Event-log enabled, Maximum number of events: 1000, Mode: cyclic
It is an autonomous system boundary device
Redistributing External Routes from,
ospf 2
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Minimum LSA interval 5 secs
Minimum LSA arrival 1000 msecs
The table below describes the significant fields shown in the display.
Table 78: show ipv6 ospf with SPF and LSA Throttling Timer Field Descriptions
Field Description
Initial SPF schedule delay Delay time of SPF calculations.
Minimum hold time between two consecutive Minimum hold time between consecutive SPF calculations.
SPFs
Maximum wait time between two consecutive Maximum hold time between consecutive SPF
SPFs 10000 msecs calculations.
Minimum LSA interval 5 secs Minimum time interval (in seconds) between link-state
advertisements.
Minimum LSA arrival 1000 msecs Maximum arrival time (in milliseconds) of link-state
advertisements.
The following example shows information about LSAs that are currently being rate limited:
# show ipv6 ospf rate-limit
List of LSAs that are in rate limit Queue
LSAID: 0.0.0.0 Type: 0x2001 Adv Rtr: 10.55.55.55 Due in: 00:00:00.500
LSAID: 0.0.0.0 Type: 0x2009 Adv Rtr: 10.55.55.55 Due in: 00:00:00.500
The table below describes the significant fields shown in the display.
Table 79: show ipv6 ospf rate-limit Field Descriptions
Field Description
LSAID Link-state ID of the LSA.
Type Description of the LSA.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
669
IP Addressing Services
show ipv6 ospf
Field Description
Adv Rtr ID of the advertising device.
Due in: Remaining time until the generation of the next event.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
670
IP Addressing Services
show ipv6 ospf border-routers
show ipv6 ospf border-routers
To display the internal Open Shortest Path First (OSPF) routing table entries to an Area Border Router (ABR)
and Autonomous System Boundary Router (ASBR), use the show ipv6 ospf border-routers command in
user EXEC or privileged EXEC mode.
show ip ospf [process-id] border-routers
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when the OSPF routing process is
enabled.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following is sample output from the show ipv6 ospf border-routers command:
# show ipv6 ospf border-routers
OSPFv3 Process 1 internal Routing Table
Codes: i - Intra-area route, I - Inter-area route
i 172.16.4.4 [2] via FE80::205:5FFF:FED3:5808, FastEthernet0/0, ABR, Area 1, SPF 13
i 172.16.4.4 [1] via FE80::205:5FFF:FED3:5406, POS4/0, ABR, Area 0, SPF 8
i 172.16.3.3 [1] via FE80::205:5FFF:FED3:5808, FastEthernet0/0, ASBR, Area 1, SPF 3
The table below describes the significant fields shown in the display.
Table 80: show ipv6 ospf border-routers Field Descriptions
Field Description
i - Intra-area route, I - Inter-area route The type of this route.
172.16.4.4, 172.16.3.3 Router ID of the destination router.
[2], [1] Metric used to reach the destination router.
FE80::205:5FFF:FED3:5808, Link-local routers.
FE80::205:5FFF:FED3:5406,
FE80::205:5FFF:FED3:5808
FastEthernet0/0, POS4/0 The interface on which the IPv6 OSPF protocol is
configured.
ABR Area border router.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
671
IP Addressing Services
show ipv6 ospf border-routers
Field Description
ASBR Autonomous system boundary router.
Area 0, Area 1 The area ID of the area from which this route is learned.
SPF 13, SPF 8, SPF 3 The internal number of the shortest path first (SPF)
calculation that installs this route.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
672
IP Addressing Services
show ipv6 ospf event
show ipv6 ospf event
To display detailed information about IPv6 Open Shortest Path First (OSPF) events, use the show ipv6 ospf
event command in privileged EXEC mode.
show ipv6 ospf [process-id] event [{generic | interface | lsa | neighbor | reverse | rib | spf}]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when the OSPF routing process is
enabled.
generic (Optional) Generic information regarding OSPF for IPv6 events.
interface (Optional) Interface state change events, including old and new states.
lsa (Optional) LSA arrival and LSA generation events.
neighbor (Optional) Neighbor state change events, including old and new states.
reverse (Optional) Keyword to allow the display of events in reverse-from the latest to the oldest or
from oldest to the latest.
rib (Optional) Routing Information Base (RIB) update, delete, and redistribution events.
spf (Optional) Scheduling and SPF run events.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines An OSPF event log is kept for every OSPF instance. If you enter no keywords with the show ipv6 ospf event
command, all information in the OSPF event log is displayed. Use the keywords to filter specific information.
Examples The following example shows scheduling and SPF run events, LSA arrival and LSA generation
events, in order from the oldest events to the latest generated events:
# show ipv6 ospf event spf lsa reverse
OSPFv3 Router with ID (10.0.0.1) (Process ID 1)
1 *Sep 29 11:59:18.367: Rcv Changed Type-0x2009 LSA, LSID 10.0.0.0, Adv-Rtr 192.168.0.1,
Seq# 80007699, Age 3600
3 *Sep 29 11:59:18.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type P
4 *Sep 29 11:59:18.367: Rcv Changed Type-0x2001 LSA, LSID 10.0.0.0, Adv-Rtr 192.168.0.1,
Seq# 80007699, Age 2
5 *Sep 29 11:59:18.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type R
6 *Sep 29 11:59:18.367: Rcv Changed Type-0x2002 LSA, LSID 10.1.0.1, Adv-Rtr 192.168.0.1,
Seq# 80007699, Age 3600
8 *Sep 29 11:59:18.367: Schedule SPF, Area 0, Change in LSID 10.1.0.1, LSA type N
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
673
IP Addressing Services
show ipv6 ospf event
9 *Sep 29 11:59:18.367: Rcv Changed Type-0x2001 LSA, LSID 10.0.0.0, Adv-Rtr 1.1.1.1, Seq#
80007699, Age 2
10 *Sep 29 11:59:18.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type R
11 *Sep 29 11:59:18.867: Starting SPF
12 *Sep 29 11:59:18.867: Starting Intra-Area SPF in Area 0
16 *Sep 29 11:59:18.867: Starting Inter-Area SPF in area 0
17 *Sep 29 11:59:18.867: Starting External processing
18 *Sep 29 11:59:18.867: Starting External processing in area 0
19 *Sep 29 11:59:18.867: Starting External processing in area 1
20 *Sep 29 11:59:18.867: End of SPF
21 *Sep 29 11:59:19.367: Generate Changed Type-0x2003 LSA, LSID 10.0.0.4, Seq# 80000002,
Age 3600, Area 1, Prefix 3000:11:22::/64
23 *Sep 29 11:59:20.367: Rcv Changed Type-0x2009 LSA, LSID 10.0.0.0, Adv-Rtr 192.168.0.1,
Seq# 8000769A, Age 2
24 *Sep 29 11:59:20.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type P
25 *Sep 29 11:59:20.367: Rcv Changed Type-0x2001 LSA, LSID 10.0.0.0, Adv-Rtr 192.168.0.1,
Seq# 8000769A, Age 2
26 *Sep 29 11:59:20.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type R
27 *Sep 29 11:59:20.367: Rcv Changed Type-0x2002 LSA, LSID 10.1.0.1, Adv-Rtr 192.168.0.1,
Seq# 8000769A, Age 2
28 *Sep 29 11:59:20.367: Schedule SPF, Area 0, Change in LSID 10.1.0.1, LSA type N
29 *Sep 29 11:59:20.367: Rcv Changed Type-0x2001 LSA, LSID 10.0.0.0, Adv-Rtr 1.1.1.1, Seq#
8000769A, Age 2
30 *Sep 29 11:59:20.367: Schedule SPF, Area 0, Change in LSID 10.0.0.0, LSA type R
31 *Sep 29 11:59:20.867: Starting SPF
32 *Sep 29 11:59:20.867: Starting Intra-Area SPF in Area 0
36 *Sep 29 11:59:20.867: Starting Inter-Area SPF in area 0
37 *Sep 29 11:59:20.867: Starting External processing
38 *Sep 29 11:59:20.867: Starting External processing in area 0
39 *Sep 29 11:59:20.867: Starting External processing in area 1
40 *Sep 29 11:59:20.867: End of SPF
The table below describes the significant fields shown in the display.
Table 81: show ip ospf Field Descriptions
Field Description
OSPFv3 Router with ID (10.0.0.1) (Process Process ID and OSPF router ID.
ID 1)
Rcv Changed Type-0x2009 LSA Description of newly arrived LSA.
LSID Link-state ID of the LSA.
Adv-Rtr ID of the advertising router.
Seq# Link state sequence number (detects old or duplicate link state
advertisements).
Age Link state age (in seconds).
Schedule SPF Enables SPF to run.
Area OSPF area ID.
Change in LSID Changed link-state ID of the LSA.
LSA type LSA type.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
674
IP Addressing Services
show ipv6 ospf event
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
675
IP Addressing Services
show ipv6 ospf graceful-restart
show ipv6 ospf graceful-restart
To display Open Shortest Path First for IPv6 (OSPFv3) graceful restart information, use the show ipv6 ospf
graceful-restart command in privileged EXEC mode.
show ipv6 ospf graceful-restart
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 ospf graceful-restart command to discover information about the OSPFv3 graceful restart
feature.
Examples The following example displays OSPFv3 graceful restart information:
# show ipv6 ospf graceful-restart
Routing Process "ospf 1"
Graceful Restart enabled
restart-interval limit: 120 sec, last restart 00:00:15 ago (took 36 secs)
Graceful Restart helper support enabled
Router status : Active
Router is running in SSO mode
OSPF restart state : NO_RESTART
Router ID 10.1.1.1, checkpoint Router ID 10.0.0.0
The table below describes the significant fields shown in the display.
Table 82: show ipv6 ospf graceful-restart Field Descriptions
Field Description
Routing Process "ospf 1" The OSPFv3 routing process ID.
Graceful Restart enabled The graceful restart feature is enabled on this router.
restart-interval limit: 120 sec The restart-interval limit.
last restart 00:00:15 ago (took 36 secs) How long ago the last graceful restart occurred, and how long
it took to occur.
Graceful Restart helper support enabled Graceful restart helper mode is enabled. Because graceful restart
mode is also enabled on this router, you can identify this router
as being graceful-restart capable. A router that is
graceful-restart-aware cannot be configured in graceful-restart
mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
676
IP Addressing Services
show ipv6 ospf graceful-restart
Field Description
Router status : Active This router is in active, as opposed to standby, mode.
Router is running in SSO mode The router is in stateful switchover mode.
OSPF restart state : NO_RESTART The current OSPFv3 restart state.
Router ID 10.1.1.1, checkpoint Router ID The IPv6 addresses of the current router and the checkpoint
10.0.0.0 router.
Related Commands Command Description
show ipv6 ospf interface Displays OSPFv3-related interface information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
677
IP Addressing Services
show ipv6 ospf interface
show ipv6 ospf interface
To display Open Shortest Path First (OSPF)-related interface information, use the showipv6ospfinterface
command in user EXEC or privileged mode.
show ipv6 ospf [process-id] [area-id] interface [type number] [brief]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when the OSPF routing process
is enabled.
area-id (Optional) Displays information about a specified area only.
type number (Optional) Interface type and number.
brief (Optional) Displays brief overview information for OSPF interfaces, states, addresses and
masks, and areas on the router.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples
show ipv6 ospf interface Standard Output Example
The following is sample output from the showipv6ospfinterface command:
# show ipv6 ospf interface
ATM3/0 is up, line protocol is up
Link Local Address 2001:0DB1:205:5FFF:FED3:5808, Interface ID 13
Area 1, Process ID 1, Instance ID 0, Router ID 172.16.3.3
Network Type POINT_TO_POINT, Cost: 1
Transmit Delay is 1 sec, State POINT_TO_POINT,
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:06
Index 1/2/2, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 12, maximum is 12
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 172.16.4.4
Suppress hello for 0 neighbor(s)
FastEthernet0/0 is up, line protocol is up
Link Local Address 2001:0DB1:205:5FFF:FED3:5808, Interface ID 3
Area 1, Process ID 1, Instance ID 0, Router ID 172.16.3.3
Network Type BROADCAST, Cost: 1
Transmit Delay is 1 sec, State BDR, Priority 1
Designated Router (ID) 172.16.6.6, local address 2001:0DB1:205:5FFF:FED3:6408
Backup Designated router (ID) 172.16.3.3, local address 2001:0DB1:205:5FFF:FED3:5808
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
678
IP Addressing Services
show ipv6 ospf interface
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:05
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 12, maximum is 12
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 172.16.6.6 (Designated Router)
Suppress hello for 0 neighbor(s)
The table below describes the significant fields shown in the display.
Table 83: show ipv6 ospf interface Field Descriptions
Field Description
ATM3/0 Status of the physical link and operational status of protocol.
Link Local Address Interface IPv6 address.
Area 1, Process ID 1, Instance ID 0, Router The area ID, process ID, instance ID, and router ID of the area
ID 172.16.3.3 from which this route is learned.
Network Type POINT_TO_POINT, Cost: Network type and link-state cost.
1
Transmit Delay Transmit delay, interface state, and router priority.
Designated Router Designated router ID and respective interface IP address.
Backup Designated router Backup designated router ID and respective interface IP address.
Timer intervals configured Configuration of timer intervals.
Hello Number of seconds until the next hello packet is sent out this
interface.
Neighbor Count Count of network neighbors and list of adjacent neighbors.
Cisco IOS Release 12.2(33)SRB Example
The following is sample output of the showipv6ospfinterface command when the brief keyword is
entered.
# show ipv6 ospf interface brief
Interface PID Area Intf ID Cost State Nbrs F/C
VL0 6 0 21 65535 DOWN 0/0
Se3/0 6 0 14 64 P2P 0/0
Lo1 6 0 20 1 LOOP 0/0
Se2/0 6 6 10 62 P2P 0/0
Tu0 1000 0 19 11111 DOWN 0/0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
679
IP Addressing Services
show ipv6 ospf interface
OSPF with Authentication on the Interface Example
The following is sample output from the showipv6ospfinterface command with authentication
enabled on the interface:
# show ipv6 ospf interface
Ethernet0/0 is up, line protocol is up
Link Local Address 2001:0DB1:A8BB:CCFF:FE00:6E00, Interface ID 2
Area 0, Process ID 1, Instance ID 0, Router ID 10.10.10.1
Network Type BROADCAST, Cost:10
MD5 Authentication SPI 500, secure socket state UP (errors:0)
Transmit Delay is 1 sec, State BDR, Priority 1
Designated Router (ID) 10.11.11.1, local address 2001:0DB1:A8BB:CCFF:FE00:6F00
Backup Designated router (ID) 10.10.10.1, local address
2001:0DB1:A8BB:CCFF:FE00:6E00
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:01
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.11.11.1 (Designated Router)
Suppress hello for 0 neighbor(s)
OSPF with Null Authentication Example
The following is sample output from the showipv6ospfinterface command with null authentication
configured on the interface:
# show ipv6 ospf interface
Ethernet0/0 is up, line protocol is up
Link Local Address 2001:0DB1:A8BB:CCFF:FE00:6E00, Interface ID 2
Area 0, Process ID 1, Instance ID 0, Router ID 10.10.10.1
Network Type BROADCAST, Cost:10
Authentication NULL
Transmit Delay is 1 sec, State BDR, Priority 1
Designated Router (ID) 10.11.11.1, local address 2001:0DB1:A8BB:CCFF:FE00:6F00
Backup Designated router (ID) 10.10.10.1, local address
2001:0DB1:A8BB:CCFF:FE00:6E00
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:03
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.11.11.1 (Designated Router)
Suppress hello for 0 neighbor(s)
OSPF with Authentication for the Area Example
The following is sample output from the showipv6ospfinterface command with authentication
configured for the area:
# show ipv6 ospf interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
680
IP Addressing Services
show ipv6 ospf interface
Ethernet0/0 is up, line protocol is up
Link Local Address 2001:0DB1:A8BB:CCFF:FE00:6E00, Interface ID 2
Area 0, Process ID 1, Instance ID 0, Router ID 10.10.10.1
Network Type BROADCAST, Cost:10
MD5 Authentication (Area) SPI 1000, secure socket state UP (errors:0)
Transmit Delay is 1 sec, State BDR, Priority 1
Designated Router (ID) 10.11.11.1, local address 2001:0DB1:A8BB:CCFF:FE00:6F00
Backup Designated router (ID) 10.10.10.1, local address
FE80::A8BB:CCFF:FE00:6E00
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:03
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.11.11.1 (Designated Router)
Suppress hello for 0 neighbor(s)
OSPF with Dynamic Cost Example
The following display shows sample output from the showipv6ospfinterface command when the
OSPF cost dynamic is configured.
# show ipv6 ospf interface serial 2/0
Serial2/0 is up, line protocol is up
Link Local Address 2001:0DB1:A8BB:CCFF:FE00:100, Interface ID 10
Area 1, Process ID 1, Instance ID 0, Router ID 172.1.1.1
Network Type POINT_TO_MULTIPOINT, Cost: 64 (dynamic), Cost Hysteresis: 200
Cost Weights: Throughput 100, Resources 20, Latency 80, L2-factor 100
Transmit Delay is 1 sec, State POINT_TO_MULTIPOINT,
Timer intervals configured, Hello 30, Dead 120, Wait 120, Retransmit 5
Hello due in 00:00:19
Index 1/2/3, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 0, maximum is 0
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 0, Adjacent neighbor count is 0
Suppress hello for 0 neighbor(s)
OSPF Graceful Restart Example
The following display shows sample output from the showipv6ospfinterface command when the
OSPF graceful restart feature is configured:
# show ipv6 ospf interface
Ethernet0/0 is up, line protocol is up
Link Local Address FE80::A8BB:CCFF:FE00:300, Interface ID 2
Area 0, Process ID 1, Instance ID 0, Router ID 10.3.3.3
Network Type POINT_TO_POINT, Cost: 10
Transmit Delay is 1 sec, State POINT_TO_POINT,
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Graceful Restart p2p timeout in 00:00:19
Hello due in 00:00:02
Graceful Restart helper support enabled
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
681
IP Addressing Services
show ipv6 ospf interface
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.1.1.1
Suppress hello for 0 neighbor(s)
Example of an Enabled Protocol
The following display shows that the OSPF interface is enabled for Bidirectional Forwarding Detection
(BFD):
# show ipv6 ospf interface
Serial10/0 is up, line protocol is up
Link Local Address FE80::A8BB:CCFF:FE00:6500, Interface ID 42
Area 1, Process ID 1, Instance ID 0, Router ID 10.0.0.1
Network Type POINT_TO_POINT, Cost: 64
Transmit Delay is 1 sec, State POINT_TO_POINT, BFD enabled
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:07
Index 1/1/1, flood queue length 0
Next 0x0(0)/0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.1.0.1
Suppress hello for 0 neighbor(s)
Related Commands Command Description
show ipv6 ospf graceful-restart Displays OSPFv3 graceful restart information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
682
IP Addressing Services
show ipv6 ospf request-list
show ipv6 ospf request-list
To display a list of all link-state advertisements (LSAs) requested by a router, use the show ipv6 ospf
request-list command in user EXEC or privileged EXEC mode.
show ipv6 ospf [process-id] [area-id] request-list [neighbor] [interface] [interface-neighbor]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer.
The number used here is the number assigned administratively when the Open Shortest
Path First (OSPF) routing process is enabled.
area-id (Optional) Displays information only about a specified area.
neighbor (Optional) Displays the list of all LSAs requested by the router from this neighbor.
interface (Optional) Displays the list of all LSAs requested by the router from this interface.
interface-neighbor (Optional) Displays the list of all LSAs requested by the router on this interface, from
this neighbor.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The information displayed by the show ipv6 ospf request-list command is useful in debugging OSPF routing
operations.
Examples The following example shows information about the LSAs requested by the router:
# show ipv6 ospf request-list
OSPFv3 Router with ID (192.168.255.5) (Process ID 1)
Neighbor 192.168.255.2, interface Ethernet0/0 address
FE80::A8BB:CCFF:FE00:6600
Type LS ID ADV RTR Seq NO Age Checksum
1 0.0.0.0 192.168.255.3 0x800000C2 1 0x0014C5
1 0.0.0.0 192.168.255.2 0x800000C8 0 0x000BCA
1 0.0.0.0 192.168.255.1 0x800000C5 1 0x008CD1
2 0.0.0.3 192.168.255.3 0x800000A9 774 0x0058C0
2 0.0.0.2 192.168.255.3 0x800000B7 1 0x003A63
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
683
IP Addressing Services
show ipv6 ospf request-list
Table 84: show ipv6 ospf request-list Field Descriptions
Field Description
OSPFv3 Router with ID (192.168.255.5) Identification of the router for which information is displayed.
(Process ID 1)
Interface Ethernet0/0 Interface for which information is displayed.
Type Type of LSA.
LS ID Link-state ID of the LSA.
ADV RTR IP address of advertising router.
Seq NO Sequence number of LSA.
Age Age of LSA (in seconds).
Checksum Checksum of LSA.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
684
IP Addressing Services
show ipv6 ospf retransmission-list
show ipv6 ospf retransmission-list
To display a list of all link-state advertisements (LSAs) waiting to be re-sent, use the show ipv6 ospf
retransmission-list command in user EXEC or privileged EXEC mode.
show ipv6 ospf [process-id] [area-id] retransmission-list [neighbor] [interface] [interface-neighbor]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer.
The number used here is the number assigned administratively when the OSPF routing
process is enabled.
area-id (Optional) Displays information only about a specified area.
neighbor (Optional) Displays the list of all LSAs waiting to be re-sent for this neighbor.
interface (Optional) Displays the list of all LSAs waiting to be re-sent on this interface.
interface neighbor (Optional) Displays the list of all LSAs waiting to be re-sent on this interface, from
this neighbor.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The information displayed by the show ipv6 ospf retransmission-list command is useful in debugging Open
Shortest Path First (OSPF) routing operations.
Examples The following is sample output from the show ipv6 ospf retransmission-list command:
# show ipv6 ospf retransmission-list
OSPFv3 Router with ID (192.168.255.2) (Process ID 1)
Neighbor 192.168.255.1, interface Ethernet0/0
Link state retransmission due in 3759 msec, Queue length 1
Type LS ID ADV RTR Seq NO Age Checksum
0x2001 0 192.168.255.2 0x80000222 1 0x00AE52
The table below describes the significant fields shown in the display.
Table 85: show ipv6 ospf retransmission-list Field Descriptions
Field Description
OSPFv3 Router with ID (192.168.255.2) Identification of the router for which information is displayed.
(Process ID 1)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
685
IP Addressing Services
show ipv6 ospf retransmission-list
Field Description
Interface Ethernet0/0 Interface for which information is displayed.
Link state retransmission due in Length of time before next link-state transmission.
Queue length Number of elements in the retransmission queue.
Type Type of LSA.
LS ID Link-state ID of the LSA.
ADV RTR IP address of advertising router.
Seq NO Sequence number of the LSA.
Age Age of LSA (in seconds).
Checksum Checksum of LSA.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
686
IP Addressing Services
show ipv6 ospf statistics
show ipv6 ospf statistics
To display Open Shortest Path First for IPv6 (OSPFv6) shortest path first (SPF) calculation statistics, use the
show ipv6 ospf statistics command in user EXEC or privileged EXEC mode.
show ipv6 ospf statistics [detail]
Syntax Description detail (Optional) Displays statistics separately for each OSPF area and includes additional, more detailed
statistics.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 ospf statistics command provides important information about SPF calculations and the events
that trigger them. This information can be meaningful for both OSPF network maintenance and troubleshooting.
For example, entering the show ipv6 ospf statistics command is recommended as the first troubleshooting
step for link-state advertisement (LSA) flapping.
Examples The following example provides detailed statistics for each OSPFv6 area:
# show ipv6 ospf statistics detail
Area 0: SPF algorithm executed 3 times
SPF 1 executed 00:06:57 ago, SPF type Full
SPF calculation time (in msec):
SPT Prefix D-Int Sum D-Sum Ext D-Ext Total
0 0 0 0 0 0 0 0
RIB manipulation time (in msec):
RIB Update RIB Delete
0 0
LSIDs processed R:1 N:0 Prefix:0 SN:0 SA:0 X7:0
Change record R N SN SA L
LSAs changed 1
Changed LSAs. Recorded is Advertising Router, LSID and LS type:
10.2.2.2/0(R)
SPF 2 executed 00:06:47 ago, SPF type Full
SPF calculation time (in msec):
SPT Prefix D-Int Sum D-Sum Ext D-Ext Total
0 0 0 0 0 0 0 0
RIB manipulation time (in msec):
RIB Update RIB Delete
0 0
LSIDs processed R:1 N:0 Prefix:1 SN:0 SA:0 X7:0
Change record R L P
LSAs changed 4
Changed LSAs. Recorded is Advertising Router, LSID and LS type:
10.2.2.2/2(L) 10.2.2.2/0(R) 10.2.2.2/2(L) 10.2.2.2/0(P)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
687
IP Addressing Services
show ipv6 ospf statistics
The table below describes the significant fields shown in the display.
Table 86: show ipv6 ospf statistics Field Descriptions
Field Description
Area OSPF area ID.
SPF Number of SPF algorithms executed in the OSPF area. The number increases by one for
each SPF algorithm that is executed in the area.
Executed ago Time in milliseconds that has passed between the start of the SPF algorithm execution
and the current time.
SPF type SPF type can be Full or Incremental.
SPT Time in milliseconds required to compute the first stage of the SPF algorithm (to build a
short path tree). The SPT time plus the time required to process links to stub networks
equals the Intra time.
Ext Time in milliseconds for the SPF algorithm to process external and not so stubby area
(NSSA) LSAs and to install external and NSSA routes in the routing table.
Total Total duration time in milliseconds for the SPF algorithm process.
LSIDs processed Number of LSAs processed during the SPF calculation:
• N--Network LSA.
• R--Router LSA.
• SA--Summary Autonomous System Boundary Router (ASBR) (SA) LSA.
• SN--Summary Network (SN) LSA.
• Stub--Stub links.
• X7--External Type-7 (X7) LSA.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
688
IP Addressing Services
show ipv6 ospf summary-prefix
show ipv6 ospf summary-prefix
To display a list of all summary address redistribution information configured under an OSPF process, use
the show ipv6 ospf summary-prefix command in user EXEC or privileged EXEC mode.
show ipv6 ospf [process-id] summary-prefix
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive integer. The
number used here is the number assigned administratively when the OSPF routing process is
enabled.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The process-id argument can be entered as a decimal number or as an IPv6 address format.
Examples The following is sample output from the show ipv6 ospf summary-prefix command:
# show ipv6 ospf summary-prefix
OSPFv3 Process 1, Summary-prefix
FEC0::/24 Metric 16777215, Type 0, Tag 0
The table below describes the significant fields shown in the display.
Table 87: show ipv6 ospf summary-prefix Field Descriptions
Field Description
OSPFv3 Process Process ID of the router for which information is displayed.
Metric Metric used to reach the destination router.
Type Type of link-state advertisement (LSA).
Tag LSA tag.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
689
IP Addressing Services
show ipv6 ospf timers rate-limit
show ipv6 ospf timers rate-limit
To display all of the link-state advertisements (LSAs) in the rate limit queue, use the show ipv6 ospf timers
rate-limit command in privileged EXEC mode.
show ipv6 ospf timers rate-limit
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 ospf timers rate-limit command to discover when LSAs in the queue will be sent.
Examples
show ipv6 ospf timers rate-limit Output Example
The following is sample output from the show ipv6 ospf timers rate-limitcommand:
# show ipv6 ospf timers rate-limit
List of LSAs that are in rate limit Queue
LSAID: 0.0.0.0 Type: 0x2001 Adv Rtr: 55.55.55.55 Due in: 00:00:00.500
LSAID: 0.0.0.0 Type: 0x2009 Adv Rtr: 55.55.55.55 Due in: 00:00:00.500
The table below describes the significant fields shown in the display.
Table 88: show ipv6 ospf timers rate-limit Field Descriptions
Field Description
LSAID ID of the LSA.
Type Type of LSA.
Adv Rtr ID of the advertising router.
Due in: When the LSA is scheduled to be sent (in hours:minutes:seconds).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
690
IP Addressing Services
show ipv6 ospf traffic
show ipv6 ospf traffic
To display IPv6 Open Shortest Path First Version 3 (OSPFv3) traffic statistics, use the show ipv6 ospf traffic
command in privileged EXEC mode.
show ipv6 ospf [process-id] traffic [interface-type interface-number]
Syntax Description process-id (Optional) OSPF process ID for which you want traffic statistics (for
example, queue statistics, statistics for each interface under the OSPF
process, and per OSPF process statistics).
interface-type interface-number (Optional) Type and number associated with a specific OSPF interface.
Command Default When the show ipv6 ospf traffic command is entered without any arguments, global OSPF traffic statistics
are displayed, including queue statistics for each OSPF process, statistics for each interface, and per OSPF
process statistics.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You can limit the displayed traffic statistics to those for a specific OSPF process by entering a value for the
process-id argument, or you can limit output to traffic statistics for a specific interface associated with an
OSPF process by entering values for the interface-type and interface-number arguments. To reset counters
and clear statistics, use the clear ipv6 ospf traffic command.
Examples The following example shows the display output for the show ipv6 ospf traffic command for
OSPFv3:
# show ipv6 ospf traffic
OSPFv3 statistics:
Rcvd: 32 total, 0 checksum errors
10 hello, 7 database desc, 2 link state req
9 link state updates, 4 link state acks
0 LSA ignored
Sent: 45 total, 0 failed
17 hello, 12 database desc, 2 link state req
8 link state updates, 6 link state acks
OSPFv3 Router with ID (10.1.1.4) (Process ID 6)
OSPFv3 queues statistic for process ID 6
Hello queue size 0, no limit, max size 2
Router queue size 0, limit 200, drops 0, max size 2
Interface statistics:
Interface Serial2/0
OSPFv3 packets received/sent
Type Packets Bytes
RX Invalid 0 0
RX Hello 5 196
RX DB des 4 172
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
691
IP Addressing Services
show ipv6 ospf traffic
RX LS req 1 52
RX LS upd 4 320
RX LS ack 2 112
RX Total 16 852
TX Failed 0 0
TX Hello 8 304
TX DB des 3 144
TX LS req 1 52
TX LS upd 3 252
TX LS ack 3 148
TX Total 18 900
OSPFv3 header errors
Length 0, Checksum 0, Version 0, No Virtual Link 0,
Area Mismatch 0, Self Originated 0, Duplicate ID 0,
Instance ID 0, Hello 0, MTU Mismatch 0,
Nbr Ignored 0, Authentication 0,
OSPFv3 LSA errors
Type 0, Length 0, Data 0, Checksum 0,
Interface Ethernet0/0
OSPFv3 packets received/sent
Type Packets Bytes
RX Invalid 0 0
RX Hello 6 240
RX DB des 3 144
RX LS req 1 52
RX LS upd 5 372
RX LS ack 2 152
RX Total 17 960
TX Failed 0 0
TX Hello 11 420
TX DB des 9 312
TX LS req 1 52
TX LS upd 5 376
TX LS ack 3 148
TX Total 29 1308
OSPFv3 header errors
Length 0, Checksum 0, Version 0, No Virtual Link 0,
Area Mismatch 0, Self Originated 0, Duplicate ID 0,
Instance ID 0, Hello 0, MTU Mismatch 0,
Nbr Ignored 0, Authentication 0,
OSPFv3 LSA errors
Type 0, Length 0, Data 0, Checksum 0,
Summary traffic statistics for process ID 6:
OSPFv3 packets received/sent
Type Packets Bytes
RX Invalid 0 0
RX Hello 11 436
RX DB des 7 316
RX LS req 2 104
RX LS upd 9 692
RX LS ack 4 264
RX Total 33 1812
TX Failed 0 0
TX Hello 19 724
TX DB des 12 456
TX LS req 2 104
TX LS upd 8 628
TX LS ack 6 296
TX Total 47 2208
OSPFv3 header errors
Length 0, Checksum 0, Version 0, No Virtual Link 0,
Area Mismatch 0, Self Originated 0, Duplicate ID 0,
Instance ID 0, Hello 0, MTU Mismatch 0,
Nbr Ignored 0, Authentication 0,
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
692
IP Addressing Services
show ipv6 ospf traffic
OSPFv3 LSA errors
Type 0, Length 0, Data 0, Checksum 0,
The network administrator wants to start collecting new statistics, resetting the counters and clearing
the traffic statistics by entering the clear ipv6 ospf traffic command as follows:
# clear ipv6 ospf traffic
The table below describes the significant fields shown in the display.
Table 89: show ipv6 ospf traffic Field Descriptions
Field Description
OSPFv3 statistics Traffic statistics accumulated for all OSPF processes running on the router.
To ensure compatibility with the showiptraffic command, only checksum
errors are displayed. Identifies the route map name.
OSPFv3 queues statistic for Queue statistics specific to Cisco IOS software.
process ID
Hello queue Statistics for the internal Cisco IOS queue between the packet switching
code (process IP Input) and the OSPF hello process for all received OSPF
packets.
Router queue Statistics for the internal Cisco IOS queue between the OSPF hello process
and the OSPF router for all received OSPF packets except OSPF hellos.
queue size Actual size of the queue.
queue limit Maximum allowed size of the queue.
queue max size Maximum recorded size of the queue.
Interface statistics Per-interface traffic statistics for all interfaces that belong to the specific
OSPFv3 process ID.
OSPFv3 packets received/sent Number of OSPFv3 packets received and sent on the interface, sorted by
packet types.
OSPFv3 header errors Packet appears in this section if it was discarded because of an error in the
header of an OSPFv3 packet. The discarded packet is counted under the
appropriate discard reason.
OSPFv3 LSA errors Packet appears in this section if it was discarded because of an error in the
header of an OSPF link-state advertisement (LSA). The discarded packet
is counted under the appropriate discard reason.
Summary traffic statistics for Summary traffic statistics accumulated for an OSPFv3 process.
process ID
Note The OSPF process ID is a unique value assigned to the OSPFv3
process in the configuration.
The value for the received errors is the sum of the OSPFv3 header errors
that are detected by the OSPFv3 process, unlike the sum of the checksum
errors that are listed in the global OSPF statistics.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
693
IP Addressing Services
show ipv6 ospf traffic
Related Commands Command Description
clear ip ospf traffic Clears OSPFv2 traffic statistics.
clear ipv6 ospf traffic Clears OSPFv3 traffic statistics.
show ip ospf traffic Displays OSPFv2 traffic statistics.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
694
IP Addressing Services
show ipv6 ospf virtual-links
show ipv6 ospf virtual-links
To display parameters and the current state of Open Shortest Path First (OSPF) virtual links, use the s how
ipv6 ospf virtual-links command in user EXEC or privileged EXEC mode.
show ipv6 ospf virtual-links
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The information displayed by the show ipv6 ospf virtual-links command is useful in debugging OSPF routing
operations.
Examples The following is sample output from the show ipv6 ospf virtual-links command:
# show ipv6 ospf virtual-links
Virtual Link OSPF_VL0 to router 172.16.6.6 is up
Interface ID 27, IPv6 address FEC0:6666:6666::
Run as demand circuit
DoNotAge LSA allowed.
Transit area 2, via interface ATM3/0, Cost of using 1
Transmit Delay is 1 sec, State POINT_TO_POINT,
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 00:00:06
The table below describes the significant fields shown in the display.
Table 90: show ipv6 ospf virtual-links Field Descriptions
Field Description
Virtual Link OSPF_VL0 to router Specifies the OSPF neighbor, and if the link to that neighbor is
172.16.6.6 is up up or down.
Interface ID Interface ID and IPv6 address of the router.
Transit area 2 The transit area through which the virtual link is formed.
via interface ATM3/0 The interface through which the virtual link is formed.
Cost of using 1 The cost of reaching the OSPF neighbor through the virtual link.
Transmit Delay is 1 sec The transmit delay (in seconds) on the virtual link.
State POINT_TO_POINT The state of the OSPF neighbor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
695
IP Addressing Services
show ipv6 ospf virtual-links
Field Description
Timer intervals... The various timer intervals configured for the link.
Hello due in 0:00:06 When the next hello is expected from the neighbor.
The following sample output from the show ipv6 ospf virtual-links command has two virtual links.
One is protected by authentication, and the other is protected by encryption.
# show ipv6 ospf virtual-links
Virtual Link OSPFv3_VL1 to router 10.2.0.1 is up
Interface ID 69, IPv6 address 2001:0DB8:11:0:A8BB:CCFF:FE00:6A00
Run as demand circuit
DoNotAge LSA allowed.
Transit area 1, via interface Serial12/0, Cost of using 64
NULL encryption SHA-1 auth SPI 3944, secure socket UP (errors: 0)
Transmit Delay is 1 sec, State POINT_TO_POINT,
Timer intervals configured, Hello 2, Dead 10, Wait 40, Retransmit 5
Adjacency State FULL (Hello suppressed)
Index 1/2/4, retransmission queue length 0, number of retransmission 1
First 0x0(0)/0x0(0)/0x0(0) Next 0x0(0)/0x0(0)/0x0(0)
Last retransmission scan length is 1, maximum is 1
Last retransmission scan time is 0 msec, maximum is 0 msec
Virtual Link OSPFv3_VL0 to router 10.1.0.1 is up
Interface ID 67, IPv6 address 2001:0DB8:13:0:A8BB:CCFF:FE00:6700
Run as demand circuit
DoNotAge LSA allowed.
Transit area 1, via interface Serial11/0, Cost of using 128
MD5 authentication SPI 940, secure socket UP (errors: 0)
Transmit Delay is 1 sec, State POINT_TO_POINT,
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Adjacency State FULL (Hello suppressed)
Index 1/1/3, retransmission queue length 0, number of retransmission 1
First 0x0(0)/0x0(0)/0x0(0) Next 0x0(0)/0x0(0)/0x0(0)
Last retransmission scan length is 1, maximum is 1
Last retransmission scan time is 0 msec, maximum is 0 msec
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
696
IP Addressing Services
show ipv6 pim anycast-RP
show ipv6 pim anycast-RP
To verify IPv6 PIM anycast RP operation, use the show ipv6 pim anycast-RP command in user EXEC or
privileged EXEC mode.
show ipv6 pim anycast-RP rp-address
Syntax Description rp-address RP address to be verified.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines
Examples # show ipv6 pim anycast-rp 110::1:1:1
Anycast RP Peers For 110::1:1:1 Last Register/Register-Stop received
20::1:1:1 00:00:00/00:00:00
Related Commands Command Description
ipv6 pim anycast-RP Configures the address of the PIM RP for an anycast group range.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
697
IP Addressing Services
show ipv6 pim bsr
show ipv6 pim bsr
To display information related to Protocol Independent Multicast (PIM) bootstrap router (BSR) protocol
processing, use the show ipv6 pim bsr command in user EXEC or privileged EXEC mode.
show ipv6 pim [vrf vrf-name] bsr {election | rp-cache | candidate-rp}
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
election Displays BSR state, BSR election, and bootstrap message (BSM)-related timers.
rp-cache Displays candidate rendezvous point (C-RP) cache learned from unicast C-RP announcements
on the elected BSR.
candidate-rp Displays C-RP state on devices that are configured as C-RPs.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 pim bsr command to display details of the BSR election-state machine, C-RP advertisement
state machine, and the C-RP cache. Information on the C-RP cache is displayed only on the elected BSR
device, and information on the C-RP state machine is displayed only on a device configured as a C-RP.
Examples The following example displays BSM election information:
# show ipv6 pim bsr election
PIMv2 BSR information
BSR Election Information
Scope Range List: ff00::/8
This system is the Bootstrap Router (BSR)
BSR Address: 60::1:1:4
Uptime: 00:11:55, BSR Priority: 0, Hash mask length: 126
RPF: FE80::A8BB:CCFF:FE03:C400,Ethernet0/0
BS Timer: 00:00:07
This system is candidate BSR
Candidate BSR address: 60::1:1:4, priority: 0, hash mask length: 126
The table below describes the significant fields shown in the display.
Table 91: show ipv6 pim bsr election Field Descriptions
Field Description
Scope Range List Scope to which this BSR information applies.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
698
IP Addressing Services
show ipv6 pim bsr
Field Description
This system is the Bootstrap Router Indicates this device is the BSR and provides information on the
(BSR) parameters associated with it.
BS Timer On the elected BSR, the BS timer shows the time in which the next
BSM will be originated.
On all other devices in the domain, the BS timer shows the time at which
the elected BSR expires.
This system is candidate BSR Indicates this device is the candidate BSR and provides information on
the parameters associated with it.
The following example displays information that has been learned from various C-RPs at the BSR.
In this example, two candidate RPs have sent advertisements for the FF00::/8 or the default IPv6
multicast range:
# show ipv6 pim bsr rp-cache
PIMv2 BSR C-RP Cache
BSR Candidate RP Cache
Group(s) FF00::/8, RP count 2
RP 10::1:1:3
Priority 192, Holdtime 150
Uptime: 00:12:36, expires: 00:01:55
RP 20::1:1:1
Priority 192, Holdtime 150
Uptime: 00:12:36, expires: 00:01:5
The following example displays information about the C-RP. This RP has been configured without
a specific scope value, so the RP will send C-RP advertisements to all BSRs about which it has
learned through BSMs it has received.
# show ipv6 pim bsr candidate-rp
PIMv2 C-RP information
Candidate RP: 10::1:1:3
All Learnt Scoped Zones, Priority 192, Holdtime 150
Advertisement interval 60 seconds
Next advertisement in 00:00:33
The following example confirms that the IPv6 C-BSR is PIM-enabled. If PIM is disabled on an IPv6
C-BSR interface, or if a C-BSR or C-RP is configured with the address of an interface that does not
have PIM enabled, the show ipv6 pim bsr command used with the election keyword would display
that information instead.
# show ipv6 pim bsr election
PIMv2 BSR information
BSR Election Information
Scope Range List: ff00::/8
BSR Address: 2001:DB8:1:1:2
Uptime: 00:02:42, BSR Priority: 34, Hash mask length: 28
RPF: FE80::20:1:2,Ethernet1/0
BS Timer: 00:01:27
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
699
IP Addressing Services
show ipv6 pim df
show ipv6 pim df
To display the designated forwarder (DF)-election state of each interface for each rendezvous point (RP), use
the show ipv6 pim df command in user EXEC or privileged EXEC mode.
show ipv6 pim [vrf vrf-name] df [interface-type interface-number] [rp-address]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface-type interface-number (Optional) Interface type and number. For more information, use the
question mark (?) online help function.
rp-address (Optional) RP IPv6 address.
Command Default If no interface or RP address is specified, all DFs are displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 pim df command to display the state of the DF election for each RP on each Protocol
Independent Multicast (PIM)-enabled interface if the bidirectional multicast traffic is not flowing as expected.
Examples The following example displays the DF-election states:
# show ipv6 pim df
Interface DF State Timer Metrics
Ethernet0/0 Winner 4s 8ms [120/2]
RP :200::1
Ethernet1/0 Lose 0s 0ms [inf/inf]
RP :200::1
The following example shows information on the RP:
# show ipv6 pim df
Interface DF State Timer Metrics
Ethernet0/0 None:RP LAN 0s 0ms [inf/inf]
RP :200::1
Ethernet1/0 Winner 7s 600ms [0/0]
RP :200::1
Ethernet2/0 Winner 9s 8ms [0/0]
RP :200::1
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
700
IP Addressing Services
show ipv6 pim df
Table 92: show ipv6 pim df Field Descriptions
Field Description
Interface Interface type and number that is configured to run PIM.
DF State The state of the DF election on the interface. The state can be:
• Offer
• Winner
• Backoff
• Lose
• None:RP LAN
The None:RP LAN state indicates that no DF election is taking place on this LAN because the
RP is directly connected to this LAN.
Timer DF election timer.
Metrics Routing metrics to the RP announced by the DF.
RP The IPv6 address of the RP.
Related Commands Command Description
debug ipv6 pim df-election Displays debug messages for PIM bidirectional DF-election message
processing.
ipv6 pim rp-address Configures the address of a PIM RP for a particular group range.
show ipv6 pim df winner Displays the DF-election winner on each interface for each RP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
701
IP Addressing Services
show ipv6 pim group-map
show ipv6 pim group-map
To display an IPv6 Protocol Independent Multicast (PIM) group mapping table, use the show ipv6 pim
group-map command in user EXEC or privileged EXEC mode.
{show ipv6 pim [vrf vrf-name] group-map [{group-namegroup-address}] | [{group-rangegroup-mask}]
[info-source {bsr | default | embedded-rp | static}]}
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
group-range | group-mask (Optional) Group range list. Includes group ranges with the same prefix or
mask length.
info-source (Optional) Displays all mappings learned from a specific source, such as the
bootstrap router (BSR) or static configuration.
bsr Displays ranges learned through the BSR.
default Displays ranges enabled by default.
embedded-rp Displays group ranges learned through the embedded rendezvous point (RP).
static Displays ranges enabled by static configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 pim group-map command to find all group mappings installed by a given source of
information, such as BSR or static configuration.
You can also use this command to find which group mapping a router at a specified IPv6 group address is
using by specifying a group address, or to find an exact group mapping entry by specifying a group range and
mask length.
Examples The following is sample output from the show ipv6 pim group-map command:
# show ipv6 pim group-map
FF33::/32*
SSM
Info source:Static
Uptime:00:08:32, Groups:0
FF34::/32*
SSM
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
702
IP Addressing Services
show ipv6 pim group-map
Info source:Static
Uptime:00:09:42, Groups:0
The table below describes the significant fields shown in the display.
Table 93: show ipv6 pim group-map Field Descriptions
Field Description
RP Address of the RP router if the protocol is sparse mode or bidir.
Protocol Protocol used: sparse mode (SM), Source Specific Multicast (SSM), link-local (LL), or
NOROUTE (NO).
LL is used for the link-local scoped IPv6 address range (ff[0-f]2::/16). LL is treated as a separate
protocol type, because packets received with these destination addresses are not forwarded, but
the router might need to receive and process them.
NOROUTE or NO is used for the reserved and node-local scoped IPv6 address range
(ff[0-f][0-1]::/16). These addresses are nonroutable, and the router does not need to process
them.
Groups How many groups are present in the topology table from this range.
Info source Mappings learned from a specific source; in this case, static configuration.
Uptime The uptime for the group mapping displayed.
The following example displays the group mappings learned from BSRs that exist in the PIM
group-to-RP or mode-mapping cache. The example shows the address of the BSR from which the
group mappings have been learned and the associated timeout.
Router# show ipv6 pim group-map info-source bsr
FF00::/8*
SM, RP: 20::1:1:1
RPF: Et1/0,FE80::A8BB:CCFF:FE03:C202
Info source: BSR From: 60::1:1:4(00:01:42), Priority: 192
Uptime: 00:19:51, Groups: 0
FF00::/8*
SM, RP: 10::1:1:3
RPF: Et0/0,FE80::A8BB:CCFF:FE03:C102
Info source: BSR From: 60::1:1:4(00:01:42), Priority: 192
Uptime: 00:19:51, Groups: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
703
IP Addressing Services
show ipv6 pim interface
show ipv6 pim interface
To display information about interfaces configured for Protocol Independent Multicast (PIM), use the show
ipv6 pim interface command in privileged EXEC mode.
show ipv6 pim [vrf vrf-name] interface [state-on] [state-off] [type number]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
state-on (Optional) Displays interfaces with PIM enabled.
state-off (Optional) Displays interfaces with PIM disabled.
type number (Optional) Interface type and number.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 pim interface command is used to check if PIM is enabled on an interface, the number of
neighbors, and the designated router (DR) on the interface.
Examples The following is sample output from the show ipv6 pim interface command using the state-on
keyword:
# show ipv6 pim interface state-on
Interface PIM Nbr Hello DR
Count Intvl Prior
Ethernet0 on 0 30 1
Address:FE80::208:20FF:FE08:D7FF
DR :this system
POS1/0 on 0 30 1
Address:FE80::208:20FF:FE08:D554
DR :this system
POS4/0 on 1 30 1
Address:FE80::208:20FF:FE08:D554
DR :FE80::250:E2FF:FE8B:4C80
POS4/1 on 0 30 1
Address:FE80::208:20FF:FE08:D554
DR :this system
Loopback0 on 0 30 1
Address:FE80::208:20FF:FE08:D554
DR :this system
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
704
IP Addressing Services
show ipv6 pim interface
Table 94: show ipv6 pim interface Field Descriptions
Field Description
Interface Interface type and number that is configured to run PIM.
PIM Whether PIM is enabled on an interface.
Nbr Count Number of PIM neighbors that have been discovered through this interface.
Hello Intvl Frequency, in seconds, of PIM hello messages.
DR IP address of the designated router (DR) on a network.
Address Interface IP address of the next-hop router.
The following is sample output from the show ipv6 pim interface command, modified to display
passive interface information:
(config)# show ipv6 pim interface gigabitethernet0/0/0
Interface PIM Nbr Hello DR BFD
Count Intvl Prior
GigabitEthernet0/0/0 on/P 0 30 1 On
Address: FE80::A8BB:CCFF:FE00:9100
DR : this system
The table below describes the significant change shown in the display.
Table 95: show ipv6 pim interface Field Description
Field Description
PIM Whether PIM is enabled on an interface. When PIM passive mode is used, a "P" is displayed in the
output.
Related Commands Command Description
show ipv6 pim neighbor Displays the PIM neighbors discovered by the Cisco IOS software.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
705
IP Addressing Services
show ipv6 pim join-prune statistic
show ipv6 pim join-prune statistic
To display the average join-prune aggregation for the most recently aggregated 1000, 10,000, and 50,000
packets for each interface, use the show ipv6 pim join-prune statistic command in user EXEC or privileged
EXEC mode.
show ipv6 pim [vrf vrf-name] join-prune statistic [interface-type]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface-type (Optional) Interface type. For more information, use the question mark (?) online help
function.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When Protocol Independent Multicast (PIM) sends multiple joins and prunes simultaneously, it aggregates
them into a single packet. The show ipv6 pim join-prune statistic command displays the average number
of joins and prunes that were aggregated into a single packet over the last 1000 PIM join-prune packets, over
the last 10,000 PIM join-prune packets, and over the last 50,000 PIM join-prune packets.
Examples The following example provides the join/prune aggregation on Ethernet interface 0/0/0:
# show ipv6 pim join-prune statistic Ethernet0/0/0
PIM Average Join/Prune Aggregation for last (1K/10K/50K) packets
Interface Transmitted Received
Ethernet0/0/0 0 / 0 / 0 1 / 0 / 0
The table below describes the significant fields shown in the display.
Table 96: show ipv6 pim join-prune statistics Field Descriptions
Field Description
Interface The interface from which the specified packets were transmitted or on which they were received.
Transmitted The number of packets transmitted on the interface.
Received The number of packets received on the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
706
IP Addressing Services
show ipv6 pim limit
show ipv6 pim limit
To display Protocol Independent Multicast (PIM) interface limit, use the show ipv6 pim limit command in
privileged EXEC mode.
show ipv6 pim [vrf vrf-name] limit [interface]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface (Optional) Specific interface for which limit information is provided.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 pim limit command checks interface statistics for limits. If the optional interface argument
is enabled, only information for the specified interface is shown.
Examples The following example displays s PIM interface limit information:
# show ipv6 pim limit
Related Commands Command Description
ipv6 multicast limit Configures per-interface mroute state limiters in IPv6.
ipv6 multicast limit cost Applies a cost to mroutes that match per interface mroute state limiters in IPv6.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
707
IP Addressing Services
show ipv6 pim neighbor
show ipv6 pim neighbor
To display the Protocol Independent Multicast (PIM) neighbors discovered by the Cisco software, use the
show ipv6 pim neighbor command in privileged EXEC mode.
show ipv6 pim [vrf vrf-name ]neighbor [detail ][{interface-type interface-number | count}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
detail (Optional) Displays the additional addresses of the neighbors learned, if
any, through the routable address hello option.
interface-type interface-number (Optional) Interface type and number.
count (Optional) Displays neighbor counts on each interface.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 pim neighbor command displays which routers on the LAN are configured for PIM.
Examples The following is sample output from the show ipv6 pim neighbor command using the detail keyword
to identify the additional addresses of the neighbors learned through the routable address hello option:
# show ipv6 pim neighbor detail
Neighbor Address(es) Interface Uptime Expires DR pri Bidir
FE80::A8BB:CCFF:FE00:401 Ethernet0/0 01:34:16 00:01:16 1 B
60::1:1:3
FE80::A8BB:CCFF:FE00:501 Ethernet0/0 01:34:15 00:01:18 1 B
60::1:1:4
The table below describes the significant fields shown in the display.
Table 97: show ipv6 pim neighbor Field Descriptions
Field Description
Neighbor addresses IPv6 address of the PIM neighbor.
Interface Interface type and number on which the neighbor is reachable.
Uptime How long (in hours, minutes, and seconds) the entry has been in the PIM neighbor
table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
708
IP Addressing Services
show ipv6 pim neighbor
Field Description
Expires How long (in hours, minutes, and seconds) until the entry will be removed from the
IPv6 multicast routing table.
DR Indicates that this neighbor is a designated router (DR) on the LAN.
pri DR priority used by this neighbor.
Bidir The neighbor is capable of PIM in bidirectional mode.
Related Commands Command Description
show ipv6 pim interfaces Displays information about interfaces configured for PIM.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
709
IP Addressing Services
show ipv6 pim range-list
show ipv6 pim range-list
To display information about IPv6 multicast range lists, use the show ipv6 pim range-list command in
privileged EXEC mode.
show ipv6 pim [vrf vrf-name] range-list [config] [{rp-addressrp-name}]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
config (Optional) The client. Displays the range lists configured on the router.
rp-address | rp-name (Optional) The address of a Protocol Independent Multicast (PIM) rendezvous point
(RP).
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 pim range-list command displays IPv6 multicast range lists on a per-client and per-mode
basis. A client is the entity from which the specified range list was learned. The clients can be config, and the
modes can be Source Specific Multicast (SSM) or sparse mode (SM).
Examples The following is sample output from the show ipv6 pim range-list command:
# show ipv6 pim range-list
config SSM Exp:never Learnt from :::
FF33::/32 Up:00:26:33
FF34::/32 Up:00:26:33
FF35::/32 Up:00:26:33
FF36::/32 Up:00:26:33
FF37::/32 Up:00:26:33
FF38::/32 Up:00:26:33
FF39::/32 Up:00:26:33
FF3A::/32 Up:00:26:33
FF3B::/32 Up:00:26:33
FF3C::/32 Up:00:26:33
FF3D::/32 Up:00:26:33
FF3E::/32 Up:00:26:33
FF3F::/32 Up:00:26:33
config SM RP:40::1:1:1 Exp:never Learnt from :::
FF13::/64 Up:00:03:50
config SM RP:40::1:1:3 Exp:never Learnt from :::
FF09::/64 Up:00:03:50
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
710
IP Addressing Services
show ipv6 pim range-list
Table 98: show ipv6 pim range-list Field Descriptions
Field Description
config Config is the client.
SSM Protocol being used.
FF33::/32 Group range.
Up: Uptime.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
711
IP Addressing Services
show ipv6 pim topology
show ipv6 pim topology
To display Protocol Independent Multicast (PIM) topology table information for a specific group or all groups,
use the show ipv6 pim topology command in user EXEC or privileged EXEC mode.
show ipv6 pim [vrf vrf-name] topology [{group-name | group-address [{source-addresssource-name}]
| link-local}]route-count [detail]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
group-name | group-address (Optional) IPv6 address or name of the multicast group.
source-address | source-name (Optional) IPv6 address or name of the source.
link-local (Optional) Displays the link-local groups.
route-count (Optional) Displays the number of routes in PIM topology table.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines This command shows the PIM topology table for a given group--(*, G), (S, G), and (S, G) Rendezvous Point
Tree (RPT)-- as internally stored in a PIM topology table. The PIM topology table may have various entries
for a given group, each with its own interface list. The resulting forwarding state is maintained in the Multicast
Routing Information Base (MRIB) table, which shows which interface the data packet should be accepted on
and which interfaces the data packet should be forwarded to for a given (S, G) entry. Additionally, the Multicast
Forwarding Information Base (MFIB) table is used during forwarding to decide on per-packet forwarding
actions.
The route-count keyword shows the count of all entries, including link-local entries.
PIM communicates the contents of these entries through the MRIB, which is an intermediary for communication
between multicast routing protocols (such as PIM), local membership protocols (such as Multicast Listener
Discovery [MLD]), and the multicast forwarding engine of the system.
For example, an interface is added to the (*, G) entry in PIM topology table upon receipt of an MLD report
or PIM (*, G) join message. Similarly, an interface is added to the (S, G) entry upon receipt of the MLD
INCLUDE report for the S and G or PIM (S, G) join message. Then PIM installs an (S, G) entry in the MRIB
with the immediate olist (from (S, G)) and the inherited olist (from (*, G)). Therefore, the proper forwarding
state for a given entry (S, G) can be seen only in the MRIB or the MFIB, not in the PIM topology table.
Examples The following is sample output from the show ipv6 pim topology command:
# show ipv6 pim topology
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
712
IP Addressing Services
show ipv6 pim topology
IP PIM Multicast Topology Table
Entry state:(*/S,G)[RPT/SPT] Protocol Uptime Info
Entry flags:KAT - Keep Alive Timer, AA - Assume Alive, PA - Probe Alive,
RA - Really Alive, LH - Last Hop, DSS - Don't Signal Sources,
RR - Register Received, SR - Sending Registers, E - MSDP External,
DCC - Don't Check Connected
Interface state:Name, Uptime, Fwd, Info
Interface flags:LI - Local Interest, LD - Local Dissinterest,
II - Internal Interest, ID - Internal Dissinterest,
LH - Last Hop, AS - Assert, AB - Admin Boundary
(*,FF05::1)
SM UP:02:26:56 JP:Join(now) Flags:LH
RP:40::1:1:2
RPF:Ethernet1/1,FE81::1
Ethernet0/1 02:26:56 fwd LI LH
(50::1:1:200,FF05::1)
SM UP:00:00:07 JP:Null(never) Flags:
RPF:Ethernet1/1,FE80::30:1:4
Ethernet1/1 00:00:07 off LI
The table below describes the significant fields shown in the display.
Table 99: show ipv6 pim topology Field Descriptions
Field Description
Entry flags: KAT The keepalive timer (KAT) associated with a source is used to keep track of two intervals
while the source is alive. When a source first becomes active, the first-hop router sets the
keepalive timer to 3 minutes and 30 seconds, during which time it does not probe to see
if the source is alive. Once this timer expires, the router enters the probe interval and resets
the timer to 65 seconds, during which time the router assumes the source is alive and starts
probing to determine if it actually is. If the router determines that the source is alive, the
router exits the probe interval and resets the keepalive timer to 3 minutes and 30 seconds.
If the source is not alive, the entry is deleted at the end of the probe interval.
AA, PA The assume alive (AA) and probe alive (PA) flags are set when the router is in the probe
interval for a particular source.
RR The register received (RR) flag is set on the (S, G) entries on the Route Processor (RP)
as long as the RP receives registers from the source Designated Router (DR), which keeps
the source state alive on the RP.
SR The sending registers (SR) flag is set on the (S, G) entries on the DR as long as it sends
registers to the RP.
Related Commands Command Description
show ipv6 mrib client Displays information about the clients of the MRIB.
show ipv6 mrib route Displays MRIB route information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
713
IP Addressing Services
show ipv6 pim traffic
show ipv6 pim traffic
To display the Protocol Independent Multicast (PIM) traffic counters, use the show ipv6 pim traffic command
in user EXEC or privileged EXEC mode.
show ipv6 pim [vrf vrf-name] traffic
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 pim traffic command to check if the expected number of PIM protocol messages have
been received and sent.
Examples The following example shows the number of PIM protocol messages received and sent.
# show ipv6 pim traffic
PIM Traffic Counters
Elapsed time since counters cleared:00:05:29
Received Sent
Valid PIM Packets 22 22
Hello 22 22
Join-Prune 0 0
Register 0 0
Register Stop 0 0
Assert 0 0
Bidir DF Election 0 0
Errors:
Malformed Packets 0
Bad Checksums 0
Send Errors 0
Packet Sent on Loopback Errors 0
Packets Received on PIM-disabled Interface 0
Packets Received with Unknown PIM Version 0
The table below describes the significant fields shown in the display.
Table 100: show ipv6 pim traffic Field Descriptions
Field Description
Elapsed time since counters cleared Indicates the amount of time (in hours, minutes, and seconds) since the
counters cleared.
Valid PIM Packets Number of valid PIM packets received and sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
714
IP Addressing Services
show ipv6 pim traffic
Field Description
Hello Number of valid hello messages received and sent.
Join-Prune Number of join and prune announcements received and sent.
Register Number of PIM register messages received and sent.
Register Stop Number of PIM register stop messages received and sent.
Assert Number of asserts received and sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
715
IP Addressing Services
show ipv6 pim tunnel
show ipv6 pim tunnel
To display information about the Protocol Independent Multicast (PIM) register encapsulation and
de-encapsulation tunnels on an interface, use the show ipv6 pim tunnel command in privileged EXEC mode.
show ipv6 pim [vrf vrf-name] tunnel [interface-type interface-number]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
interface-type interface-number (Optional) Tunnel interface type and number.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If you use the show ipv6 pim tunnel command without the optional interface keyword, information about
the PIM register encapsulation and de-encapsulation tunnel interfaces is displayed.
The PIM encapsulation tunnel is the register tunnel. An encapsulation tunnel is created for every known
rendezvous point (RP) on each router. The PIM decapsulation tunnel is the register decapsulation tunnel. A
decapsulation tunnel is created on the RP for the address that is configured to be the RP address.
Examples The following is sample output from the show ipv6 pim tunnel command on the RP:
# show ipv6 pim tunnel
Tunnel0*
Type :PIM Encap
RP :100::1
Source:100::1
Tunnel0*
Type :PIM Decap
RP :100::1
Source: -
The following is sample output from the show ipv6 pim tunnel command on a non-RP:
# show ipv6 pim tunnel
Tunnel0*
Type :PIM Encap
RP :100::1
Source:2001::1:1:1
The table below describes the significant fields shown in the display.
Table 101: show ipv6 pim tunnel Field Descriptions
Field Description
Tunnel0* Name of the tunnel.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
716
IP Addressing Services
show ipv6 pim tunnel
Field Description
Type Type of tunnel. Can be PIM encapsulation or PIM de-encapsulation.
source Source address of the router that is sending encapsulating registers to the RP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
717
IP Addressing Services
show ipv6 policy
show ipv6 policy
To display the IPv6 policy-based routing (PBR) configuration, use the show ipv6 policy command in user
EXEC or privileged EXEC mode.
show ipv6 policy
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines IPv6 policy matches will be counted on route maps, as is done in IPv4. Therefore, IPv6 policy matches can
also be displayed on the show route-map command.
Examples The following example displays the PBR configuration:
# show ipv6 policy
Interface Routemap
Ethernet0/0 src-1
The table below describes the significant fields shown in the display.
Field Description
Interface Interface type and number that is configured to run Protocol-Independent Multicast (PIM).
Routemap The name of the route map on which IPv6 policy matches were counted.
Related Commands Command Description
show route-map Displays all route maps configured or only the one specified.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
718
IP Addressing Services
show ipv6 prefix-list
show ipv6 prefix-list
To display information about an IPv6 prefix list or IPv6 prefix list entries, use the show ipv6 prefix-list
command in user EXEC or privileged EXEC mode.
show ipv6 prefix-list [{detail | summary}] [list-name]
show ipv6 prefix-list list-name ipv6-prefix/prefix-length [{longer | first-match}]
show ipv6 prefix-list list-name seq seq-num
Syntax Description detail | summary (Optional) Displays detailed or summarized information about all IPv6 prefix lists.
list-name (Optional) The name of a specific IPv6 prefix list.
ipv6-prefix All prefix list entries for the specified IPv6 network.
This argument must be in the form documented in RFC 2373 where the address is
specified in hexadecimal using 16-bit values between colons.
/ prefix-length The length of the IPv6 prefix. A decimal value that indicates how many of the high-order
contiguous bits of the address comprise the prefix (the network portion of the address).
A slash mark must precede the decimal value.
longer (Optional) Displays all entries of an IPv6 prefix list that are more specific than the given
ipv6-prefix / prefix-lengthvalues.
first-match (Optional) Displays the entry of an IPv6 prefix list that matches the given ipv6-prefix /
prefix-lengthvalues.
seq seq-num The sequence number of the IPv6 prefix list entry.
Command Default Displays information about all IPv6 prefix lists.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 prefix-list command provides output similar to the show ip prefix-list command, except that
it is IPv6-specific.
Examples The following example shows the output of the show ipv6 prefix-list command with the detail
keyword:
# show ipv6 prefix-list detail
Prefix-list with the last deletion/insertion: bgp-in
ipv6 prefix-list 6to4:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
719
IP Addressing Services
show ipv6 prefix-list
count: 1, range entries: 0, sequences: 5 - 5, refcount: 2
seq 5 permit 2002::/16 (hit count: 313, refcount: 1)
ipv6 prefix-list aggregate:
count: 2, range entries: 2, sequences: 5 - 10, refcount: 30
seq 5 deny 3FFE:C00::/24 ge 25 (hit count: 568, refcount: 1)
seq 10 permit ::/0 le 48 (hit count: 31310, refcount: 1)
ipv6 prefix-list bgp-in:
count: 6, range entries: 3, sequences: 5 - 30, refcount: 31
seq 5 deny 5F00::/8 le 128 (hit count: 0, refcount: 1)
seq 10 deny ::/0 (hit count: 0, refcount: 1)
seq 15 deny ::/1 (hit count: 0, refcount: 1)
seq 20 deny ::/2 (hit count: 0, refcount: 1)
seq 25 deny ::/3 ge 4 (hit count: 0, refcount: 1)
seq 30 permit ::/0 le 128 (hit count: 240664, refcount: 0)
The table below describes the significant fields shown in the display.
Table 102: show ipv6 prefix-list Field Descriptions
Field Description
Prefix list with the latest deletion/insertion: Prefix list that was last modified.
count Number of entries in the list.
range entries Number of entries with matching range.
sequences Sequence number for the prefix entry.
refcount Number of objects currently using this prefix list.
seq Entry number in the list.
permit, deny Granting status.
hit count Number of matches for the prefix entry.
The following example shows the output of the show ipv6 prefix-list command with the summary
keyword:
# show ipv6 prefix-list summary
Prefix-list with the last deletion/insertion: bgp-in
ipv6 prefix-list 6to4:
count: 1, range entries: 0, sequences: 5 - 5, refcount: 2
ipv6 prefix-list aggregate:
count: 2, range entries: 2, sequences: 5 - 10, refcount: 30
ipv6 prefix-list bgp-in:
count: 6, range entries: 3, sequences: 5 - 30, refcount: 31
Related Commands Command Description
clear ipv6 prefix-list Resets the hit count of the prefix list entries.
distribute-list in Filters networks received in updates.
distribute-list out Suppresses networks from being advertised in updates.
ipv6 prefix-list Creates an entry in an IPv6 prefix list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
720
IP Addressing Services
show ipv6 prefix-list
Command Description
ipv6 prefix-list description Adds a text description of an IPv6 prefix list.
match ipv6 address Distributes IPv6 routes that have a prefix permitted by a prefix list.
neighbor prefix-list Distributes BGP neighbor information as specified in a prefix list.
remark (prefix-list) Adds a comment for an entry in a prefix list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
721
IP Addressing Services
show ipv6 protocols
show ipv6 protocols
To display the parameters and the current state of the active IPv6 routing protocol processes, use the show
ipv6 protocols command in user EXEC or privileged EXEC mode.
show ipv6 protocols [summary]
Syntax Description summary (Optional) Displays the configured routing protocol process names.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The information displayed by the show ipv6 protocols command is useful in debugging routing operations.
Examples The following sample output from the show ipv6 protocols command displays Intermediate
System-to-Intermediate System (IS-IS) routing protocol information:
# show ipv6 protocols
IPv6 Routing Protocol is "connected"
IPv6 Routing Protocol is "static"
IPv6 Routing Protocol is "isis"
Interfaces:
Ethernet0/0/3
Ethernet0/0/1
Serial1/0/1
Loopback1 (Passive)
Loopback2 (Passive)
Loopback3 (Passive)
Loopback4 (Passive)
Loopback5 (Passive)
Redistribution:
Redistributing protocol static at level 1
Inter-area redistribution
Redistributing L1 into L2 using prefix-list word
Address Summarization:
L2: 33::/16 advertised with metric 0
L2: 44::/16 advertised with metric 20
L2: 66::/16 advertised with metric 10
L2: 77::/16 advertised with metric 10
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
722
IP Addressing Services
show ipv6 protocols
Table 103: show ipv6 protocols Field Descriptions for IS-IS Processes
Field Description
IPv6 Routing Protocol is Specifies the IPv6 routing protocol used.
Interfaces Specifies the interfaces on which the IPv6 IS-IS protocol is configured.
Redistribution Lists the protocol that is being redistributed.
Inter-area redistribution Lists the IS-IS levels that are being redistributed into other levels.
using prefix-list Names the prefix list used in the interarea redistribution.
Address Summarization Lists all the summary prefixes. If the summary prefix is being advertised,
"advertised with metric x" will be displayed after the prefix.
The following sample output from the show ipv6 protocols command displays the Border Gateway
Protocol (BGP) information for autonomous system 30:
# show ipv6 protocols
IPv6 Routing Protocol is "bgp 30"
IGP synchronization is disabled
Redistribution:
Redistributing protocol connected
Neighbor(s):
Address FiltIn FiltOut Weight RoutemapIn RoutemapOut
2001:DB8:0:ABCD::1 5 7 200
2001:DB8:0:ABCD::2 rmap-in rmap-out
2001:DB8:0:ABCD::3 rmap-in rmap-out
The table below describes the significant fields shown in the display.
Table 104: show ipv6 protocols Field Descriptions for BGP Process
Field Description
IPv6 Routing Protocol is Specifies the IPv6 routing protocol used.
Redistribution Lists the protocol that is being redistributed.
Address Neighbor IPv6 address.
FiltIn AS-path filter list applied to input.
FiltOut AS-path filter list applied to output.
Weight Neighbor weight value used in BGP best path selection.
RoutemapIn Neighbor route map applied to input.
RoutemapOut Neighbor route map applied to output.
The following is sample output from the show ipv6 protocols summary command:
# show ipv6 protocols summary
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
723
IP Addressing Services
show ipv6 protocols
Index Process Name
0 connected
1 static
2 rip myrip
3 bgp 30
The following sample output from the show ipv6 protocols command displays the EIGRP information
including the vector metric and EIGRP IPv6 NSF:
# show ipv6 protocols
IPv6 Routing Protocol is "connected"
IPv6 Routing Protocol is "bgp 1"
IGP synchronization is disabled
Redistribution:
None
IPv6 Routing Protocol is "bgp multicast"
IPv6 Routing Protocol is "ND"
IPv6 Routing Protocol is "eigrp 1"
EIGRP-IPv6 VR(name) Address-Family Protocol for AS(1)
Metric weight K1=1, K2=0, K3=1, K4=0, K5=0 K6=0
Metric rib-scale 128
Metric version 64bit
NSF-aware route hold timer is 260
EIGRP NSF enabled
NSF signal timer is 15s
NSF converge timer is 65s
Router-ID: 10.1.2.2
Topology : 0 (base)
Active Timer: 3 min
Distance: internal 90 external 170
Maximum path: 16
Maximum hopcount 100
Maximum metric variance 1
Total Prefix Count: 0
Total Redist Count: 0
Interfaces:
Redistribution:
None
The following example displays IPv6 protocol information after configuring redistribution in an
Open Shortest Path First (OSPF) domain:
# redistribute ospf 1 match internal
(config-rtr)# end
# show ipv6 protocols
IPv6 Routing Protocol is "connected"
IPv6 Routing Protocol is "ND"
IPv6 Routing Protocol is "rip 1"
Interfaces:
Ethernet0/1
Loopback9
Redistribution:
Redistributing protocol ospf 1 (internal)
IPv6 Routing Protocol is "ospf 1"
Interfaces (Area 0):
Ethernet0/0
Redistribution:
None
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
724
IP Addressing Services
show ipv6 rip
show ipv6 rip
To display information about current IPv6 Routing Information Protocol (RIP) processes, use the show ipv6
rip command in user EXEC or privileged EXEC mode.
show ipv6 rip [name] [vrf vrf-name][{database | next-hops}]
show ipv6 rip [name] [{database | next-hops}]
Syntax Description name (Optional) Name of the RIP process. If the name is not entered, details of all configured RIP
processes are displayed.
vrf vrf-name (Optional) Displays information about the specified Virtual Routing and Forwarding (VRF)
instance.
database (Optional) Displays information about entries in the specified RIP IPv6 routing table.
next-hops (Optional) Displays information about the next hop addresses for the specified RIP IPv6
process. If no RIP process name is specified, the next-hop addresses for all RIP IPv6 processes
are displayed.
Command Default Information about all current IPv6 RIP processes is displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following is sample output from the show ipv6 rip command:
# show ipv6 rip
RIP process "one", port 521, multicast-group FF02::9, pid 55
Administrative distance is 25. Maximum paths is 4
Updates every 30 seconds, expire after 180
Holddown lasts 0 seconds, garbage collect after 120
Split horizon is on; poison reverse is off
Default routes are not generated
Periodic updates 8883, trigger updates 2
Interfaces:
Ethernet2
Redistribution:
RIP process "two", port 521, multicast-group FF02::9, pid 61
Administrative distance is 120. Maximum paths is 4
Updates every 30 seconds, expire after 180
Holddown lasts 0 seconds, garbage collect after 120
Split horizon is on; poison reverse is off
Default routes are not generated
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
725
IP Addressing Services
show ipv6 rip
Periodic updates 8883, trigger updates 0
Interfaces:
None
Redistribution:
The table below describes the significant fields shown in the display.
Table 105: show ipv6 rip Field Descriptions
Field Description
RIP process The name of the RIP process.
port The port that the RIP process is using.
multicast-group The IPv6 multicast group of which the RIP process is a member.
pid The process identification number (pid) assigned to the RIP process.
Administrative distance Used to rank the preference of sources of routing information. Connected routes
have an administrative distance of 1 and are preferred over the same route learned
by a protocol with a larger administrative distance value.
Updates The value (in seconds) of the update timer.
expire The interval (in seconds) in which updates expire.
Holddown The value (in seconds) of the hold-down timer.
garbage collect The value (in seconds) of the garbage-collect timer.
Split horizon The split horizon state is either on or off.
poison reverse The poison reverse state is either on or off.
Default routes The origination of a default route into RIP. Default routes are either generated or
not generated.
Periodic updates The number of RIP update packets sent on an update timer.
trigger updates The number of RIP update packets sent as triggered updates.
The following is sample output from the show ipv6 rip database command.
# show ipv6 rip one database
RIP process "one", local RIB
2001:72D:1000::/64, metric 2
Ethernet2/2001:DB8:0:ABCD::1, expires in 168 secs
2001:72D:2000::/64, metric 2, installed
Ethernet2/2001:DB8:0:ABCD::1, expires in 168 secs
2001:72D:3000::/64, metric 2, installed
Ethernet2/2001:DB8:0:ABCD::1, expires in 168 secs
Ethernet1/2001:DB8::1, expires in 120 secs
2001:72D:4000::/64, metric 16, expired, [advertise 119/hold 0]
Ethernet2/2001:DB8:0:ABCD::1
3004::/64, metric 2 tag 2A, installed
Ethernet2/2001:DB8:0:ABCD::1, expires in 168 secs
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
726
IP Addressing Services
show ipv6 rip
The table below describes the significant fields shown in the display.
Table 106: show ipv6 rip database Field Descriptions
Field Description
RIP process The name of the RIP process.
2001:72D:1000::/64 The IPv6 route prefix.
metric Metric for the route.
installed Route is installed in the IPv6 routing table.
Ethernet2/2001:DB8:0:ABCD::1 Interface and LL next hop through which the IPv6 route was learned.
expires in The interval (in seconds) before the route expires.
advertise For an expired route, the value (in seconds) during which the route will
be advertised as expired.
hold The value (in seconds) of the hold-down timer.
tag Route tag.
The following is sample output from the show ipv6 rip next-hops command.
# show ipv6 rip one next-hops
RIP process "one", Next Hops
FE80::210:7BFF:FEC2:ACCF/Ethernet4/2 [1 routes]
FE80::210:7BFF:FEC2:B286/Ethernet4/2 [2 routes]
The table below describes the significant fields shown in the display.
Table 107: show ipv6 rip next-hops Field Descriptions
Field Description
RIP process The name of the RIP process.
2001:DB8:0:1::1/Ethernet4/2 The next-hop address and interface through which it was learned. Next hops
are either the addresses of IPv6 RIP neighbors from which we have learned
routes or explicit next hops received in IPv6 RIP advertisements.
Note An IPv6 RIP neighbor may choose to advertise all its routes with
an explicit next hop. In this case the address of the neighbor would
not appear in the next hop display.
[1 routes] The number of routes in the IPv6 RIP routing table using the specified next
hop.
The following is sample output from the show ipv6 rip vrf command:
# show ipv6 rip vrf red
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
727
IP Addressing Services
show ipv6 rip
RIP VRF "red", port 521, multicast-group 2001:DB8::/32, pid 295
Administrative distance is 120. Maximum paths is 16
Updates every 30 seconds, expire after 180
Holddown lasts 0 seconds, garbage collect after 120
Split horizon is on; poison reverse is off
Default routes are not generated
Periodic updates 99, trigger updates 3
Full Advertisement 0, Delayed Events 0
Interfaces:
Ethernet0/1
Loopback2
Redistribution:
None
The table below describes the significant fields shown in the display.
Table 108: show ipv6 rip vrf Field Descriptions
Field Description
RIP VRF The name of the RIP VRF.
port The port that the RIP process is using.
multicast-group The IPv6 multicast group of which the RIP process is a member.
Administrative distance Used to rank the preference of sources of routing information. Connected routes
have an administrative distance of 1 and are preferred over the same route learned
by a protocol with a larger administrative distance value.
Updates The value (in seconds) of the update timer.
expires after The interval (in seconds) in which updates expire.
Holddown The value (in seconds) of the hold-down timer.
garbage collect The value (in seconds) of the garbage-collect timer.
Split horizon The split horizon state is either on or off.
poison reverse The poison reverse state is either on or off.
Default routes The origination of a default route into RIP. Default routes are either generated or
not generated.
Periodic updates The number of RIP update packets sent on an update timer.
trigger updates The number of RIP update packets sent as triggered updates.
The following is sample output from show ipv6 rip vrf next-hops command:
Device# show ipv6 rip vrf blue next-hops
RIP VRF "blue", local RIB
AAAA::/64, metric 2, installed
Ethernet0/0/FE80::A8BB:CCFF:FE00:7C00, expires in 177 secs
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
728
IP Addressing Services
show ipv6 rip
Table 109: show ipv6 rip vrf next-hops Field Descriptions
Field Description
RIP VRF The name of the RIP VRF.
metric Metric for the route.
installed Route is installed in the IPv6 routing table.
Ethernet0/0/FE80::A8BB:CCFF:FE00:7C00 The next hop address and interface through which it was
learned. Next hops are either the addresses of IPv6 RIP
neighbors from which we have learned routes, or explicit next
hops received in IPv6 RIP advertisements.
Note An IPv6 RIP neighbor may choose to advertise
all its routes with an explicit next hop. In this case
the address of the neighbor would not appear in
the next hop display.
expires in The interval (in seconds) before the route expires.
The following is sample output from show ipv6 rip vrf database command:
# show ipv6 rip vrf blue database
RIP VRF "blue", Next Hops
FE80::A8BB:CCFF:FE00:7C00/Ethernet0/0 [1 paths]
Table 110: show ipv6 rip vrf database Field Descriptions
Field Description
RIP VRF The name of the RIP VRF.
FE80::A8BB:CCFF:FE00:7C00/Ethernet0/0 Interface and LL next hop through which the IPv6 route was
learned.
1 paths Indicates the number of unique paths to this router that exist in
the routing table.
Related Commands Command Description
clear ipv6 rip Deletes routes from the IPv6 RIP routing table.
debug ipv6 rip Displays the current contents of the IPv6 RIP routing table.
ipv6 rip vrf-mode enable Enables VRF-aware support for IPv6 RIP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
729
IP Addressing Services
show ipv6 route
show ipv6 route
To display contents of the IPv6 routing table, use the show ipv6 route command in user EXEC or privileged
EXEC mode.
show ipv6 route [{ipv6-address | ipv6-prefix/prefix-length [{longer-prefixes}] | [{protocol}] | [repair]
| [{updated [{boot-up}] [{day month}] [{time}]}] | interface type number | nd | nsf | table table-id |
watch}]
Syntax Description ipv6-address (Optional) Displays routing information for a specific IPv6 address.
ipv6-prefix (Optional) Displays routing information for a specific IPv6 network.
/prefix-length (Optional) The length of the IPv6 prefix. A decimal value that indicates how many of the
high-order contiguous bits of the address comprise the prefix (the network portion of the
address). A slash mark must precede the decimal value.
longer-prefixes (Optional) Displays output for longer prefix entries.
protocol (Optional) The name of a routing protocol or the keyword connected, local, mobile, or
static. If you specify a routing protocol, use one of the following keywords: bgp, isis, eigrp,
ospf, or rip.
repair (Optional) Displays routes with repair paths.
updated (Optional) Displays routes with time stamps.
boot-up (Optional) Displays routing information since bootup.
day month (Optional) Displays routes since the specified day and month.
time (Optional) Displays routes since the specified time, in hh:mm format.
interface (Optional) Displays information about the interface.
type (Optional) Interface type.
number (Optional) Interface number.
nd (Optional) Displays only routes from the IPv6 Routing Information Base (RIB) that are
owned by Neighbor Discovery (ND).
nsf (Optional) Displays routes in the nonstop forwarding (NSF) state.
repair (Optional)
table table-id (Optional) Displays IPv6 RIB table information for the specified table ID. The table ID
must be in hexadecimal format. The range is from 0 to 0-0xFFFFFFFF.
watch (Optional) Displays information about route watchers.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
730
IP Addressing Services
show ipv6 route
Command Default If none of the optional syntax elements is chosen, all IPv6 routing information for all active routing tables is
displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 route command provides output similar to the show ip route command, except that the
information is IPv6-specific.
When the ipv6-address or ipv6-prefix/prefix-length argument is specified, the longest match lookup is performed
from the routing table, and only route information for that address or network is displayed. When a routing
protocol is specified, only routes for that protocol are displayed. When the connected, local, mobile, or static
keyword is specified, only the specified type of route is displayed. When the interface keyword and type and
number arguments are specified, only routes for the specified interface are displayed.
Examples The following is sample output from the show ipv6 route command when no keywords or arguments
are specified:
# show ipv6 route
IPv6 Routing Table - 9 entries
Codes: C - Connected, L - Local, S - Static, R - RIP, B - BGP
I1 - ISIS L1, I2 - ISIS L2, IA - IIS interarea
B 2001:DB8:4::2/48 [20/0]
via FE80::A8BB:CCFF:FE02:8B00, Serial6/0
L 2001:DB8:4::3/48 [0/0]
via ::, Ethernet1/0
C 2001:DB8:4::4/48 [0/0]
via ::, Ethernet1/0
LC 2001:DB8:4::5/48 [0/0]
via ::, Loopback0
L 2001:DB8:4::6/48 [0/0]
via ::, Serial6/0
C 2001:DB8:4::7/48 [0/0]
via ::, Serial6/0
S 2001:DB8:4::8/48 [1/0]
via 2001:DB8:1::1, Null
L FE80::/10 [0/0]
via ::, Null0
L FF00::/8 [0/0]
via ::, Null0
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
731
IP Addressing Services
show ipv6 route
Table 111: show ipv6 route Field Descriptions
Field Description
Codes: Indicates the protocol that derived the route. Values are as follows:
• B—BGP derived
• C—Connected
• I1—ISIS L1—Integrated IS-IS Level 1 derived
• I2—ISIS L2—Integrated IS-IS Level 2 derived
• IA—ISIS interarea—Integrated IS-IS interarea derived
• L—Local
• R—RIP derived
• S—Static
2001:DB8:4::2/48 Indicates the IPv6 prefix of the remote network.
[20/0] The first number in brackets is the administrative distance of the information
source; the second number is the metric for the route.
via Specifies the address of the next device to the remote network.
FE80::A8BB:CCFF:FE02:8B00
When the ipv6-address or ipv6-prefix/prefix-length argument is specified, only route information
for that address or network is displayed. The following is sample output from the show ipv6 route
command when IPv6 prefix 2001:DB8::/35 is specified. The fields in the display are self-explanatory.
# show ipv6 route 2001:DB8::/35
IPv6 Routing Table - 261 entries
Codes: C - Connected, L - Local, S - Static, R - RIP, B - BGP
I1 - ISIS L1, I2 - ISIS L2, IA - ISIS interarea
B 2001:DB8::/35 [20/3]
via FE80::60:5C59:9E00:16, Tunnel1
When you specify a protocol, only routes for that particular routing protocol are shown. The following
is sample output from the show ipv6 route bgp command. The fields in the display are
self-explanatory.
# show ipv6 route bgp
IPv6 Routing Table - 9 entries
Codes: C - Connected, L - Local, S - Static, R - RIP, B - BGP
I1 - ISIS L1, I2 - ISIS L2, IA - ISIS interarea
B 2001:DB8:4::4/64 [20/0]
via FE80::A8BB:CCFF:FE02:8B00, Serial6/0
The following is sample output from the show ipv6 route local command. The fields in the display
are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
732
IP Addressing Services
show ipv6 route
# show ipv6 route local
IPv6 Routing Table - 9 entries
Codes: C - Connected, L - Local, S - Static, R - RIP, B - BGP
I1 - ISIS L1, I2 - ISIS L2, IA - ISIS interarea
L 2001:DB8:4::2/128 [0/0]
via ::, Ethernet1/0
LC 2001:DB8:4::1/128 [0/0]
via ::, Loopback0
L 2001:DB8:4::3/128 [0/0]
via ::, Serial6/0
L FE80::/10 [0/0]
via ::, Null0
L FF00::/8 [0/0]
via ::, Null0
The following is sample output from the show ipv6 route command when the 6PE multipath feature
is enabled. The fields in the display are self-explanatory.
# show ipv6 route
IPv6 Routing Table - default - 19 entries
Codes:C - Connected, L - Local, S - Static, R - RIP, B - BGP
U - Per-user Static route
I1 - ISIS L1, I2 - ISIS L2, IA - ISIS interarea, IS - ISIS summary
O - OSPF intra, OI - OSPF inter, OE1 - OSPF ext 1, OE2 - OSPF ext 2
.
.
.
B 2001:DB8::/64 [200/0]
via ::FFFF:172.16.0.1
via ::FFFF:172.30.30.1
Related Commands Command Description
ipv6 route Establishes a static IPv6 route.
show ipv6 interface Displays IPv6 interface information.
show ipv6 route summary Displays the current contents of the IPv6 routing table in summary format.
show ipv6 tunnel Displays IPv6 tunnel information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
733
IP Addressing Services
show ipv6 routers
show ipv6 routers
To display IPv6 router advertisement (RA) information received from on-link devices, use the show ipv6
routers command in user EXEC or privileged EXEC mode.
show ipv6 routers [interface-type interface-number][conflicts][vrf vrf-name][detail]
Syntax Description interface -type (Optional) Specifies the Interface type.
interface -number (Optional) Specifies the Interface number.
conflicts (Optional) Displays RAs that differ from the RAs configured for a specified interface.
vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
detail (Optional) Provides detail about the eligibility of the neighbor for election as the default
device.
Command Default When an interface is not specified, on-link RA information is displayed for all interface types. (The term
onl-ink refers to a locally reachable address on the link.)
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Devices that advertise parameters that differ from the RA parameters configured for the interface on which
the RAs are received are marked as conflicting.
Examples The following is sample output from the show ipv6 routers command when entered without an IPv6
interface type and number:
# show ipv6 routers
Device FE80::83B3:60A4 on Tunnel5, last update 3 min
Hops 0, Lifetime 6000 sec, AddrFlag=0, OtherFlag=0
Reachable time 0 msec, Retransmit time 0 msec
Prefix 3FFE:C00:8007::800:207C:4E37/96 autoconfig
Valid lifetime -1, preferred lifetime -1
Device FE80::290:27FF:FE8C:B709 on Tunnel57, last update 0 min
Hops 64, Lifetime 1800 sec, AddrFlag=0, OtherFlag=0
Reachable time 0 msec, Retransmit time 0 msec
The following sample output shows a single neighboring device that is advertising a high default
device preference and is indicating that it is functioning as a Mobile IPv6 home agent on this link.
# show ipv6 routers
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
734
IP Addressing Services
show ipv6 routers
IPV6 ND Routers (table: default)
Device FE80::100 on Ethernet0/0, last update 0 min
Hops 64, Lifetime 50 sec, AddrFlag=0, OtherFlag=0, MTU=1500
HomeAgentFlag=1, Preference=High
Reachable time 0 msec, Retransmit time 0 msec
Prefix 2001::100/64 onlink autoconfig
Valid lifetime 2592000, preferred lifetime 604800
The following table describes the significant fields shown in the displays.
Table 112: show ipv6 routers Field Descriptions
Field Description
Hops The configured hop limit value for the RA.
Lifetime The configured lifetime value for the RA. A value of 0 indicates that the device is not
a default device. A value other than 0 indicates that the device is a default device.
AddrFlag If the value is 0, the RA received from the device indicates that addresses are not
configured using the stateful autoconfiguration mechanism. If the value is 1, the
addresses are configured using this mechanism.
OtherFlag If the value is 0, the RA received from the device indicates that information other than
addresses is not obtained using the stateful autoconfiguration mechanism. If the value
is 1, other information is obtained using this mechanism. (The value of OtherFlag can
be 1 only if the value of AddrFlag is 1.)
MTU The maximum transmission unit (MTU).
HomeAgentFlag=1 The value can be either 0 or 1. A value of 1 indicates that the device from which the
RA was received is functioning as a mobile IPv6 home agent on this link, and a value
of 0 indicates it is not functioning as a mobile IPv6 home agent on this link.
Preference=High The DRP value, which can be high, medium, or low.
Retransmit time The configured RetransTimer value. The time value to be used on this link for neighbor
solicitation transmissions, which are used in address resolution and neighbor
unreachability detection. A value of 0 means the time value is not specified by the
advertising device.
Prefix A prefix advertised by the device. Also indicates if on-link or autoconfig bits were set
in the RA message.
Valid lifetime The length of time (in seconds) relative to the time the advertisement is sent that the
prefix is valid for the purpose of on-link determination. A value of -1 (all ones, 0xffffffff)
represents infinity.
preferred lifetime The length of time (in seconds) relative to the time the advertisements is sent that
addresses generated from the prefix via address autoconfiguration remain valid. A value
of -1 (all ones, 0xffffffff) represents infinity.
When the interface-type and interface-number arguments are specified, RA details about that specific
interface are displayed. The following is sample output from the show ipv6 routers command when
entered with an interface type and number:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
735
IP Addressing Services
show ipv6 routers
# show ipv6 routers tunnel 5
Device FE80::83B3:60A4 on Tunnel5, last update 5 min
Hops 0, Lifetime 6000 sec, AddrFlag=0, OtherFlag=0
Reachable time 0 msec, Retransmit time 0 msec
Prefix 3FFE:C00:8007::800:207C:4E37/96 autoconfig
Valid lifetime -1, preferred lifetime -1
Entering the conflicts keyword with the show ipv6 routers command displays information for
devices that are advertising parameters different from the parameters configured for the interface on
which the advertisements are being received, as the following sample output shows:
# show ipv6 routers conflicts
Device FE80::203:FDFF:FE34:7039 on Ethernet1, last update 1 min, CONFLICT
Hops 64, Lifetime 1800 sec, AddrFlag=0, OtherFlag=0
Reachable time 0 msec, Retransmit time 0 msec
Prefix 2003::/64 onlink autoconfig
Valid lifetime -1, preferred lifetime -1
Device FE80::201:42FF:FECA:A5C on Ethernet1, last update 0 min, CONFLICT
Hops 64, Lifetime 1800 sec, AddrFlag=0, OtherFlag=0
Reachable time 0 msec, Retransmit time 0 msec
Prefix 2001::/64 onlink autoconfig
Valid lifetime -1, preferred lifetime -1
Use of the detail keyword provides information about the preference rank of the device, its eligibility
for election as default device, and whether the device has been elected:
# show ipv6 routers detail
Device FE80::A8BB:CCFF:FE00:5B00 on Ethernet0/0, last update 0 min
Rank 0x811 (elegible), Default Router
Hops 64, Lifetime 1800 sec, AddrFlag=0, OtherFlag=0, MTU=1500
HomeAgentFlag=0, Preference=Medium, trustlevel = 0
Reachable time 0 (unspecified), Retransmit time 0 (unspecified)
Prefix 2001::/64 onlink autoconfig
Valid lifetime 2592000, preferred lifetime 604800
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
736
IP Addressing Services
show ipv6 rpf
show ipv6 rpf
To check Reverse Path Forwarding (RPF) information for a given unicast host address and prefix, use the
show ipv6 rpf command in user EXEC or privileged EXEC mode.
show ipv6 rpf {source-vrf [access-list] | vrf receiver-vrf{source-vrf [access-list] | select}}
Syntax Description source-vrf Name or address of the virtual routing and forwarding (VRF) on which lookups are to be
performed.
receiver-vrf Name or address of the VRF in which the lookups originate.
access-list Name or address of access control list (ACL) to be applied to the group-based VRF selection
policy.
vrf Displays information about the VRF instance.
select Displays group-to-VRF mapping information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 rpf command displays information about how IPv6 multicast routing performs Reverse Path
Forwarding (RPF). Because the router can find RPF information from multiple routing tables (for example,
unicast Routing Information Base [RIB], multiprotocol Border Gateway Protocol [BGP] routing table, or
static mroutes), the show ipv6 rpf command to display the source from which the information is retrieved.
Examples The following example displays RPF information for the unicast host with the IPv6 address of
2001::1:1:2:
# show ipv6 rpf 2001::1:1:2
RPF information for 2001::1:1:2
RPF interface:Ethernet3/2
RPF neighbor:FE80::40:1:3
RPF route/mask:20::/64
RPF type:Unicast
RPF recursion count:0
Metric preference:110
Metric:30
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
737
IP Addressing Services
show ipv6 rpf
Table 113: show ipv6 rpf Field Descriptions
Field Description
RPF information for 2001::1:1:2 Source address that this information concerns.
RPF interface:Ethernet3/2 For the given source, the interface from which the router expects to get
packets.
RPF neighbor:FE80::40:1:3 For the given source, the neighbor from which the router expects to get
packets.
RPF route/mask:20::/64 Route number and mask that matched against this source.
RPF type:Unicast Routing table from which this route was obtained, either unicast,
multiprotocol BGP, or static mroutes.
RPF recursion count Indicates the number of times the route is recursively resolved.
Metric preference:110 The preference value used for selecting the unicast routing metric to the
Route Processor (RP) announced by the designated forwarder (DF).
Metric:30 Unicast routing metric to the RP announced by the DF.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
738
IP Addressing Services
show ipv6 source-guard policy
show ipv6 source-guard policy
To display the IPv6 source-guard policy configuration, use the show ipv6 source-guard policy command in
user EXEC or privileged EXEC mode.
show ipv6 source-guard policy[source-guard-policy]
Syntax Description source-guard-policy User-defined name of the snooping policy. The policy name can be a symbolic string
(such as Engineering) or an integer (such as 0).
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 source-guard policy command displays the IPv6 source-guard policy configuration, as well
as all the interfaces on which the policy is applied. The command also displays IPv6 prefix guard information
if the IPv6 prefix guard feature is enabled on the device.
Examples # show ipv6 source-guard policy policy1
Policy policy1 configuration:
data-glean
prefix-guard
address-guard
Policy policy1 is applied on the following targets:
Target Type Policy Feature Target range
Et0/0 PORT policy1 source-guard vlan all
vlan 100 VLAN policy1 source-guard vlan all
Related Commands Command Description
ipv6 source-guard attach-policy Applies IPv6 source guard on an interface.
ipv6 source-guard policy Defines an IPv6 source-guard policy name and
enters source-guard policy configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
739
IP Addressing Services
show ipv6 spd
show ipv6 spd
To display the IPv6 Selective Packet Discard (SPD) configuration, use the show ipv6 spd command in
privileged EXEC mode.
show ipv6 spd
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the show ipv6 spd command to display the SPD configuration, which may provide useful troubleshooting
information.
Examples The following is sample output from the show ipv6 spd command:
# show ipv6 spd
Current mode: normal
Queue max threshold: 74, Headroom: 100, Extended Headroom: 10
IPv6 packet queue: 0
The table below describes the significant fields shown in the display.
Table 114: show ipv6 spd Field Description
Field Description
Current mode: normal The current SPD state or mode.
Queue max threshold: 74 The process input queue maximum.
Related Commands Command Description
ipv6 spd queue max-threshold Configures the maximum number of packets in the SPD process input
queue.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
740
IP Addressing Services
show ipv6 static
show ipv6 static
To display the current contents of the IPv6 routing table, use the show ipv6 static command in user EXEC
or privileged EXEC mode.
show ipv6 static [{ipv6-address | ipv6-prefix/prefix-length}] [{interface type number | recursive}]
[detail]
Syntax Description ipv6-address (Optional) Provides routing information for a specific IPv6 address.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
ipv6-prefix (Optional) Provides routing information for a specific IPv6 network.
This argument must be in the form documented in RFC 2373 where the address is specified
in hexadecimal using 16-bit values between colons.
/prefix-length (Optional) The length of the IPv6 prefix. A decimal value that indicates how many of the
high-order contiguous bits of the address comprise the prefix (the network portion of the
address). A slash mark must precede the decimal value.
interface (Optional) Name of an interface.
type (Optional, but required if the interface keyword is used) Interface type. For a list of supported
interface types, use the question mark (?) online help function.
number (Optional, but required if the interface keyword is used) Interface number. For specific
numbering syntax for supported interface types, use the question mark (?) online help function.
recursive (Optional) Allows the display of recursive static routes only.
detail (Optional) Specifies the following additional information:
• For valid recursive routes, the output path set and maximum resolution depth.
• For invalid recursive routes, the reason why the route is not valid.
• For invalid direct or fully specified routes, the reason why the route is not valid.
Command Default All IPv6 routing information for all active routing tables is displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
741
IP Addressing Services
show ipv6 static
Usage Guidelines The show ipv6 static command provides output similar to the show ip route command, except that it is
IPv6-specific.
When the ipv6-address or ipv6-prefix/prefix-length argument is specified, a longest match lookup is performed
from the routing table and only route information for that address or network is displayed. Only the information
matching the criteria specified in the command syntax is displayed. For example, when the type number
arguments are specified, only the specified interface-specific routes are displayed.
Examples
show ipv6 static Command with No Options Specified in the Command Syntax: Example
When no options specified in the command, those routes installed in the IPv6 Routing Information
Base (RIB) are marked with an asterisk, as shown in the following example:
# show ipv6 static
IPv6 Static routes
Code: * - installed in RIB
* 3000::/16, interface Ethernet1/0, distance 1
* 4000::/16, via nexthop 2001:1::1, distance 1
5000::/16, interface Ethernet3/0, distance 1
* 5555::/16, via nexthop 4000::1, distance 1
5555::/16, via nexthop 9999::1, distance 1
* 5555::/16, interface Ethernet2/0, distance 1
* 6000::/16, via nexthop 2007::1, interface Ethernet1/0, distance 1
The table below describes the significant fields shown in the display.
Table 115: show ipv6 static Field Descriptions
Field Description
via nexthop Specifies the address of the next in the path to the remote network.
distance 1 Indicates the administrative distance to the specified route.
show ipv6 static Command with the IPv6 Address and Prefix: Example
When the ipv6-address or ipv6-prefix/prefix-length argument is specified, only information about
static routes for that address or network is displayed. The following is sample output from the show
ipv6 route command when entered with the IPv6 prefix 2001:200::/35:
# show ipv6 static 2001:200::/35
IPv6 Static routes
Code: * - installed in RIB
* 2001:200::/35, via nexthop 4000::1, distance 1
2001:200::/35, via nexthop 9999::1, distance 1
* 2001:200::/35, interface Ethernet2/0, distance 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
742
IP Addressing Services
show ipv6 static
show ipv6 static interface Command: Example
When an interface is supplied, only those static routes with the specified interface as the outgoing
interface are displayed. The interface keyword may be used with or without the IPv6 address and
prefix specified in the command statement.
# show ipv6 static interface ethernet 3/0
IPv6 Static routes Code: * - installed in RIB 5000::/16, interface Ethernet3/0, distance 1
show ipv6 static recursive Command: Example
When the recursive keyword is specified, only recursive static routes are displayed:
# show ipv6 static recursive
IPv6 Static routes Code: * - installed in RIB * 4000::/16, via nexthop 2001:1::1, distance 1 * 5555::/16,
via nexthop 4000::1, distance 1 5555::/16, via nexthop 9999::1, distance 1
show ipv6 static detail Command: Example
When the detail keyword is specified, the following additional information is displayed:
• For valid recursive routes, the output path set and maximum resolution depth.
• For invalid recursive routes, the reason why the route is not valid.
• For invalid direct or fully specified routes, the reason why the route is not valid.
# show ipv6 static detail
IPv6 Static routes
Code: * - installed in RIB
* 3000::/16, interface Ethernet1/0, distance 1
* 4000::/16, via nexthop 2001:1::1, distance 1
Resolves to 1 paths (max depth 1)
via Ethernet1/0
5000::/16, interface Ethernet3/0, distance 1
Interface is down
* 5555::/16, via nexthop 4000::1, distance 1
Resolves to 1 paths (max depth 2)
via Ethernet1/0
5555::/16, via nexthop 9999::1, distance 1
Route does not fully resolve
* 5555::/16, interface Ethernet2/0, distance 1
* 6000::/16, via nexthop 2007::1, interface Ethernet1/0, distance 1
Related Commands Command Description
ipv6 route Establishes a static IPv6 route.
show ip route Displays the current state of the routing table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
743
IP Addressing Services
show ipv6 static
Command Description
show ipv6 interface Displays IPv6 interface information.
show ipv6 route summary Displays the current contents of the IPv6 routing table in summary format.
show ipv6 tunnel Displays IPv6 tunnel information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
744
IP Addressing Services
show ipv6 traffic
show ipv6 traffic
To display statistics about IPv6 traffic, use the show ipv6 traffic command in user EXEC or privileged EXEC
mode.
show ipv6 traffic [interface[interface type number]]
Syntax Description interface (Optional) All interfaces. IPv6 forwarding statistics for all interfaces on which IPv6
forwarding statistics are being kept will be displayed.
interface type number (Optional) Specified interface. Interface statistics that have occurred since the
statistics were last cleared on the specific interface are displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ipv6 traffic command provides output similar to the show ip traffic command, except that it is
IPv6-specific.
Examples The following is sample output from the show ipv6 traffic command:
# show ipv6 traffic
IPv6 statistics:
Rcvd: 0 total, 0 local destination
0 source-routed, 0 truncated
0 format errors, 0 hop count exceeded
0 bad header, 0 unknown option, 0 bad source
0 unknown protocol, 0 not a device
0 fragments, 0 total reassembled
0 reassembly timeouts, 0 reassembly failures
0 unicast RPF drop, 0 suppressed RPF drop
Sent: 0 generated, 0 forwarded
0 fragmented into 0 fragments, 0 failed
0 encapsulation failed, 0 no route, 0 too big
Mcast: 0 received, 0 sent
ICMP statistics:
Rcvd: 0 input, 0 checksum errors, 0 too short
0 unknown info type, 0 unknown error type
unreach: 0 routing, 0 admin, 0 neighbor, 0 address, 0 port
parameter: 0 error, 0 header, 0 option
0 hopcount expired, 0 reassembly timeout,0 too big
0 echo request, 0 echo reply
0 group query, 0 group report, 0 group reduce
0 device solicit, 0 device advert, 0 redirects
The following is sample output for the show ipv6 interface command without IPv6 CEF running:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
745
IP Addressing Services
show ipv6 traffic
# show ipv6 interface ethernet 0/1/1
Ethernet0/1/1 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::203:FDFF:FE49:9
Description: sat-2900a f0/12
Global unicast address(es):
7::7, subnet is 7::/32
Joined group address(es):
FF02::1
FF02::2
FF02::1:FF00:7
FF02::1:FF49:9
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
Input features: RPF
Unicast RPF access-list MINI
Process Switching:
0 verification drops
0 suppressed verification drops
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds
The following is sample output for the show ipv6 interface command with IPv6 CEF running:
# show ipv6 interface ethernet 0/1/1
Ethernet0/1/1 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::203:FDFF:FE49:9
Description: sat-2900a f0/12
Global unicast address(es):
7::7, subnet is 7::/32
Joined group address(es):
FF02::1
FF02::2
FF02::1:FF00:7
FF02::1:FF49:9
MTU is 1500 bytes
ICMP error messages limited to one every 100 milliseconds
ICMP redirects are enabled
Input features: RPF
Unicast RPF access-list MINI
Process Switching:
0 verification drops
0 suppressed verification drops
CEF Switching:
0 verification drops
0 suppressed verification drops
ND DAD is enabled, number of DAD attempts: 1
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND router advertisements are sent every 200 seconds
ND router advertisements live for 1800 seconds
Hosts use stateless autoconfig for addresses.
The table below describes the significant fields shown in the display.
Table 116: show ipv6 traffic Field Descriptions
Field Description
source-routed Number of source-routed packets.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
746
IP Addressing Services
show ipv6 traffic
Field Description
truncated Number of truncated packets.
format errors Errors that can result from checks performed on header fields, the version
number, and packet length.
not a device Message sent when IPv6 unicast routing is not enabled.
0 unicast RPF drop, 0 Number of unicast and suppressed reverse path forwarding (RPF) drops.
suppressed RPF drop
failed Number of failed fragment transmissions.
encapsulation failed Failure that can result from an unresolved address or try-and-queue packet.
no route Counted when the software discards a datagram it did not know how to
route.
unreach Unreachable messages received are as follows:
• routing--Indicates no route to the destination.
• admin--Indicates that communication with the destination is
administratively prohibited.
• neighbor--Indicates that the destination is beyond the scope of the
source address. For example, the source may be a local site or the
destination may not have a route back to the source.
• address--Indicates that the address is unreachable.
• port--Indicates that the port is unreachable.
Unicast RPF access-list MINI Unicast RPF access-list in use.
Process Switching Displays process RPF counts, such as verification and suppressed
verification drops.
CEF Switching Displays CEF switching counts, such as verification drops and suppressed
verification drops.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
747
IP Addressing Services
show key chain
show key chain
To display the keychain, use the show key chain command.
show key chain [name-of-chain]
Syntax Description name-of-chain (Optional) Name of the key chain to display, as named in the key chain command.
Command Default If the command is used without any parameters, then it lists out all the key chains.
Command Modes Privileged EXEC (#)
Examples The following is sample output from the show key chain command:
show key chain
Device# show key chain
Key-chain AuthenticationGLBP:
key 1 -- text "Thisisasecretkey"
accept lifetime (always valid) - (always valid) [valid now]
send lifetime (always valid) - (always valid) [valid now]
Key-chain glbp2:
key 100 -- text "abc123"
accept lifetime (always valid) - (always valid) [valid now]
send lifetime (always valid) - (always valid) [valid now]
Related Commands Command Description
key-string Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain is valid to be sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
748
IP Addressing Services
show track
show track
To display information about objects that are tracked by the tracking process, use the show track command
in privileged EXEC mode.
show track [{object-number [brief] | application [brief] | interface [brief] | ip[route [brief] | [sla
[brief]] | ipv6 [route [brief]] | list [route [brief]] | resolution [ip | ipv6] | stub-object [brief] |
summary | timers}]
Syntax Description object-number (Optional) Object number that represents the object to be tracked. The range is from 1 to
1000.
brief (Optional) Displays a single line of information related to the preceding argument or
keyword.
application (Optional) Displays tracked application objects.
interface (Optional) Displays tracked interface objects.
ip route (Optional) Displays tracked IP route objects.
ip sla (Optional) Displays tracked IP SLA objects.
ipv6 route (Optional) Displays tracked IPv6 route objects.
list (Optional) Displays the list of boolean objects.
resolution (Optional) Displays resolution of tracked parameters.
summary (Optional) Displays the summary of the specified object.
timers (Optional) Displays polling interval timers.
Command Modes Privileged EXEC (#)
Command History Release Modification
This command was
introduced.
Usage Guidelines Use this command to display information about objects that are tracked by the tracking process. When no
arguments or keywords are specified, information for all objects is displayed.
A maximum of 1000 objects can be tracked. Although 1000 tracked objects can be configured, each tracked
object uses CPU resources. The amount of available CPU resources on a device is dependent upon variables
such as traffic load and how other protocols are configured and run. The ability to use 1000 tracked objects
is dependent upon the available CPU. Testing should be conducted on site to ensure that the service works
under the specific site traffic conditions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
749
IP Addressing Services
show track
Examples The following example shows information about the state of IP routing on the interface that is being
tracked:
Device# show track 1
Track 1
Interface GigabitEthernet 1/0/1 ip routing
IP routing is Down (no IP addr)
1 change, last change 00:01:08
The table below describes the significant fields shown in the displays.
Table 117: show track Field Descriptions
Field Description
Track Object number that is being tracked.
Interface GigabitEthernet 1/0/1 ip Interface type, interface number, and object that is being tracked.
routing
IP routing is State value of the object, displayed as Up or Down. If the object is
down, the reason is displayed.
1 change, last change Number of times that the state of a tracked object has changed and
the time (in hh:mm:ss ) since the last change.
Related Commands Command Description
show track resolution Displays the resolution of tracked parameters.
track interface Configures an interface to be tracked and enters tracking configuration mode.
track ip route Tracks the state of an IP route and enters tracking configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
750
IP Addressing Services
track
track
To configure an interface to be tracked where the Gateway Load Balancing Protocol (GLBP) weighting
changes based on the state of the interface, use the track command in global configuration mode. To remove
the tracking, use the no form of this command.
track object-number interface type number {line-protocol | ip routing | ipv6 routing}
no track object-number interface type number {line-protocol | ip routing | ipv6 routing}
Syntax Description object-number Object number in the range from 1 to 1000 representing the interface to be tracked.
interface type number Interface type and number to be tracked.
line-protocol Tracks whether the interface is up.
ip routing Tracks whether IP routing is enabled, an IP address is configured on the interface,
and the interface state is up, before reporting to GLBP that the interface is up.
ipv6 routing Tracks whether IPv6 routing is enabled, an IP address is configured on the interface,
and the interface state is up, before reporting to GLBP that the interface is up.
Command Default The state of the interfaces is not tracked.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced..
16.5.1a
Usage Guidelines Use the track command in conjunction with the glbp weighting and glbp weighting track commands to
configure parameters for an interface to be tracked. If a tracked interface on a GLBP device goes down, the
weighting for that device is reduced. If the weighting falls below a specified minimum, the device will lose
its ability to act as an active GLBP virtual forwarder.
A maximum of 1000 objects can be tracked. Although 1000 tracked objects can be configured, each tracked
object uses CPU resources. The amount of available CPU resources on a device is dependent upon variables
such as traffic load and how other protocols are configured and run. The ability to use 1000 tracked objects
is dependent upon the available CPU. Testing should be conducted on site to ensure that the service works
under the specific site traffic conditions.
Examples In the following example, TenGigabitEthernet interface 0/0/1 tracks whether GigabitEthernet interfaces
1/0/1 and 1/0/3 are up. If either of the GigabitEthernet interface goes down, the GLBP weighting is
reduced by the default value of 10. If both GigabitEthernet interfaces go down, the GLBP weighting
will fall below the lower threshold and the device will no longer be an active forwarder. To resume
its role as an active forwarder, the device must have both tracked interfaces back up, and the weighting
must rise above the upper threshold.
Device(config)# track 1 interface GigabitEthernet 1/0/1 line-protocol
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
751
IP Addressing Services
track
Device(config-track)# exit
Device(config)# track 2 interface GigabitEthernet 1/0/3 line-protocol
Device(config-track)# exit
Device(config)# interface TenGigabitEthernet 0/0/1
Device(config-if)# ip address 10.21.8.32 255.255.255.0
Device(config-if)# glbp 10 weighting 110 lower 95 upper 105
Device(config-if)# glbp 10 weighting track 1
Device(config-if)# glbp 10 weighting track 2
Related Commands Command Description
glbp weighting Specifies the initial weighting value of a GLBP gateway.
glbp weighting track Specifies an object to be tracked that affects the weighting of a GLBP gateway.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
752
IP Addressing Services
vrrp
vrrp
To create a Virtual Router Redundancy Protocol version 3 (VRRPv3) group and enter VRRPv3 group
configuration mode, use the vrrp. To remove the VRRPv3 group, use the no form of this command.
vrrp group-id address-family {ipv4 | ipv6}
no vrrp group-id address-family {ipv4 | ipv6}
Syntax Description group-id Virtual router group number. The range is from 1 to 255.
address-family Specifies the address-family for this VRRP group.
ipv4 (Optional) Specifies IPv4 address.
ipv6 (Optional) Specifies IPv6 address.
Command Default None
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced..
16.5.1a
Usage Guidelines
Examples The following example shows how to create a VRRPv3 group and enter VRRP configuration mode:
Device(config-if)# vrrp 3 address-family ipv4
Related Commands Command Description
timers advertise Sets the advertisement timer in milliseconds.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
753
IP Addressing Services
vrrp description
vrrp description
To assign a description to the Virtual Router Redundancy Protocol (VRRP) group, use the vrrp description
command in interface configuration mode. To remove the description, use the no form of this command.
description text
no description
Syntax Description text Text (up to 80 characters) that describes the purpose or use of the group.
Command Default There is no description of the VRRP group.
Command Modes VRRP configuration (config-if-vrrp)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following example enables VRRP. VRRP group 1 is described as Building A – Marketing and
Administration.
Device(config-if-vrrp)# description Building A - Marketing and Administration
Related Commands Command Description
vrrp Creates a VRRPv3 group and enters VRRPv3 group configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
754
IP Addressing Services
vrrp preempt
vrrp preempt
To configure the device to take over as primary virtual router for a Virtual Router Redundancy Protocol
(VRRP) group if it has higher priority than the current primary virtual router, use the preempt command in
VRRP configuration mode. To disable this function, use the no form of this command.
preempt [delay minimum seconds]
no preempt
Syntax Description delay minimum seconds (Optional) Number of seconds that the device will delay before issuing an
advertisement claiming primary ownership. The default delay is 0 seconds.
Command Default This command is enabled.
Command Modes VRRP configuration (config-if-vrrp)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines By default, the device being configured with this command will take over as primary virtual router for the
group if it has a higher priority than the current primary virtual router. You can configure a delay, which will
cause the VRRP device to wait the specified number of seconds before issuing an advertisement claiming
primary ownership.
Note The device that is the IP address owner will preempt, regardless of the setting of this command.
Examples The following example configures the device to preempt the current primary virtual router when its
priority of 200 is higher than that of the current primary virtual router. If the device preempts the
current primary virtual router, it waits 15 seconds before issuing an advertisement claiming it is the
primary virtual router.
Device(config-if-vrrp)#preempt delay minimum 15
Related Commands Command Description
vrrp Creates a VRRPv3 group and enters VRRPv3 group configuration mode.
priority Sets the priority level of the device within a VRRP group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
755
IP Addressing Services
vrrp priority
vrrp priority
To set the priority level of the device within a Virtual Router Redundancy Protocol (VRRP) group, use the
priority command in interface configuration mode. To remove the priority level of the device, use the no
form of this command.
priority level
no priority level
Syntax Description level Priority of the device within the VRRP group. The range is from 1 to 254. The default is 100.
Command Default The priority level is set to the default value of 100.
Command Modes VRRP configuration (config-if-vrrp)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to control which device becomes the primary virtual router.
Examples The following example configures the device with a priority of 254:
Device(config-if-vrrp)# priority 254
Related Commands Command Description
vrrp Creates a VRRPv3 group and enters VRRPv3 group configuration mode.
vrrp preempt Configures the device to take over as primary virtual router for a VRRP group if it has
higher priority than the current primary virtual router.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
756
IP Addressing Services
vrrp timers advertise
vrrp timers advertise
To configure the interval between successive advertisements by the primary virtual router in a Virtual Router
Redundancy Protocol (VRRP) group, use the timers advertise command in VRRP configuration mode. To
restore the default value, use the no form of this command.
timers advertise [msec] interval
no timers advertise [msec] interval
Syntax Description group Virtual router group number. The group number range is from 1 to 255.
msec (Optional) Changes the unit of the advertisement time from seconds to milliseconds. Without this
keyword, the advertisement interval is in seconds.
interval Time interval between successive advertisements by the primary virtual router. The unit of the
interval is in seconds, unless the msec keyword is specified. The default is 1 second. The valid
range is 1 to 255 seconds. When the msec keyword is specified, the valid range is 50 to 999
milliseconds.
Command Default The default interval of 1 second is configured.
Command Modes VRRP configuration (config-if-vrrp)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The advertisements being sent by the primary virtual router communicate the state and priority of the current
primary virtual router.
The vrrp timers advertise command configures the time between successive advertisement packets and the
time before other routers declare the primary router to be down. Routers or access servers on which timer
values are not configured can learn timer values from the primary router. The timers configured on the primary
router always override any other timer settings. All routers in a VRRP group must use the same timer values.
If the same timer values are not set, the devices in the VRRP group will not communicate with each other and
any misconfigured device will change its state to primary.
Examples The following example shows how to configure the primary virtual router to send advertisements
every 4 seconds:
Device(config-if-vrrp)# timers advertise 4
Related Commands Command Description
vrrp Creates a VRRPv3 group and enters VRRPv3 group configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
757
IP Addressing Services
vrrp timers advertise
Command Description
timers learn Configures the device, when it is acting as backup virtual router for a VRRP group, to learn
the advertisement interval used by the primary virtual router.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
758
IP Addressing Services
vrrs leader
vrrs leader
To specify a leader’s name to be registered with Virtual Router Redundancy Service (VRRS), use the vrrs
leader command. To remove the specified VRRS leader, use the no form of this command.
vrrs leader vrrs-leader-name
no vrrs leader vrrs-leader-name
Syntax Description vrrs-leader-name Name of VRRS Tag to lead.
Command Default A registered VRRS name is unavailable by default.
Command Modes VRRP configuration (config-if-vrrp)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following example specifies a leader's name to be registered with VRRS:
Device(config-if-vrrp)# vrrs leader leader-1
Related Commands Command Description
vrrp Creates a VRRP group and enters VRRP configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
759
IP Addressing Services
vrrs leader
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
760
PA R T V
IP Multicast Routing
• IP Multicast Routing Commands, on page 763
IP Multicast Routing Commands
• clear ip mfib counters, on page 765
• clear ip mroute, on page 766
• debug condition vrf, on page 767
• debug ip pim, on page 768
• debug ipv6 pim, on page 770
• ip igmp filter, on page 772
• ip igmp max-groups, on page 773
• ip igmp profile, on page 775
• ip igmp snooping, on page 776
• ip igmp snooping last-member-query-count, on page 777
• ip igmp snooping querier, on page 779
• ip igmp snooping report-suppression, on page 781
• ip igmp snooping vlan mrouter, on page 782
• ip igmp snooping vlan static, on page 783
• ip multicast auto-enable, on page 784
• ip multicast-routing, on page 785
• ip pim accept-register, on page 786
• ip pim bidir-enable, on page 787
• ip pim bsr-candidate, on page 788
• ip pim rp-address, on page 790
• ip pim rp-candidate, on page 792
• ip pim send-rp-announce, on page 793
• ip pim spt-threshold, on page 795
• match message-type, on page 796
• match service-type, on page 797
• match service-instance, on page 798
• mrinfo, on page 799
• service-policy-query, on page 801
• service-policy, on page 802
• show ip igmp filter, on page 803
• show ip igmp profile, on page 804
• show ip igmp snooping, on page 805
• show ip igmp snooping groups, on page 807
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
763
IP Multicast Routing
• show ip igmp snooping mrouter, on page 809
• show ip igmp snooping querier, on page 810
• show ip mroute, on page 812
• show ip pim autorp, on page 820
• show ip pim bsr-router, on page 822
• show ip pim bsr, on page 823
• show ip pim interface df, on page 824
• show ip pim rp, on page 826
• show ip pim tunnel, on page 829
• show platform software fed switch ip multicast groups, on page 831
• show platform software fed switch ip multicast, on page 832
• show platform software fed switch ip multicast df, on page 835
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
764
IP Multicast Routing
clear ip mfib counters
clear ip mfib counters
To clear all the active IPv4 Multicast Forwarding Information Base (MFIB) traffic counters, use the clear ip
mfib counters command in privileged EXEC mode.
clear ip mfib [global | vrf *] counters [group-address] [hostname | source-address]
Syntax Description global (Optional) Resets the IP MFIB cache to the global default configuration.
vrf * (Optional) Clears the IP MFIB cache for all VPN routing and forwarding instances.
group-address (Optional) Limits the active MFIB traffic counters to the indicated group address.
hostname (Optional) Limits the active MFIB traffic counters to the indicated host name.
source-address (Optional) Limits the active MFIB traffic counters to the indicated source address.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following example shows how to reset all the active MFIB traffic counters for all the multicast
tables:
# clear ip mfib counters
The following example shows how to reset the IP MFIB cache counters to the global default
configuration:
# clear ip mfib global counters
The following example shows how to clear the IP MFIB cache for all the VPN routing and forwarding
instances:
# clear ip mfib vrf * counters
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
765
IP Multicast Routing
clear ip mroute
clear ip mroute
To delete the entries in the IP multicast routing table, use the clear ip mroutecommand in privileged EXEC
mode.
clear ip mroute [vrf vrf-name]{* | ip-address | group-address}[hostname | source-address]
Syntax Description vrf vrf-name (Optional) Specifies the name that is assigned to the multicast VPN routing and forwarding
(VRF) instance.
* Specifies all Multicast routes.
ip-address Multicast routes for the IP address.
group-address Multicast routes for the group address.
hostname (Optional) Multicast routes for the host name.
source-address (Optional) Multicast routes for the source address.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The group-address variable specifies one of the following:
• Name of the multicast group as defined in the DNS hosts table or with the ip host command.
• IP address of the multicast group in four-part, dotted notation.
If you specify a group name or address, you can also enter the source argument to specify a name or address
of a multicast source that is sending to the group. A source does not need to be a member of the group.
Example
The following example shows how to delete all the entries from the IP multicast routing table:
# clear ip mroute *
The following example shows how to delete all the sources on the 228.3.0.0 subnet that are sending
to the multicast group 224.2.205.42 from the IP multicast routing table. This example shows how to
delete all sources on network 228.3, not individual sources:
# clear ip mroute 224.2.205.42 228.3.0.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
766
IP Multicast Routing
debug condition vrf
debug condition vrf
To limit debug output to a specific virtual routing and forwarding (VRF) instance, use the debug condition
vrf command in privileged EXEC mode. To remove the debug condition, use the no form of the command.
debug condition vrf {default | global | green | name {vrf-name | green}}
no debug condition vrf {default | global | green | name {vrf-name | green}}
Syntax Description
Syntax Description
default Specifies the default routing table.
global Specifies the global routing table.
green Specifies the VRF name.
name vrf-name Specifies the name of the routing table.
Command Modes Privileged EXEC mode (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to limit debug output to a single VRF.
Caution Because debugging output is assigned high priority in the CPU process, it can render the system unusable.
For this reason, use the debug commands only to troubleshoot specific problems or during troubleshooting
sessions with Cisco technical support staff. It is best to use the debug commands during periods of lower
network traffic and fewer users. Debugging during these periods decreases the likelihood that increased debug
command processing overhead will affect system use.
Example
The following example shows how to limit debugging output to VRF red:
Device# debug condition vrf red
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
767
IP Multicast Routing
debug ip pim
debug ip pim
To display PIM packets received and transmitted, as well as PIM related events, use the debug ip pim command
in privileged EXEC mode. To disable the debug output, use the no form of the command.
debug ip pim [{vrf vrf-name}][{ip-address | atm | auto-rp | bfd | bsr | crimson | df rp-address | drlb
| hello | timers}]
no debug ip pim [{vrf vrf-name}][{ip-address | atm | auto-rp | bfd | bsr | crimson | df rp-address | drlb
| hello | timers}]
Syntax Description
Syntax Description
vrf vrf-name (Optional) Specifies the VPN Routing and Forwarding
instance.
This keyword overrides debugging of any VRFs
specified in the debug condition vrf vrf-name
command.
ip-address (Optional) Specifies the IP group address.
atm (Optional) Displays debugging information about PIM
ATM signalling activity.
auto-rp (Optional) Displays debugging information about
Auto-RP information.
bfd (Optional) Displays debugging information about
BFD configuration.
bsr (Optional) Displays debugging information about PIM
Candidate-RP and BSR activity.
crimson (Optional) Displays debugging information about
Crimson database activity.
df rp-address (Optional) Displays debugging information about PIM
RP designated forwarder election activity.
drlb (Optional) Displays debugging information about PIM
designated router load-balancing activity.
hello (Optional) Displays debugging information about PIM
Hello packets received and sent.
timers (Optional) Displays debugging information about PIM
timer events.
Command Modes Privileged EXEC mode (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
768
IP Multicast Routing
debug ip pim
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines
Caution Because debugging output is assigned high priority in the CPU process, it can render the system unusable.
For this reason, use the debug commands only to troubleshoot specific problems or during troubleshooting
sessions with Cisco technical support staff. It is best to use the debug commands during periods of lower
network traffic and fewer users. Debugging during these periods decreases the likelihood that increased debug
command processing overhead will affect system use.
You can debug a maximum of 8 VRFs in a PIM at a time. To debug multiple VRFs at the same time, perform
the following sequence of steps:
debug condition vrf vrf-name1
debug condition vrf vrf-name2
.
.
.
debug condition vrf vrf-name8
debug ip pim
Example
The following example shows how to display the Crimson database activity:
Device# debug ip pim crimson
The following example shows how to debug the two VRFs red and green in a PIM at the same time:
Device# debug condition vrf red
Device# debug condition vrf green
Device# debug ip pim
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
769
IP Multicast Routing
debug ipv6 pim
debug ipv6 pim
To enable debugging on Protocol Independent Multicast (PIM) protocol activity, use the debug ipv6 pim
command in privileged EXEC mode. To restore the default value, use the no form of this command.
debug ipv6 pim
[{vrf vrf-name }]
[{bfd interface-type interface-number | bsr | crimson | df-election [{interface interface-type
interface-number | rp rp-address}] | drlb | group group-address | interface interface-type
interface-number | limit [{group-address }] | neighbor interface-type interface-number }]
no debug ipv6 pim
[{vrf vrf-name }]
[{bfd interface-type interface-number | bsr | crimson | df-election [{interface interface-type
interface-number | rp rp-address}] | drlb | group group-address | interface interface-type
interface-number | limit [{group-address }] | neighbor interface-type interface-number }]
Syntax Description
Syntax Description
vrf vrf-name (Optional) Specifies the VPN Routing and Forwarding
instance.
This keyword overrides debugging of any VRFs
specified in the debug condition vrf vrf-name
command.
bfd (Optional) Displays debugging information about
BFD configuration.
bsr (Optional) Displays debugging information about PIM
Candidate-RP and BSR sent and received.
crimson (Optional) Displays debugging information about
Crimson database activity.
df-election (Optional) Displays debugging information about PIM
designated forwarder election activity.
drlb (Optional) Displays debugging information about PIM
designated router load-balancing activity.
group group-address (Optional) Displays debugging information about
group-related activity.
interface (Optional) Displays debugging information about
protocol activity of the specified interface.
limit (Optional) Displays debugging information about
interface limits.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
770
IP Multicast Routing
debug ipv6 pim
Syntax Description
neighbor (Optional) Displays debugging information about PIM
Hello messages received and sent.
interface-type interface-number (Optional) Displays debugging information about the
specified interface.
rp rp-address (Optional) Displays debugging information about the
specified RP.
Command Modes Privileged EXEC mode (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines
Caution Because debugging output is assigned high priority in the CPU process, it can render the system unusable.
For this reason, use the debug commands only to troubleshoot specific problems or during troubleshooting
sessions with Cisco technical support staff. It is best to use the debug commands during periods of lower
network traffic and fewer users. Debugging during these periods decreases the likelihood that increased debug
command processing overhead will affect system use.
You can debug a maximum of 8 VRFs in a PIM at a time. To debug multiple VRFs at the same time, perform
the following sequence of steps:
debug condition vrf vrf-name1
debug condition vrf vrf-name2
.
.
.
debug condition vrf vrf-name8
debug ip pim
Example
The following example shows how to display the Crimson database activity:
Device# debug ipv6 pim crimson
The following example shows how to debug VRF red:
Device# debug vrf red ipv6 pim
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
771
IP Multicast Routing
ip igmp filter
ip igmp filter
To control whether or not all the hosts on a Layer 2 interface can join one or more IP multicast groups by
applying an Internet Group Management Protocol (IGMP) profile to the interface, use the ip igmp filter
interface configuration command on the stack or on a standalone . To remove the specified profile from the
interface, use the no form of this command.
ip igmp filter profile number
no ip igmp filter
Syntax Description profile number IGMP profile number to be applied. The range is 1—4294967295.
Command Default No IGMP filters are applied.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can apply IGMP filters only to Layer 2 physical interfaces; you cannot apply IGMP filters to routed ports,
switch virtual interfaces (SVIs), or ports that belong to an EtherChannel group.
An IGMP profile can be applied to one or more port interfaces, but one port can have only one profile applied
to it.
Example
This example shows how to configure IGMP profile 40 to permit the specified range of IP multicast
addresses, then shows how to apply that profile to a port as a filter:
(config)# ip igmp profile 40
(config-igmp-profile)# permit
(config-igmp-profile)# range 233.1.1.1 233.255.255.255
(config-igmp-profile)# exit
(config)# interface gigabitethernet1/0/2
(config-if)# switchport
*Jan 3 18:04:17.007: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/1, changed state to down.
NOTE: If this message appears, this interface changes to layer 2, so that you can apply the
filter.
(config-if)# ip igmp filter 40
You can verify your setting by using the show running-config command in privileged EXEC mode
and by specifying an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
772
IP Multicast Routing
ip igmp max-groups
ip igmp max-groups
To set the maximum number of Internet Group Management Protocol (IGMP) groups that a Layer 2 interface
can join or to configure the IGMP throttling action when the maximum number of entries is in the forwarding
table, use the ip igmp max-groups interface configuration command on the stack or on a standalone . To set
the maximum back to the default, which is to have no maximum limit, or to return to the default throttling
action, which is to drop the report, use the no form of this command.
ip igmp max-groups {max number | action { deny | replace}}
no ip igmp max-groups {max number | action}
Syntax Description max number Maximum number of IGMP groups that an interface can join. The range is 0—4294967294.
The default is no limit.
action deny Drops the next IGMP join report when the maximum number of entries is in the IGMP
snooping forwarding table. This is the default action.
action replace Replaces the existing group with the new group for which the IGMP report was received
when the maximum number of entries is in the IGMP snooping forwarding table.
Command Default The default maximum number of groups is no limit.
After the learns the maximum number of IGMP group entries on an interface, the default throttling action is
to drop the next IGMP report that the interface receives and to not add an entry for the IGMP group to the
interface.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can use this command only on Layer 2 physical interfaces and on logical EtherChannel interfaces. You
cannot set IGMP maximum groups for routed ports, switch virtual interfaces (SVIs), or ports that belong to
an EtherChannel group.
Follow these guidelines when configuring the IGMP throttling action:
• If you configure the throttling action as deny, and set the maximum group limit, the entries that were
previously in the forwarding table are not removed, but are aged out. After these entries are aged out,
when the maximum number of entries is in the forwarding table, the drops the next IGMP report received
on the interface.
• If you configure the throttling action as replace, and set the maximum group limitation, the entries that
were previously in the forwarding table are removed. When the maximum number of entries is in the
forwarding table, the replaces a randomly selected multicast entry with the received IGMP report.
• When the maximum group limitation is set to the default (no maximum), entering the ip igmp max-groups
{deny | replace} command has no effect.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
773
IP Multicast Routing
ip igmp max-groups
Example
The following example shows how to limit the number of IGMP groups that a port can join to 25:
(config)# interface gigabitethernet1/0/2
(config-if)# ip igmp max-groups 25
The following example shows how to configure the to replace the existing group with the new group
for which the IGMP report was received when the maximum number of entries is in the forwarding
table:
(config)# interface gigabitethernet2/0/1
(config-if)# ip igmp max-groups action replace
You can verify your setting by using the show running-config privileged EXEC command and by
specifying an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
774
IP Multicast Routing
ip igmp profile
ip igmp profile
To create an Internet Group Management Protocol (IGMP) profile and enter IGMP profile configuration
mode, use the ip igmp profile global configuration command on the stack or on a standalone . From this
mode, you can specify the configuration of the IGMP profile to be used for filtering IGMP membership reports
from a switch port. To delete the IGMP profile, use the no form of this command.
ip igmp profile profile number
no ip igmp profile profile number
Syntax Description profile number The IGMP profile number being configured. The range is from 1—4294967295.
Command Default No IGMP profiles are defined. When configured, the default action for matching an IGMP profile is to deny
matching addresses.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you are in IGMP profile configuration mode, you can create a profile by using these commands:
• deny—Specifies that matching addresses are denied; this is the default condition.
• exit—Exits from igmp-profile configuration mode.
• no—Negates a command or resets to its defaults.
• permit—Specifies that matching addresses are permitted.
• range—Specifies a range of IP addresses for the profile. This can be a single IP address or a range with
a start and an end address.
When entering a range, enter the low IP multicast address, a space, and the high IP multicast address.
You can apply an IGMP profile to one or more Layer 2 interfaces, but each interface can have only one profile
applied to it.
Example
The following example shows how to configure IGMP profile 40, which permits the specified range
of IP multicast addresses:
(config)# ip igmp profile 40
(config-igmp-profile)# permit
(config-igmp-profile)# range 233.1.1.1 233.255.255.255
You can verify your settings by using the show ip igmp profile command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
775
IP Multicast Routing
ip igmp snooping
ip igmp snooping
To globally enable Internet Group Management Protocol (IGMP) snooping on the or to enable it on a
per-VLAN basis, use the ip igmp snooping global configuration command on the stack or on a standalone
. To return to the default setting, use the no form of this command.
ip igmp snooping [vlan vlan-id]
no ip igmp snooping [vlan vlan-id]
Syntax Description vlan vlan-id (Optional) Enables IGMP snooping on the specified VLAN. Ranges are 1—1001 and
1006—4094.
Command Default IGMP snooping is globally enabled on the .
IGMP snooping is enabled on VLAN interfaces.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When IGMP snooping is enabled globally, it is enabled in all of the existing VLAN interfaces. When IGMP
snooping is globally disabled, it is disabled on all of the existing VLAN interfaces.
VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP
snooping.
Example
The following example shows how to globally enable IGMP snooping:
(config)# ip igmp snooping
The following example shows how to enable IGMP snooping on VLAN 1:
(config)# ip igmp snooping vlan 1
You can verify your settings by entering the show ip igmp snooping command in privileged EXEC
mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
776
IP Multicast Routing
ip igmp snooping last-member-query-count
ip igmp snooping last-member-query-count
To configure how often Internet Group Management Protocol (IGMP) snooping will send query messages in
response to receiving an IGMP leave message, use the ip igmp snooping last-member-query-count
command in global configuration mode. To set count to the default value, use the no form of this command.
ip igmp snooping [vlan vlan-id] last-member-query-count count
no ip igmp snooping [vlan vlan-id] last-member-query-count count
Syntax Description vlan vlan-id (Optional) Sets the count value on a specific VLAN ID. The range is from 1―1001. Do not
enter leading zeroes.
count Interval at which query messages are sent, in milliseconds. The range is from 1―7. The default
is 2.
Command Default A query is sent every 2 milliseconds.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When a multicast host leaves a group, the host sends an IGMP leave message. To check if this host is the last
to leave the group, IGMP query messages are sent when the leave message is seen until the
last-member-query-interval timeout period expires. If no response is received to the last-member queries
before the timeout period expires, the group record is deleted.
Use the ip igmp snooping last-member-query-interval command to configure the timeout period.
When both IGMP snooping immediate-leave processing and the query count are configured, immediate-leave
processing takes precedence.
Note Do not set the count to 1 because the loss of a single packet (the query packet from the to the host or the
report packet from the host to the ) may result in traffic forwarding being stopped even if the receiver is still
there. Traffic continues to be forwarded after the next general query is sent by the , but the interval during
which a receiver may not receive the query could be as long as 1 minute (with the default query interval).
The leave latency in Cisco IOS software may increase by up to 1 last-member query interval (LMQI) value
when the is processing more than one leave within an LMQI. In such a scenario, the average leave latency
is determined by the (count + 0.5) * LMQI. The result is that the default leave latency can range from 2.0 to
3.0 seconds with an average of 2.5 seconds under a higher load of IGMP leave processing. The leave latency
under load for the minimum LMQI value of 100 milliseconds and a count of 1 is from 100 to 200 milliseconds,
with an average of 150 milliseconds. This is done to limit the impact of higher rates of IGMP leave messages.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
777
IP Multicast Routing
ip igmp snooping last-member-query-count
Example
The following example shows how to set the last member query count to 5:
(config)# ip igmp snooping last-member-query-count 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
778
IP Multicast Routing
ip igmp snooping querier
ip igmp snooping querier
To globally enable the Internet Group Management Protocol (IGMP) querier function in Layer 2 networks,
use the ip igmp snooping querier global configuration command. Use the command with keywords to enable
and configure the IGMP querier feature on a VLAN interface. To return to the default settings, use the no
form of this command.
ip igmp snooping [vlan vlan-id] querier [address ip-address | max-response-time response-time
| query-interval interval-count | tcn query {count count | interval interval} | timer expiry
expiry-time | version version]
no ip igmp snooping [vlan vlan-id] querier [address | max-response-time | query-interval |
tcn query {count | interval} | timer expiry | version]
Syntax Description vlan vlan-id (Optional) Enables IGMP snooping and the IGMP querier function on the
specified VLAN. Ranges are 1—1001 and 1006—4094.
address ip-address (Optional) Specifies a source IP address. If you do not specify an IP
address, the querier tries to use the global IP address configured for the
IGMP querier.
max-response-time (Optional) Sets the maximum time to wait for an IGMP querier report.
response-time The range is 1—25 seconds.
query-interval interval-count (Optional) Sets the interval between IGMP queriers. The range is 1—18000
seconds.
tcn query (Optional) Sets parameters related to Topology Change Notifications
(TCNs).
count count Sets the number of TCN queries to be executed during the TCN interval
time. The range is 1—10.
interval interval Sets the TCN query interval time. The range is 1—255.
timer expiry expiry-time (Optional) Sets the length of time until the IGMP querier expires. The
range is 60—300 seconds.
version version (Optional) Selects the IGMP version number that the querier feature uses.
Select either 1 or 2.
Command Default The IGMP snooping querier feature is globally disabled on the .
When enabled, the IGMP snooping querier disables itself if it detects IGMP traffic from a multicast router.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
779
IP Multicast Routing
ip igmp snooping querier
Usage Guidelines Use this command to enable IGMP snooping to detect the IGMP version and IP address of a device that sends
IGMP query messages, which is also called a querier.
By default, the IGMP snooping querier is configured to detect devices that use IGMP Version 2 (IGMPv2),
but does not detect clients that are using IGMP Version 1 (IGMPv1). You can manually configure the
max-response-time value when devices use IGMPv2. You cannot configure the max-response-time when
devices use IGMPv1. (The value cannot be configured, and is set to zero).
Non-RFC-compliant devices running IGMPv1 might reject IGMP general query messages that have a non-zero
value as the max-response-time value. If you want the devices to accept the IGMP general query messages,
configure the IGMP snooping querier to run IGMPv1.
VLAN IDs 1002―1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP snooping.
Example
The following example shows how to globally enable the IGMP snooping querier feature:
(config)# ip igmp snooping querier
The following example shows how to set the IGMP snooping querier maximum response time to 25
seconds:
(config)# ip igmp snooping querier max-response-time 25
The following example shows how to set the IGMP snooping querier interval time to 60 seconds:
(config)# ip igmp snooping querier query-interval 60
The following example shows how to set the IGMP snooping querier TCN query count to 25:
(config)# ip igmp snooping querier tcn count 25
The following example shows how to set the IGMP snooping querier timeout value to 60 seconds:
(config)# ip igmp snooping querier timer expiry 60
The following example shows how to set the IGMP snooping querier feature to Version 2:
(config)# ip igmp snooping querier version 2
You can verify your settings by entering the show ip igmp snooping privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
780
IP Multicast Routing
ip igmp snooping report-suppression
ip igmp snooping report-suppression
To enable Internet Group Management Protocol (IGMP) report suppression, use the ip igmp snooping
report-suppression global configuration command on the stack or on a standalone . To disable IGMP report
suppression, and to forward all IGMP reports to multicast routers, use the no form of this command.
ip igmp snooping report-suppression
no ip igmp snooping report-suppression
Syntax Description This command has no arguments or keywords.
Command Default IGMP report suppression is enabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines IGMP report suppression is supported only when the multicast query has IGMPv1 and IGMPv2 reports. This
feature is not supported when the query includes IGMPv3 reports.
The uses IGMP report suppression to forward only one IGMP report per multicast router query to multicast
devices. When IGMP report suppression is enabled (the default), the sends the first IGMP report from all the
hosts for a group to all the multicast routers. The does not send the remaining IGMP reports for the group to
the multicast routers. This feature prevents duplicate reports from being sent to the multicast devices.
If the multicast router query includes requests only for IGMPv1 and IGMPv2 reports, the forwards only the
first IGMPv1 or IGMPv2 report from all the hosts for a group to all of the multicast routers. If the multicast
router query also includes requests for IGMPv3 reports, the forwards all IGMPv1, IGMPv2, and IGMPv3
reports for a group to the multicast devices.
If you disable IGMP report suppression by entering the no ip igmp snooping report-suppression command,
all IGMP reports are forwarded to all of the multicast routers.
Example
The following example shows how to disable report suppression:
(config)# no ip igmp snooping report-suppression
You can verify your settings by entering the show ip igmp snooping command in privileged EXEC
mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
781
IP Multicast Routing
ip igmp snooping vlan mrouter
ip igmp snooping vlan mrouter
To add a multicast router port, use the ip igmp snooping mrouter global configuration command on the
stack or on a standalone . To return to the default settings, use the no form of this command.
Command Default By default, there are no multicast router ports.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines VLAN IDs 1002―1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP snooping.
The configuration is saved in NVRAM.
Example
The following example shows how to configure a port as a multicast router port:
(config)# ip igmp snooping vlan 1 mrouter interface gigabitethernet1/0/2
You can verify your settings by entering the show ip igmp snooping privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
782
IP Multicast Routing
ip igmp snooping vlan static
ip igmp snooping vlan static
To enable Internet Group Management Protocol (IGMP) snooping and to statically add a Layer 2 port as a
member of a multicast group, use the ip igmp snooping vlan static global configuration command on the
stack or on a standalone . To remove the port specified as members of a static multicast group, use the no
form of this command.
ip igmp snooping vlan vlan-id static ip-address interface interface-id
no ip igmp snooping vlan vlan-id static ip-address interface interface-id
Syntax Description vlan-id Enables IGMP snooping on the specified VLAN. Ranges are 1—1001 and
1006—4094.
ip-address Adds a Layer 2 port as a member of a multicast group with the specified group IP
address.
interface interface-id Specifies the interface of the member port. The interface-id has these options:
• fastethernet interface number—A Fast Ethernet IEEE 802.3 interface.
• gigabitethernet interface number—A Gigabit Ethernet IEEE 802.3z interface.
• tengigabitethernet interface number—A 10-Gigabit Ethernet IEEE 802.3z
interface.
• port-channel interface number—A channel interface. The range is 0—128.
Command Default By default, no ports are statically configured as members of a multicast group.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP
snooping.
The configuration is saved in NVRAM.
Example
The following example shows how to statically configure a host on an interface:
(config)# ip igmp snooping vlan 1 static 224.2.4.12 interface
gigabitEthernet1/0/1
Configuring port gigabitethernet1/0/1 on group 224.2.4.12
You can verify your settings by entering the show ip igmp snooping command in privileged EXEC
mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
783
IP Multicast Routing
ip multicast auto-enable
ip multicast auto-enable
To support authentication, authorization, and accounting (AAA) enabling of IP multicast, use the ip multicast
auto-enable command. This command allows multicast routing to be enabled dynamically on dialup interfaces
using AAA attributes from a RADIUS server. To disable IP multicast for AAA, use the no form of this
command.
ip multicast auto-enable
no ip multicast auto-enable
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines None
Example
The following example shows how to enable AAA on IP multicast:
(config)# ip multicast auto-enable
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
784
IP Multicast Routing
ip multicast-routing
ip multicast-routing
To enable IP multicast routing, use the ip multicast-routing command in global configuration mode. To
disable IP multicast routing, use the no form of this command.
ip multicast-routing [vrf vrf-name]
no ip multicast-routing [vrf vrf-name]
Syntax Description vrf (Optional) Enables IP multicast routing for the Multicast VPN routing and forwarding (MVRF)
vrf-name instance specified for the vrf-name argument.
Command Default IP multicast routing is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines When IP multicast routing is disabled, the Cisco IOS XE software does not forward any multicast packets.
Note For IP multicast, after enabling IP multicast routing, PIM must be configured on all interfaces. Disabling IP
multicast routing does not remove PIM; PIM still must be explicitly removed from the interface configurations.
Examples The following example shows how to enable IP multicast routing:
Device> enable
Device# configure terminal
Device(config)# ip multicast-routing
The following example shows how to enable IP multicast routing on a specific VRF:
Device(config)# ip multicast-routing vrf vrf1
Related Commands Command Description
ip pim Enables PIM on an
interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
785
IP Multicast Routing
ip pim accept-register
ip pim accept-register
To configure a candidate rendezvous point (RP) switch to filter Protocol Independent Multicast (PIM) register
messages, use the ip pim accept-register command in global configuration mode. To disable this function,
use the no form of this command.
ip pim [vrf vrf-name ] accept-register {list access-list}
no ip pim [vrf vrf-name ] accept-register
Syntax Description vrf vrf-name (Optional) Configures a PIM register filter on candidate RPs for (S, G) traffic associated
with the multicast Virtual Private Network (VPN) routing and forwarding (MVRF) instance
specified for the vrf-name argument.
list access-list Specifies the access-list argument as a number or name that defines the (S, G) traffic in
PIM register messages to be permitted or denied. The range is 100—199 and the expanded
range is 2000—2699. An IP-named access list can also be used.
Command Default No PIM register filters are configured.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to prevent unauthorized sources from registering with the RP. If an unauthorized source
sends a register message to the RP, the RP will immediately send back a register-stop message.
The access list provided for the ip pim accept-register command should only filters IP source addresses and
IP destination addresses. Filtering on other fields (for example, IP protocol or UDP port number) will not be
effective and may cause undesired traffic to be forwarded from the RP down the shared tree to multicast group
members. If more complex filtering is required, use the ip multicast boundary command instead.
Example
The following example shows how to permit register packets for a source address sending to any
group range, with the exception of source address 172.16.10.1 sending to the SSM group range
(232.0.0.0/8). These are denied. These statements should be configured on all candidate RPs because
candidate RPs will receive PIM registers from first-hop routers or switches.
(config)# ip pim accept-register list ssm-range
(config)# ip access-list extended ssm-range
(config-ext-nacl)# deny ip any 232.0.0.0 0.255.255.255
(config-ext-nacl)# permit ip any any
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
786
IP Multicast Routing
ip pim bidir-enable
ip pim bidir-enable
To enable bidirectional Protocol Independent Multicast (bidirectional PIM), use the ip pim bidir-enable
command in global configuration mode. To disable bidirectional PIM, use the no form of this command.
ip pim bidir-enable
no ip pim bidir-enable
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Command Default The command is enabled.
Command Modes Global configuration (config)
Usage Guidelines When bidirectional PIM is disabled, the router will behave similarly to a router without bidirectional PIM
support. The following conditions will apply:
• PIM hello messages sent by the router will not contain the bidirectional mode option.
• The router will not send designated forwarder (DF) election messages and will ignore DF election
messages it receives.
• The ip pim rp-address, ip pim send-rp-announce, and ip pim rp-candidate global configuration
commands will be treated as follows:
• If these commands are configured when bidirectional PIM is disabled, bidirectional mode will not
be a configuration option.
• If these commands are configured with the bidirectional mode option when bidirectional PIM is
enabled and then bidirectional PIM is disabled, these commands will be removed from the
command-line interface (CLI). In this situation, these commands must be configured again with the
bidirectional mode option when bidirectional PIM is reenabled.
• The df keyword for the show ip pim interface user EXEC or privileged EXEC command and debug ip
pim privileged EXEC command is not supported.
The following example shows how to enable bidirectional PIM:
Device# enable
Device# configure terminal
Device(config)# ip pim bidir-enable
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
787
IP Multicast Routing
ip pim bsr-candidate
ip pim bsr-candidate
To configure the to be a candidate BSR, use the ip pim bsr-candidate command in global configuration
mode. To remove the switch as a candidate BSR, use the no form of this command.
ip pim [vrf vrf-name] bsr-candidate interface-id [hash-mask-length] [priority]
no ip pim [vrf vrf-name] bsr-candidate
Syntax Description vrf vrf-name (Optional) Configures the to be a candidate BSR for the Multicast Virtual Private
Network (MVPN) routing and forwarding (MVRF) instance specified for the vrf-name
argument.
interface-id ID of the interface on the from which the BSR address is derived to make it a candidate.
This interface must be enabled for Protocol Independent Multicast (PIM) using the ip
pim command. Valid interfaces include physical ports, port channels, and VLANs.
hash-mask-length (Optional) Length of a mask (32 bits maximum) that is to be ANDed with the group
address before the PIMv2 hash function is called. All groups with the same seed hash
correspond to the same rendezvous point ( RP). For example, if this value is 24, only
the first 24 bits of the group addresses matter. The hash mask length allows one RP to
be used for multiple groups. The default hash mask length is 0.
priority (Optional) Priority of the candidate BSR (C-BSR). The range is from 0 to 255. The
default priority is 0. The C-BSR with the highest priority value is preferred.
Command Default The is not configured to announce itself as a candidate BSR.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The interface specified for this command must be enabled for Protocol Independent Multicast (PIM) using
the ip pim command.
This command configures the to send BSR messages to all of its PIM neighbors, with the address of the
designated interface as the BSR address.
This command should be configured on backbone s that have good connectivity to all parts of the PIM domain.
The BSR mechanism is specified in RFC 2362. Candidate RP (C-RP) switches unicast C-RP advertisement
packets to the BSR. The BSR then aggregates these advertisements in BSR messages, which it regularly
multicasts with a TTL of 1 to the ALL-PIM-ROUTERS group address, 224.0.0.13. The multicasting of these
messages is handled by hop-by-hop RPF flooding; so, no pre-existing IP multicast routing setup is required
(unlike with AutoRP). In addition, the BSR does not preselect the designated RP for a particular group range
(unlike AutoRP); instead, each switch that receives BSR messages will elect RPs for group ranges based on
the information in the BSR messages.
Cisco always accept and process BSR messages. There is no command to disable this function.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
788
IP Multicast Routing
ip pim bsr-candidate
Cisco perform the following steps to determine which C-RP is used for a group:
• A long match lookup is performed on the group prefix that is announced by the BSR C-RPs.
• If more than one BSR-learned C-RP is found by the longest match lookup, the C-RP with the lowest
priority (configured with the ip pim rp-candidate command) is preferred.
• If more than one BSR-learned C-RP has the same priority, the BSR hash function is used to select the
RP for a group.
• If more than one BSR-learned C-RP returns the same hash value derived from the BSR hash function,
the BSR C-RP with the highest IP address is preferred.
Example
The following example shows how to configure the IP address of the on Gigabit Ethernet interface
1/0/0 to be a BSR C-RP with a hash mask length of 0 and a priority of 192:
(config)# ip pim bsr-candidate GigabitEthernet1/0/1 0 192
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
789
IP Multicast Routing
ip pim rp-address
ip pim rp-address
To statically configure the address of a Protocol Independent Multicast (PIM) rendezvous point (RP) for
multicast groups, use the ip pim rp-address command in global configuration mode. To remove an RP
address, use the no form of this command.
ip pim [vrf vrf-name]rp-address rp-address [access-list] [override ] [bidir]
no ip pim [vrf vrf-name]rp-address rp-address [access-list] [override ] [bidir]
Syntax Description vrf vrf-name (Optional) Specifies that the static group-to-RP
mapping be associated with the Multicast Virtual
Private Network (MVPN) routing and forwarding
(MVRF) instance specified for the vrf-name argument.
rp-address rp-address IP address of the RP to be used for the static
group-to-RP mapping. This is a unicast IP address in
four-part dotted-decimal notation.
access-list (Optional) Number or name of a standard access list
that defines the multicast groups to be statically
mapped to the RP.
Note If no access list is defined, the RP will
map to all multicast groups
override (Optional) Specifies that if dynamic and static
group-to-RP mappings are used together and there is
an RP address conflict, the RP address configured for
a static group-to-RP mapping will take precedence.
Note If the override keyword is not specified
and there is RP address conflict,
dynamic group-to-RP mappings will
take precedence over static group-to-RP
mappings.
bidir (Optional) Specifies that the static group-to-RP
mapping be applied to a bidirectional PIM RP.
If the command is configured without the bidir
keyword, the groups will operate in sparse mode.
Note The bidir keyword is available as an
optional keyword only if bidirectional
PIM has been enabled using the ip pim
bidir-enable command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
790
IP Multicast Routing
ip pim rp-address
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Command Default No PIM static group-to-RP mappings are configured.
Command Modes Global configuration (config)
Usage Guidelines Under PIM, multicast groups in sparse mode (PIM-SM) or bidirectional mode (bidirectional PIM) use RPs
to connect sources and receivers. All routers in a PIM domain need to have a consistent configuration for the
mode and RP addresses of the multicast groups.
The Cisco IOS software learns the mode and RP addresses of multicast groups through the following three
mechanisms: static group-to-RP mapping configurations, Auto-RP, and bootstrap router (BSR).
Use the ip pim rp-address command to statically define the RP address for PIM-SM or bidirectional PIM
groups (an ip pim rp-address command configuration is referred to as a static group-to-RP mapping).
You can configure a single RP for more than one group using an access list. If no access list is specified, the
static RP will map to all multicast groups.
You can configure multiple RPs, but only one RP per group range.
If multiple ip pim rp-address commands are configured, the following rules apply:
• Highest RP IP address selected regardless of reachability: If a multicast group is matched by the access
list of more than one configured ip pim rp-address command, then the RP for the group is determined
by the RP with the highest RP address configured.
• One RP address per command: If multiple ip pim rp-address commands are configured, each static
group-to-RP mapping must be configured with a unique RP address (if not, it will be overwritten).This
restriction also means that only one RP address can be used to provide RP functions for either sparse
mode or bidirectional mode groups. If you want to configure static group-to-RP mappings for both
bidirectional and sparse mode, the RP addresses must be unique for each mode.
• One access list per command: If multiple ip pim rp-address commands are configured, only one access
list can be configured per static group-to-RP mapping. An access list cannot be reused with other static
group-to-RP mappings configured on a router.
If dynamic and static group-to-RP mappings are used together, the following rule applies to a multicast group:
Dynamic group-to-RP mappings take precedence over static group-to-RP mappings--unless the override
keyword is used.
The following example shows how to set the bidirectional PIM RP address to 172.16.0.2 for the
multicast range 239/8:
Device(config)# access list 10 239.0.0.0 0.255.255.255
Device(config)# ip pim rp-address 172.16.0.2 10 bidir
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
791
IP Multicast Routing
ip pim rp-candidate
ip pim rp-candidate
To configure the to advertise itself to the BSR as a Protocol Independent Multicast (PIM) Version 2 (PIMv2)
candidate rendezvous point (C-RP), use the ip pim rp-candidate command in global configuration mode.
To remove the as a C-RP, use the no form of this command.
ip pim [vrf vrf-name] rp-candidate interface-id [group-list access-list-number]
no ip pim [vrf vrf-name] rp-candidate interface-id [group-list access-list-number]
Syntax Description vrf vrf-name (Optional) Configures the switch to advertise itself to the BSR as PIMv2 C-RP
for the Multicast Virtual Private Network (MVPN) routing and forwarding
(MVRF) instance specified for the vrf-name argument.
interface-id ID of the interface whose associated IP address is advertised as a candidate RP
address. Valid interfaces include physical ports, port channels, and VLANs.
group-list (Optional) Specifies the standard IP access list number that defines the group
access-list-number prefixes that are advertised in association with the RP address.
Command Default The is not configured to announce itself to the BSR as a PIMv2 C-RP.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to configure the to send PIMv2 messages so that it advertises itself as a candidate RP to
the BSR.
This command should be configured on backbone s that have good connectivity to all parts of the PIM domain.
The IP address associated with the interface specified by interface-id will be advertised as the C-RP address.
The interface specified for this command must be enabled for Protocol Independent Multicast (PIM) using
the ip pim command.
If the optional group-list keyword and access-list-number argument are configured, the group prefixes defined
by the standard IP access list will also be advertised in association with the RP address.
Example
The following example shows how to configure the switch to advertise itself as a C-RP to the BSR
in its PIM domain. The standard access list number 4 specifies the group prefix associated with the
RP that has the address identified by Gigabit Ethernet interface 1/0/1.
(config)# ip pim rp-candidate GigabitEthernet1/0/1 group-list 4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
792
IP Multicast Routing
ip pim send-rp-announce
ip pim send-rp-announce
To use Auto-RP to configure groups for which the device will act as a rendezvous point (RP), use the ip pim
send-rp-announce command in global configuration mode. To unconfigure the device as an RP, use the no
form of this command.
ip pim [vrf vrf-name] send-rp-announce interface-id scope ttl-value [group-list access-list-number]
[interval seconds][bidir]
no ip pim [vrf vrf-name] send-rp-announce interface-id
Syntax Description vrf vrf-name (Optional) Uses Auto-RP to configure groups for which the device will act as a
rendezvous point (RP) for the vrf-name argument.
interface-id Enter the interface ID of the interface that identifies the RP address. Valid interfaces
include physical ports, port channels, and VLANs.
scope ttl-value Specifies the time-to-live (TTL) value in hops that limits the number of Auto-RP
announcements. Enter a hop count that is high enough to ensure that the RP-announce
messages reach all the mapping agents in the network. There is no default setting.
The range is 1—255.
group-list (Optional) Specifies the standard IP access list number that defines the group prefixes
access-list-number that are advertised in association with the RP address. Enter an IP standard access
list number from 1—99. If no access list is configured, the RP is used for all groups.
interval seconds (Optional) Specifies the interval between RP announcements, in seconds. The total
hold time of the RP announcements is automatically set to three times the value of
the interval. The default interval is 60 seconds. The range is 1—16383.
bidir (Optional) Indicates that the multicast groups specified by the access-listargument
are to operate in bidirectional mode. If the command is configured without this
keyword, the groups specified will operate in Protocol Independent Multicast sparse
mode (PIM-SM).
Command Default Auto-RP is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.12.1 This command was modified. The
bidir keyword was added.
Usage Guidelines Enter this command on the device that you want to be an RP. When you are using Auto-RP to distribute
group-to-RP mappings, this command causes the router to send an Auto-RP announcement message to the
well-known group CISCO-RP-ANNOUNCE (224.0.1.39). This message announces the router as a candidate
RP for the groups in the range described by the access list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
793
IP Multicast Routing
ip pim send-rp-announce
Use this command with the bidir keyword when you want bidirectional forwarding and you are using Auto-RP
to distribute group-to-RP mappings. Other options are as follows:
• If you are using the PIM Version 2 bootstrap router (PIMv2 BSR) mechanism to distribute group-to-RP
mappings, use the bidir keyword with the ip pim rp-candidate command.
• If you are not distributing group-to-RP mappings using either Auto-RP or the PIMv2 BSR mechanism,
use the bidir keyword with the ip pim rp-address command.
Example
The following example shows how to configure the device to send RP announcements out all Protocol
Independent Multicast (PIM)-enabled interfaces for a maximum of 31 hops. The IP address by which
the switch wants to be identified as RP is the IP address associated with Gigabit Ethernet interface
1/0/1 at an interval of 120 seconds:
Device(config)# ip pim send-rp-announce GigabitEthernet1/0/1 scope 31 group-list 5 interval
120
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
794
IP Multicast Routing
ip pim spt-threshold
ip pim spt-threshold
To specify the threshold that must be reached before moving to shortest-path tree (spt), use the ip pim
spt-threshold command in global configuration mode. To remove the threshold, use the no form of this
command.
ip pim {kbps | infinity} [group-list access-list]
no ip pim {kbps | infinity} [group-list access-list]
Syntax Description kbps Threshold that must be reached before moving to shortest-path tree (spt). 0 is the
only valid entry even though the range is 0 to 4294967. A 0 entry always switches
to the source-tree.
infinity Specifies that all the sources for the specified group use the shared tree, never
switching to the source tree.
group-list access-list (Optional) Specifies an access list number or a specific access list that you have
created by name. If the value is 0 or if the group-list access-list option is not used,
the threshold applies to all the groups.
Command Default Switches to the PIM shortest-path tree (spt).
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following example shows how to make all the sources for access list 16 use the shared tree:
(config)# ip pim spt-threshold infinity group-list 16
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
795
IP Multicast Routing
match message-type
match message-type
To set a message type to match a service list, use the match message-type command.
match message-type {announcement | any | query}
Syntax Description announcement Allows only service advertisements or announcements for the .
any Allows any match type.
query Allows only a query from the client for a certain in the network.
Command Default None
Command Modes Service list configuration.
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Multiple service maps of the same name with different sequence numbers can be created, and the evaluation
of the filters will be ordered on the sequence number. Service lists are an ordered sequence of individual
statements, with each one having a permit or deny result. The evaluation of a service list consists of a list scan
in a predetermined order, and an evaluation of the criteria of each statement that matches. A list scan is stopped
once the first statement match is found and a permit/deny action associated with the statement match is
performed. The default action after scanning through the entire list is to deny.
Note It is not possible to use the match command if you have used the service-list mdns-sd service-list-name
query command. The match command can be used only for the permit or deny option.
Example
The following example shows how to set the announcement message type to be matched:
(config-mdns-sd-sl)# match message-type announcement
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
796
IP Multicast Routing
match service-type
match service-type
To set the value of the mDNS service type string to match, use the match service-type command.
match service-type line
Syntax Description line Regular expression to match the service type in packets.
Command Default None
Command Modes Service list configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines It is not possible to use the match command if you have used the service-list mdns-sd service-list-name
query command. The match command can be used only for the permit or deny option.
Example
The following example shows how to set the value of the mDNS service type string to match:
(config-mdns-sd-sl)# match service-type _ipp._tcp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
797
IP Multicast Routing
match service-instance
match service-instance
To set a service instance to match a service list, use the match service-instance command.
match service-instance line
Syntax Description line Regular expression to match the service instance in packets.
Command Default None
Command Modes Service list configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines It is not possible to use the match command if you have used the service-list mdns-sd service-list-name
query command. The match command can be used only for the permit or deny option.
Example
The following example shows how to set the service instance to match:
(config-mdns-sd-sl)# match service-instance servInst 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
798
IP Multicast Routing
mrinfo
mrinfo
To query which neighboring multicast routers or multilayer switches are acting as peers, use the mrinfo
command in user EXEC or privileged EXEC mode.
mrinfo [vrf route-name] [hostname | address][interface-id]
Syntax Description vrf route-name (Optional) Specifies the VPN routing or forwarding instance.
hostname | address (Optional) Domain Name System (DNS) name or IP address of the multicast router
or multilayer switch to query. If omitted, the switch queries itself.
interface-id (Optional) Interface ID.
Command Default The command is disabled.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The mrinfo command is the original tool of the multicast backbone (MBONE) to determine which neighboring
multicast routers or switches are peering with multicast routers or switches. Cisco routers supports mrinfo
requests from Cisco IOS Release 10.2.
You can query a multicast router or multilayer switch using the mrinfo command. The output format is
identical to the multicast routed version of the Distance Vector Multicast Routing Protocol (DVMRP). (The
mrouted software is the UNIX software that implements DVMRP.)
Example
The following is the sample output from the mrinfo command:
# mrinfo
vrf 192.0.1.0
192.31.7.37 (barrnet-gw.cisco.com) [version cisco 11.1] [flags: PMSA]:
192.31.7.37 -> 192.31.7.34 (sj-wall-2.cisco.com) [1/0/pim]
192.31.7.37 -> 192.31.7.47 (dirtylab-gw-2.cisco.com) [1/0/pim]
192.31.7.37 -> 192.31.7.44 (dirtylab-gw-1.cisco.com) [1/0/pim]
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
799
IP Multicast Routing
mrinfo
Note The flags indicate the following:
• P: prune-capable
• M: mtrace-capable
• S: Simple Network Management Protocol-capable
• A: Auto RP capable
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
800
IP Multicast Routing
service-policy-query
service-policy-query
To configure the service-list query periodicity, use the service-policy-query command. To delete the
configuration, use the no form of this command.
service-policy-query [service-list-query-name service-list-query-periodicity]
no service-policy-query
Syntax Description service-list-query-name service-list-query-periodicity (Optional) Service-list query periodicity.
Command Default Disabled.
Command Modes mDNS configuration
Command History Release Modification
Cisco IOS XE Everest This command was
16.5.1a introduced.
Usage Guidelines Since there are devices that do not send unsolicited announcements and to force such devices the learning of
services and to keep them refreshed in the cache, this command contains an active query feature that ensures
that the services listed in the active query list are queried.
Example
This example shows how to configure service list query periodicity:
(config-mdns)# service-policy-query sl-query1 100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
801
IP Multicast Routing
service-policy
service-policy
To apply a filter on incoming or outgoing service-discovery information on a service list, use the service-policy
command. To remove the filter, use the no form of this command.
service-policy service-policy-name {IN | OUT}
no service-policy service-policy-name {IN | OUT}
Syntax Description IN Applies a filter on incoming service-discovery information.
OUT Applies a filter on outgoing service-discovery information.
Command Default Disabled.
Command Modes mDNS configuration
Command History Release Modification
Cisco IOS XE Everest This command was
16.5.1a introduced.
Example
The following example shows how to apply a filter on incoming service-discovery information on
a service list:
(config-mdns)# service-policy serv-pol1 IN
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
802
IP Multicast Routing
show ip igmp filter
show ip igmp filter
To display Internet Group Management Protocol (IGMP) filter information, use the show ip igmp filter
command in privileged EXEC mode.
show ip igmp [vrf vrf-name] filter
Syntax Description vrf vrf-name (Optional) Supports the multicast VPN routing and forwarding (VRF) instance.
Command Default IGMP filters are enabled by default.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show ip igmp filter command displays information about all filters defined on the .
Example
The following example shows the sample output from the show ip igmp filter command:
# show ip igmp filter
IGMP filter enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
803
IP Multicast Routing
show ip igmp profile
show ip igmp profile
To display all the configured Internet Group Management Protocol (IGMP) profiles or a specified IGMP
profile, use the show ip igmp profile command in privileged EXEC mode.
show ip igmp [vrf vrf-name] profile [profile number]
Syntax Description vrf vrf-name (Optional) Supports the multicast VPN routing and forwarding (VRF) instance.
profile number (Optional) IGMP profile number to be displayed. The range is 1 to 4294967295. If no
profile number is entered, all the IGMP profiles are displayed.
Command Default IGMP profiles are undefined by default.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines None
Examples
The following example shows the output of the show ip igmp profile command for profile number
40 on the :
# show ip igmp profile 40
IGMP Profile 40
permit
range 233.1.1.1 233.255.255.255
The following example shows the output of the show ip igmp profile command for all the profiles
configured on the :
# show ip igmp profile
IGMP Profile 3
range 230.9.9.0 230.9.9.0
IGMP Profile 4
permit
range 229.9.9.0 229.255.255.255
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
804
IP Multicast Routing
show ip igmp snooping
show ip igmp snooping
To display the Internet Group Management Protocol (IGMP) snooping configuration of the or the VLAN,
use the show ip igmp snooping command in user EXEC or privileged EXEC mode.
show ip igmp snooping [groups | mrouter | querier] [vlan vlan-id] [detail]
Syntax Description groups (Optional) Displays the IGMP snooping multicast table.
mrouter (Optional) Displays the IGMP snooping multicast router ports.
querier (Optional) Displays the configuration and operation information for the IGMP querier.
vlan vlan-id (Optional) Specifies a VLAN; the range is 1 to 1001 and 1006 to 4094.
detail (Optional) Displays operational state information.
Command Default None
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines VLAN IDs 1002―1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP snooping.
Expressions are case sensitive. For example, if you enter | exclude output, the lines that contain "output" do
not appear, but the lines that contain "Output" appear.
Examples
The following is a sample output from the show ip igmp snooping vlan 1 command. It shows
snooping characteristics for a specific VLAN:
# show ip igmp snooping vlan 1
Global IGMP Snooping configuration:
-------------------------------------------
IGMP snooping : Enabled
IGMPv3 snooping (minimal) : Enabled
Report suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Robustness variable : 2
Last member query count : 2
Last member query interval : 1000
Vlan 1:
--------
IGMP snooping : Enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
805
IP Multicast Routing
show ip igmp snooping
IGMPv2 immediate leave : Disabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Robustness variable : 2
Last member query count : 2
Last member query interval : 1000
The following is a sample output from the show ip igmp snooping command. It displays snooping
characteristics for all the VLANs on the :
# show ip igmp snooping
Global IGMP Snooping configuration:
-------------------------------------------
IGMP snooping : Enabled
IGMPv3 snooping (minimal) : Enabled
Report suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Robustness variable : 2
Last member query count : 2
Last member query interval : 1000
Vlan 1:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Robustness variable : 2
Last member query count : 2
Last member query interval : 1000
Vlan 2:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Robustness variable : 2
Last member query count : 2
Last member query interval : 1000
-
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
806
IP Multicast Routing
show ip igmp snooping groups
show ip igmp snooping groups
To display the Internet Group Management Protocol (IGMP) snooping multicast table for the or the multicast
information, use the show ip igmp snooping groups command in privileged EXEC mode.
show ip igmp snooping groups [vlan vlan-id ] [[count] | ip_address]
Syntax Description vlan vlan-id (Optional) Specifies a VLAN; the range is 1 to 1001 and 1006 to 4094. Use this option to
display the multicast table for a specified multicast VLAN or specific multicast information.
count (Optional) Displays the total number of entries for the specified command options instead of
the actual entries.
ip_address (Optional) Characteristics of the multicast group with the specified group IP address.
Command Modes Privileged EXEC
User EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Expressions are case sensitive. For example, if you enter | exclude output, the lines that contain "output" do
not appear, but the lines that contain "Output" appear.
Examples
The following is a sample output from the show ip igmp snooping groups command without any
keywords. It displays the multicast table for the .
# show ip igmp snooping groups
Vlan Group Type Version Port List
-------------------------------------------------------------
1 224.1.4.4 igmp Gi1/0/11
1 224.1.4.5 igmp Gi1/0/11
2 224.0.1.40 igmp v2 Gi1/0/15
104 224.1.4.2 igmp v2 Gi2/0/1, Gi2/0/2
104 224.1.4.3 igmp v2 Gi2/0/1, Gi2/0/2
The following is a sample output from the show ip igmp snooping groups count command. It
displays the total number of multicast groups on the .
# show ip igmp snooping groups count
Total number of multicast groups: 2
The following is a sample output from the show ip igmp snooping groups vlan vlan-id ip-address
command. It shows the entries for the group with the specified IP address:
# show ip igmp snooping groups vlan 104 224.1.4.2
Vlan Group Type Version Port List
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
807
IP Multicast Routing
show ip igmp snooping groups
-------------------------------------------------------------
104 224.1.4.2 igmp v2 Gi2/0/1, Gi1/0/15
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
808
IP Multicast Routing
show ip igmp snooping mrouter
show ip igmp snooping mrouter
To display the Internet Group Management Protocol (IGMP) snooping dynamically learned and manually
configured multicast router ports for the or for the specified multicast VLAN, use the show ip igmp snooping
mrouter command in privileged EXEC mode.
show ip igmp snooping mrouter [vlan vlan-id]
Syntax Description vlan vlan-id (Optional) Specifies a VLAN; Ranges are from 1―1001 and 1006―4094.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines VLAN IDs 1002―1005 are reserved for Token Ring and FDDI VLANs, and cannot be used in IGMP snooping.
When multicast VLAN registration (MVR) is enabled, the show ip igmp snooping mrouter command displays
MVR multicast router information and IGMP snooping information.
Expressions are case sensitive, for example, if you enter | exclude output, the lines that contain "output" do
not appear, but the lines that contain "Output" appear.
Example
The following is a sample output from the show ip igmp snooping mrouter command. It shows
how to display multicast router ports on the :
# show ip igmp snooping mrouter
Vlan ports
---- -----
1 Gi2/0/1(dynamic)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
809
IP Multicast Routing
show ip igmp snooping querier
show ip igmp snooping querier
To display the configuration and operation information for the IGMP querier that is configured on a , use the
show ip igmp snooping queriercommand in user EXEC mode.
show ip igmp snooping querier [vlan vlan-id] [detail ]
Syntax Description vlan vlan-id (Optional) Specifies a VLAN; Ranges are from 1―1001 and 1006―4094.
detail (Optional) Displays detailed IGMP querier information.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show ip igmp snooping querier command to display the IGMP version and the IP address of a
detected device, also called a querier, that sends IGMP query messages. A subnet can have multiple multicast
routers but only one IGMP querier. In a subnet running IGMPv2, one of the multicast routers is elected as
the querier. The querier can be a Layer 3 .
The show ip igmp snooping querier command output also shows the VLAN and the interface on which the
querier was detected. If the querier is the , the output shows the Port field as Router. If the querier is a router,
the output shows the port number on which the querier was detected in the Port field.
The show ip igmp snooping querier detail user EXEC command is similar to the show ip igmp snooping
querier command. However, the show ip igmp snooping querier command displays only the device IP
address most recently detected by the querier.
The show ip igmp snooping querier detail command displays the device IP address most recently detected
by the querier and this additional information:
• The elected IGMP querier in the VLAN
• The configuration and operational information pertaining to the querier (if any) that is configured in the
VLAN
Expressions are case sensitive, for example, if you enter | exclude output, the lines that contain "output" do
not appear, but the lines that contain "Output" appear.
Examples
The following is a sample output from the show ip igmp snooping querier command:
> show ip igmp snooping querier
Vlan IP Address IGMP Version Port
---------------------------------------------------
1 172.20.50.11 v3 Gi1/0/1
2 172.20.40.20 v2 Router
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
810
IP Multicast Routing
show ip igmp snooping querier
The following is a sample output from the show ip igmp snooping querier detail command:
> show ip igmp snooping querier detail
Vlan IP Address IGMP Version Port
-------------------------------------------------------------
1 1.1.1.1 v2 Fa8/0/1
Global IGMP querier status
--------------------------------------------------------
admin state : Enabled
admin version : 2
source IP address : 0.0.0.0
query-interval (sec) : 60
max-response-time (sec) : 10
querier-timeout (sec) : 120
tcn query count : 2
tcn query interval (sec) : 10
Vlan 1: IGMP querier status
--------------------------------------------------------
elected querier is 1.1.1.1 on port Fa8/0/1
--------------------------------------------------------
admin state : Enabled
admin version : 2
source IP address : 10.1.1.65
query-interval (sec) : 60
max-response-time (sec) : 10
querier-timeout (sec) : 120
tcn query count : 2
tcn query interval (sec) : 10
operational state : Non-Querier
operational version : 2
tcn query pending count : 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
811
IP Multicast Routing
show ip mroute
show ip mroute
To display the contents of the multicast routing (mroute) table, use the show ip mroute command in user
EXEC or privileged EXEC mode.
show ip mroute [ vrf { vrf-name | * } ] [{ [{ active [kbps] [ interface type number ] |
bidirectional | count [terse] | dense | interface type number | proxy | pruned | sparse | ssm |
static | summary }] | [ group-address [source-address] ] [{ count [terse] | interface type number
| proxy | pruned | summary }] | [ source-address group-address ] [{ count [terse] | interface
type number | proxy | pruned | summary }] | [group-address] active [kbps] [{ interface type
number | verbose }] }]
Syntax Description vrf vrf-name (Optional) Filters the output to display only the contents of the mroute table that
pertain to the Multicast Virtual Private Network (MVPN) routing and forwarding
(MVRF) instance specified for the vrf-name argument.
vrf * (Optional) Specifies all VRF instances.
active kbps (Optional) Displays the rate that active sources are sending to multicast groups,
in kilobits per second (kbps). Active sources are those sending at the kbps value
or higher. The range is from 1 to 4294967295. The kbps default is 4 kbps.
interface type number (Optional) Filters the output to display only mroute table information related to
the interface specified for the type number arguments.
bidirectional (Optional) Filters the output to display only information about bidirectional routes
in the mroute table.
count (Optional) Displays statistics about the group and source, including number of
packets, packets per second, average packet size, and bytes per second.
terse (Optional) Filters the output to display a subset of mroute statistics, excluding
source and group statistics for each mroute entry in the mroute table.
dense (Optional) Filters the output to display only information about dense mode routes
in the mroute table.
proxy (Optional) Displays information about Reverse Path Forwarding (RPF) vector
proxies received on a multicast device.
pruned (Optional) Filters the output to display only information about pruned routes in
the mroute table.
sparse (Optional) Filters the output to display only information about sparse mode routes
in the mroute table.
ssm (Optional) Filters the output to display only the Source Specific Multicast (SSM)
routes in the mroute table.
static (Optional) Filters the output to display only the static routes in the mroute table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
812
IP Multicast Routing
show ip mroute
summary (Optional) Filters the output to display a one-line, abbreviated summary of each
entry in the mroute table.
group-address (Optional) IP address or Domain Name System (DNS) name of a multicast group.
source-address (Optional) IP address or DNS name of a multicast source.
verbose (Optional) Displays additional information.
Command Default The show ip mroute command displays all entries in the mroute table.
Command Modes User EXEC (>) Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information related to all VRF
instances.
Usage Guidelines Use the show ip mroute command to display information about mroute entries in the mroute table. The
asterisk (*) refers to all source addresses. In this case, using asterisk will display the information of all the
VRFs related to multicast routing tables.
Example
The following example shows the sample output from the show ip mroute command:
Device# show ip mroute
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, B - Bidir Group, s - SSM Group, C - Connected,
L - Local, P - Pruned, R - RP-bit set, F - Register flag,
T - SPT-bit set, J - Join SPT, M - MSDP created entry,
X - Proxy Join Timer Running, A - Candidate for MSDP Advertisement,
U - URD, I - Received Source Specific Host Report, Z - Multicast Tunnel,
Y - Joined MDT-data group, y - Sending to MDT-data group
Timers: Uptime/Expires
Interface state: Interface, Next-Hop, State/Mode
(*, 224.0.255.3), uptime 5:29:15, RP is 192.168.37.2, flags: SC
Incoming interface: Tunnel0, RPF neighbor 10.3.35.1, Dvmrp
Outgoing interface list:
Ethernet0, Forward/Sparse, 5:29:15/0:02:57
(192.168.46.0/24, 224.0.255.3), uptime 5:29:15, expires 0:02:59, flags: C
Incoming interface: Tunnel0, RPF neighbor 10.3.35.1
Outgoing interface list:
Ethernet0, Forward/Sparse, 5:29:15/0:02:57
The following is sample output from the show ip mroute command with the IP multicast group
address 232.6.6.6 specified:
Device# show ip mroute 232.6.6.6
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, B - Bidir Group, s - SSM Group, C - Connected,
L - Local, P - Pruned, R - RP-bit set, F - Register flag,
T - SPT-bit set, J - Join SPT, M - MSDP created entry,
X - Proxy Join Timer Running, A - Candidate for MSDP Advertisement,
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
813
IP Multicast Routing
show ip mroute
U - URD, I - Received Source Specific Host Report, Z - Multicast Tunnel,
Y - Joined MDT-data group, y - Sending to MDT-data group
Outgoing interface flags:H - Hardware switched
Timers:Uptime/Expires
Interface state:Interface, Next-Hop or VCD, State/Mode
(*, 232.6.6.6), 00:01:20/00:02:59, RP 224.0.0.0, flags:sSJP
Incoming interface:Null, RPF nbr 224.0.0.0
Outgoing interface list:Null
(10.2.2.2, 232.6.6.6), 00:01:20/00:02:59, flags:CTI
Incoming interface:Ethernet3/3, RPF nbr 224.0.0.0
Outgoing interface list:
Ethernet3/1, Forward/Sparse-Dense, 00:00:36/00:02:35
The following example shows the sample output from the show ip mroute vrf * command:
Device# show ip mroute vrf *
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, B - Bidir Group, s - SSM Group, C - Connected,
L - Local, P - Pruned, R - RP-bit set, F - Register flag,
T - SPT-bit set, J - Join SPT, M - MSDP created entry, E - Extranet,
X - Proxy Join Timer Running, A - Candidate for MSDP Advertisement,
U - URD, I - Received Source Specific Host Report,
Z - Multicast Tunnel, z - MDT-data group sender,
Y - Joined MDT-data group, y - Sending to MDT-data group,
G - Received BGP C-Mroute, g - Sent BGP C-Mroute,
N - Received BGP Shared-Tree Prune, n - BGP C-Mroute suppressed,
Q - Received BGP S-A Route, q - Sent BGP S-A Route,
V - RD & Vector, v - Vector, p - PIM Joins on route,
x - VxLAN group, c - PFP-SA cache created entry,
* - determined by Assert, # - iif-starg configured on rpf intf,
e - encap-helper tunnel flag, l - LISP Decap Refcnt Contributor
Outgoing interface flags: H - Hardware switched, A - Assert winner, p - PIM Join
t - LISP transit group
Timers: Uptime/Expires
Interface state: Interface, Next-Hop or VCD, State/Mode
VRF IPv4 default
(100.99.99.99, 232.101.100.138), 1w1d/00:02:58, flags: sT
Incoming interface: Null0, RPF nbr 0.0.0.0
Outgoing interface list:
Ethernet0/1, Forward/Sparse, 1w1d/00:02:58, flags:
(100.99.99.99, 232.101.100.157), 1w1d/00:03:27, flags: sT
Incoming interface: Null0, RPF nbr 0.0.0.0
Outgoing interface list:
Ethernet0/1, Forward/Sparse, 1w1d/00:03:27, flags:
(100.88.88.88, 232.134.100.138), 1w1d/00:01:54, flags: sT
Incoming interface: Ethernet0/0, RPF nbr 40.10.2.1
Outgoing interface list:
Null0, Forward/Dense, 1w1d/stopped, flags:
(100.88.88.88, 232.134.100.157), 1w1d/00:01:54, flags: sT
Incoming interface: Ethernet0/0, RPF nbr 40.10.2.1
Outgoing interface list:
Null0, Forward/Dense, 1w1d/stopped, flags:
(*, 224.0.1.40), 1w1d/00:02:53, RP 0.0.0.0, flags: DP
Incoming interface: Null, RPF nbr 0.0.0.0
Outgoing interface list: Null
VRF red
(*, 225.64.64.1), 1w1d/00:03:23, RP 5.5.5.5, flags: Sl
Incoming interface: LISP0.101, RPF nbr 100.88.88.88
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
814
IP Multicast Routing
show ip mroute
Outgoing interface list:
LISP0.101, (100.99.99.99, 232.101.100.157), Forward/Sparse, 1w1d/stopped, flags:
(*, 225.32.32.32), 1w1d/00:03:05, RP 5.5.5.5, flags: Sl
Incoming interface: LISP0.101, RPF nbr 100.88.88.88
Outgoing interface list:
LISP0.101, (100.99.99.99, 232.101.100.138), Forward/Sparse, 1w1d/stopped, flags:
Table 118: show ip mroute Field Descriptions
Field Description
Flags: Provides information about the entry.
• D--Dense. Entry is operating in dense mode.
• S--Sparse. Entry is operating in sparse mode.
• B--Bidir Group. Indicates that a multicast group is operating in bidirectional
mode.
• s--SSM Group. Indicates that a multicast group is within the SSM range of IP
addresses. This flag is reset if the SSM range changes.
• C--Connected. A member of the multicast group is present on the directly
connected interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
815
IP Multicast Routing
show ip mroute
Field Description
Flags: (continued)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
816
IP Multicast Routing
show ip mroute
Field Description
• L--Local. The device itself is a member of the multicast group. Groups are
joined locally by the ip igmp join-group command (for the configured group),
the ip sap listen command (for the well-known session directory groups), and
rendezvous point (RP) mapping (for the well-known groups 224.0.1.39 and
224.0.1.40). Locally joined groups are not fast switched.
• P--Pruned. Route has been pruned. The Cisco IOS software keeps this
information so that a downstream member can join the source.
• R--RP-bit set. Indicates that the (S, G) entry is pointing toward the RP. This
flag typically indicates a prune state along the shared tree for a particular source.
• F--Register flag. Indicates that the software is registering for a multicast source.
• T--SPT-bit set. Indicates that packets have been received on the shortest path
source tree.
• J--Join SPT. For (*, G) entries, indicates that the rate of traffic flowing down
the shared tree is exceeding the SPT-Threshold set for the group. (The default
SPT-Threshold setting is 0 kbps.) When the J - Join shortest path tree (SPT)
flag is set, the next (S, G) packet received down the shared tree triggers an (S,
G) join in the direction of the source, thereby causing the device to join the
source tree.
For (S, G) entries, indicates that the entry was created because the SPT-Threshold
for the group was exceeded. When the J - Join SPT flag is set for (S, G) entries, the
device monitors the traffic rate on the source tree and attempts to switch back to the
shared tree for this source if the traffic rate on the source tree falls below the
SPT-Threshold of the group for more than 1 minute.
Note The device measures the traffic rate on the shared tree and compares
the measured rate to the SPT-Threshold of the group once every second.
If the traffic rate exceeds the SPT-Threshold, the J - Join SPT flag is
set on the (*, G) entry until the next measurement of the traffic rate.
The flag is cleared when the next packet arrives on the shared tree and
a new measurement interval is started. If the default SPT-Threshold
value of 0 kbps is used for the group, the J - Join SPT flag is always
set on (*, G) entries and is never cleared. When the default
SPT-Threshold value is used, the device immediately switches to the
shortest path source tree when traffic from a new source is received.
• M--MSDP created entry. Indicates that a (*, G) entry was learned through a
Multicast Source Discovery Protocol (MSDP) peer. This flag is applicable only
for an RP running MSDP.
• E--Extranet source mroute entry. Indicates that a (*, G) or (S, G) entry in the
VRF routing table is a source Multicast VRF (MVRF) entry and has extranet
receiver MVRF entries linked to it.
• X--Proxy Join Timer Running. Indicates that the proxy join timer is running.
This flag is set only for (S, G) entries of an RP or “turnaround” device. A
“turnaround” device is located at the intersection of a shared path (*, G) tree
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
817
IP Multicast Routing
show ip mroute
Field Description
and the shortest path from the source to the RP.
• A--Candidate for MSDP Advertisement. Indicates that an (S, G) entry was
advertised through an MSDP peer. This flag is applicable only for an RP running
MSDP.
• U--URD. Indicates that a URL Rendezvous Directory (URD) channel
subscription report was received for the (S, G) entry.
• I--Received Source Specific Host Report. Indicates that an (S, G) entry was
created by an (S, G) report. This (S, G) report could have been created by
Internet Group Management Protocol Version 3 (IGMPv3), URD, or IGMP
v3lite. This flag is set only on the designated device (DR).
• Z--Multicast Tunnel. Indicates that this entry is an IP multicast group that
belongs to the Multicast Distribution Tree (MDT) tunnel. All packets received
for this IP multicast state are sent to the MDT tunnel for decapsulation.
• Y--Joined MDT-data group. Indicates that the traffic was received through an
MDT tunnel that was set up specifically for this source and group. This flag is
set in Virtual Private Network (VPN) mroute tables only.
• y--Sending to MDT-data group. Indicates that the traffic was sent through an
MDT tunnel that was set up specifically for this source and group. This flag is
set in VPN mroute tables only.
Outgoing interface Provides information about the entry.
flags:
• H--Hardware switched. Indicates that a multicast Multilayer Switching (MMLS)
forwarding path has been established for this entry.
Timers:Uptime/Expires “Uptime” indicates per interface how long (in hours, minutes, and seconds) the entry
has been in the IP multicast routing table. “Expires” indicates per interface how long
(in hours, minutes, and seconds) until the entry will be removed from the IP multicast
routing table.
Interface state: Indicates the state of the incoming or outgoing interface.
• Interface. Indicates the type and number of the interface listed in the incoming
or outgoing interface list.
• Next-Hop or VCD. “Next-hop” specifies the IP address of the downstream
neighbor. “VCD” specifies the virtual circuit descriptor number. “VCD0” means
the group is using the static map virtual circuit.
• State/Mode. “State” indicates that packets will either be forwarded, pruned, or
null on the interface depending on whether there are restrictions due to access
lists or a time-to-live (TTL) threshold. “Mode” indicates whether the interface
is operating in dense, sparse, or sparse-dense mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
818
IP Multicast Routing
show ip mroute
Field Description
(*, 224.0.255.1) and Entry in the IP multicast routing table. The entry consists of the IP address of the
(192.168.37.100, source followed by the IP address of the multicast group. An asterisk (*) in place of
224.0.255.1) the source device indicates all sources.
Entries in the first format are referred to as (*, G) or “star comma G” entries. Entries
in the second format are referred to as (S, G) or “S comma G” entries. (*, G) entries
are used to build (S, G) entries.
RP Address of the RP device. For devices and access servers operating in sparse mode,
this address is always 224.0.0.0.
flags: Information about the entry.
Incoming interface: Expected interface for a multicast packet from the source. If the packet is not received
on this interface, it is discarded.
RPF neighbor or RPF IP address of the upstream device to the source. Tunneling indicates that this device
nbr is sending data to the RP encapsulated in register packets. The hexadecimal number
in parentheses indicates to which RP it is registering. Each bit indicates a different
RP if multiple RPs per group are used. If an asterisk (*) appears after the IP address
in this field, the RPF neighbor has been learned through an assert.
Outgoing interface list: Interfaces through which packets will be forwarded.
When the ip pim nbma-mode command is enabled on the interface, the IP address
of the Protocol Independent Multicast (PIM) neighbor is also displayed.
The Blocked keyword will be displayed in the output if the interface is blocked
(denied) by RSVP mulicast CAC.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
819
IP Multicast Routing
show ip pim autorp
show ip pim autorp
To display global information about auto-rp, use the show ip pim autorp command in privileged EXEC
mode.
show ip pim [ vrf { vrf-name | * }] autorp
vrf vrf-name (Optional) Specifies the multicast VPN routing and
forwarding (VRF) instance.
vrf * (Optional) Specifies all the VRFs instances.
Command Default Auto RP is enabled by default.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information
related to all VRF instances.
Usage Guidelines This command displays whether auto-rp is enabled or disabled. The asterisk (*) refers to all VRFs. In this
case, using asterisk will display the autorp information, for all applicable VRFs.
Example
The following command output shows that Auto RP is enabled:
# show ip pim autorp
AutoRP Information:
AutoRP is enabled.
RP Discovery packet MTU is 0.
224.0.1.40 is joined on GigabitEthernet1/0/1.
PIM AutoRP Statistics: Sent/Received
RP Announce: 0/0, RP Discovery: 0/0
The following example shows the sample output from the show ip pim vrf * autorp command:
Device#show ip pim vrf * autorp
VRF IPv4 default
AutoRP Information:
AutoRP is enabled.
RP Discovery packet MTU is 0.
224.0.1.40 is joined on Loopback0.
AutoRP groups over sparse mode interface is enabled
PIM AutoRP Statistics: Sent/Received
RP Announce: 453427/0, RP Discovery: 0/152194
VRF ENG
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
820
IP Multicast Routing
show ip pim autorp
AutoRP Information:
AutoRP is enabled.
RP Discovery packet MTU is 1500.
224.0.1.40 is joined on GigabitEthernet4.
AutoRP groups over sparse mode interface is enabled
PIM AutoRP Statistics: Sent/Received
RP Announce: 0/151143, RP Discovery: 151923/0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
821
IP Multicast Routing
show ip pim bsr-router
show ip pim bsr-router
To display information related to Protocol Independent Multicast (PIM) bootstrap router (BSR) protocol
processing, use the show ip pim bsr-router command in user EXEC or privileged EXEC mode.
show ip pim [ vrf { vrf-name | * }] bsr-router
vrf vrf-name (Optional) Specifies the multicast VPN routing and
forwarding (VRF) instance.
vrf * (Optional) Specifies all the VRFs instances.
Command Default None
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information
related to all VRF instances.
Usage Guidelines In addition to Auto RP, the BSR RP method can be configured. After the BSR RP method is configured, this
command displays the BSR router information. The asterisk (*) refers to all VRFs. In this case, using asterisk
will display the BSR router information, for all applicable VRFs.
The following is sample output from the show ip pim bsr-router command:
# show ip pim bsr-router
PIMv2 Bootstrap information
This system is the Bootstrap Router (BSR)
BSR address: 172.16.143.28
Uptime: 04:37:59, BSR Priority: 4, Hash mask length: 30
Next bootstrap message in 00:00:03 seconds
Next Cand_RP_advertisement in 00:00:03 seconds.
RP: 172.16.143.28(Ethernet0), Group acl: 6
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
822
IP Multicast Routing
show ip pim bsr
show ip pim bsr
To display information related to Protocol Independent Multicast (PIM) bootstrap router (BSR) protocol
processing, use the show ip pim bsr command in user EXEC or privileged EXEC mode.
show ip pim [ vrf { vrf-name | * }] bsr
vrf vrf-name (Optional) Specifies the multicast VPN routing and
forwarding (VRF) instance.
vrf * (Optional) Specifies all the VRFs instances.
Command Default None
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information
related to all VRF instances.
Usage Guidelines In addition to Auto RP, the BSR RP method can be configured. After the BSR RP method is configured, this
command displays the BSR router information. The asterisk (*) refers to all VRFs. In this case, using asterisk
will display the BSR protocol information, for all applicable VRFs.
The following is sample output from the show ip pim bsr command:
# show ip pim bsr
PIMv2 Bootstrap information
This system is the Bootstrap Router (BSR)
BSR address: 172.16.143.28
Uptime: 04:37:59, BSR Priority: 4, Hash mask length: 30
Next bootstrap message in 00:00:03 seconds
Next Cand_RP_advertisement in 00:00:03 seconds.
RP: 172.16.143.28(Ethernet0), Group acl: 6
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
823
IP Multicast Routing
show ip pim interface df
show ip pim interface df
To display information about the elected designated forwarder (DF) for each rendezvous point (RP) on an
interface configured for Bidirectional Protocol Independent Multicast (PIM), use the show ip pim interface
df command in user EXEC or privileged EXEC mode.
show ip pim [ vrf { vrf-name | * } ] interface [ interface-type | interface-name ] df [ rp-address
]
vrf vrf-name (Optional) Specifies the multicast VPN routing and
forwarding (VRF) instance.
vrf * (Optional) Specifies all the VRFs instances.
interface [interface-type| interface-name] Specifies the interface type or the interface number.
rp-address (Optional) Specifies the RP IP address.
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information
related to all VRF instances.
Command Default If no interface is specified, all interfaces are displayed. The asterisk (*) refers to all VRFs. In this case, using
asterisk will display information of the designated forwarder for each rendezvous point on an interface, for
all applicable VRFs.
Command Modes User EXEC (>)
Privileged EXEC (#)
The following is sample output from the show ip pim interface df command:
Device# show ip pim interface df
Interface RP DF Winner Metric Uptime
Ethernet3/3 10.10.0.2 10.4.0.2 0 00:03:49
10.10.0.3 10.4.0.3 0 00:01:49
10.10.0.5 10.4.0.4 409600 00:01:49
Ethernet3/4 10.10.0.2 10.5.0.2 0 00:03:49
10.10.0.3 10.5.0.2 409600 00:02:32
10.10.0.5 10.5.0.2 435200 00:02:16
Loopback0 10.10.0.2 10.10.0.2 0 00:03:49
10.10.0.3 10.10.0.2 409600 00:02:32
10.10.0.5 10.10.0.2 435200 00:02:16
The following is sample output from the show ip pim interface df command when an interface is
specified:
Device# show ip pim interface Ethernet3/3 df 10.10.0.3
Designated Forwarder election for Ethernet3/3, 10.4.0.2, RP 10.10.0.3
State Non-DF
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
824
IP Multicast Routing
show ip pim interface df
Offer count is 0
Current DF ip address 10.4.0.3
DF winner up time 00:02:33
Last winner metric preference 0
Last winner metric 0
The following table gives the output field descriptions for the show ip pim interface df command:
Field Description
RP IP address of the RP.
DF Winner IP address of the elected DF.
Metric Unicast routing metric to the RP announced by the
DF.
Uptime Length of time the RP has been up, in days and hours.
If less than 1 day, time is shown in
hours:minutes:seconds.
State Indicates whether the specified interface is an elected
DF.
Offer count is Number of PIM DF election offer messages that the
router has sent out the interface during the current
election interval.
Current DF IP address IP address of the current DF.
DF winner uptime Length of time the current DF has been up, in days
and hours. If less than 1 day, time is shown in
hours:minutes:seconds.
Last winner metric preference The preference value used for selecting the unicast
routing metric to the RP announced by the DF.
Last winner metric Unicast routing metric to the RP announced by the
DF.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
825
IP Multicast Routing
show ip pim rp
show ip pim rp
To display active rendezvous points ( RPs) that are cached with associated multicast routing entries, use the
show ip pim rp command in user EXEC or privileged EXEC mode.
show ip pim [ vrf { vrf-name | * } ] rp [ mapping [ elected | in-use ] | metric ] [ rp-address ]
Syntax Description vrf vrf-name (Optional) Specifies the multicast VPN routing and
forwarding (VRF) instance.
vrf * (Optional) Specifies all the VRFs instances.
mapping[ elected|in-use ] (Optional) Displays all group-to-RP mappings of
which the router is aware. (either configured or
learned from Auto-RP)
• elected- Displays elected Auto RPs.
• in-use- Displays learned RPs in-use.
metric (Optional) Displays the unicast routing metric to the
RPs configured statically or learned via Auto-RP or
the bootstrap router (BSR).
rp-address (Optional) Specifies the RP IP address.
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to display information
related to all VRF instances.
Command Default If no RP is specified, all active RPs are displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Usage Guidelines The Protocol Independent Multicast (PIM) version known for an RP influences the type of PIM register
messages (Version 1 or Version 2) that the router sends when acting as the designated router (DR) for an
active source. If an RP is statically configured, the PIM version of the RP is not set and the router, if required
to send register packets, tries to send PIM Version 2 register packets. If sending PIM Version 2 packets fails,
the router sends PIM Version 1 register packets.
The version of the RP displayed in the show ip pim rp command output can change according to the operations
of the router. When the group is created, the version shown is for the RP in the RP mapping cache. Later, the
version displayed by this command may change. If this router is acting as a DR for an active source, the router
sends PIM register messages. The PIM register messages are answered by the RP with PIM register stop
messages. The router learns from these PIM register stop messages the actual PIM version of the RP. Once
the actual PIM version of the RP is learned, this command displays only this version. If the router is not acting
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
826
IP Multicast Routing
show ip pim rp
as a DR for active sources on this group, then the version shown for the RP of the group does not change. In
this case, the PIM version of the RP is irrelevant to the router because the version of the RP influences only
the PIM register messages that this router must send.
When you enter the show ip pim rp mapping command, the version of the RP displayed in the output is
determined only by the method through which an RP is learned. If the RP is learned from Auto-RP then the
RP displayed is either “v1” or “v2, v1.” If the RP is learned from a static RP definition, the RP version is
undetermined and no RP version is displayed in the output. If the RP is learned from the BSR, the RP version
displayed is “v2.”
The asterisk (*) refers to all VRFs. In this case, using asterisk will display information related to active RPs
that are cached with associated multicast routing entries, for all applicable VRFs.
The following is sample output from the show ip pim rp command:
Device# show ip pim rp
Group:227.7.7.7, RP:10.10.0.2, v2, v1, next RP-reachable in 00:00:48
The following is sample output from the show ip pim rp command when the mapping keyword is
specified:
Device# show ip pim rp mapping
PIM Group-to-RP Mappings
This system is an RP (Auto-RP)
This system is an RP-mapping agent
Group(s) 227.0.0.0/8
RP 10.10.0.2 (?), v2v1, bidir
Info source:10.10.0.2 (?), via Auto-RP
Uptime:00:01:42, expires:00:00:32
Group(s) 228.0.0.0/8
RP 10.10.0.3 (?), v2v1, bidir
Info source:10.10.0.3 (?), via Auto-RP
Uptime:00:01:26, expires:00:00:34
Group(s) 229.0.0.0/8
RP 10.10.0.5 (mcast1.cisco.com), v2v1, bidir
Info source:10.10.0.5 (mcast1.cisco.com), via Auto-RP
Uptime:00:00:52, expires:00:00:37
Group(s) (-)230.0.0.0/8
RP 10.10.0.5 (mcast1.cisco.com), v2v1, bidir
Info source:10.10.0.5 (mcast1.cisco.com), via Auto-RP
Uptime:00:00:52, expires:00:00:37
The following is sample output from the show ip pim rp command when the metric keyword is
specified:
Device# show ip pim rp metric
RP Address Metric Pref Metric Flags RPF Type Interface
10.10.0.2 0 0 L unicast Loopback0
10.10.0.3 90 409600 L unicast Ethernet3/3
10.10.0.5 90 435200 L unicast Ethernet3/3
The following is sample output from the show ip pim vrf * rp mapping command:
Device# show ip pim vrf * rp mapping
VRF IPv4 default
PIM Group-to-RP Mappings
This system is an RP (Auto-RP)
Group(s) 224.0.0.0/4
RP 3.3.3.3 (?), v2v1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
827
IP Multicast Routing
show ip pim rp
Info source: 2.2.2.2 (?), elected via Auto-RP
Uptime: 4w3d, expires: 00:02:27
Group(s): 224.0.0.0/4, Static
RP: 1.2.3.4 (?)
Acl: abc, Static
RP: 1.1.1.1 (?)
VRF ENG
PIM Group-to-RP Mappings
This system is an RP-mapping agent
Group(s) 224.0.0.0/4
RP 8.8.8.8 (?), v2v1
Info source: 8.8.8.8 (?), elected via Auto-RP
Uptime: 4w3d, expires: 00:02:07
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
828
IP Multicast Routing
show ip pim tunnel
show ip pim tunnel
To display information about the Protocol Independent Multicast (PIM) register encapsulation and decapsulation
tunnels on an interface, use the show ip pim tunnel command.
show ip pim [ vrf { vrf-name | * }] tunnel [ Tunnel interface-number | verbose ]
Syntax Description vrf vrf-name (Optional) Specifies a virtual routing and forwarding (VRF) configuration.
vrf * (Optional) Specifies all the VRFs instances.
Tunnel interface-number (Optional) Specifies the tunnel interface number.
verbose (Optional) Provides additional information, such as the MAC encapsulation
header and platform-specific information.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The asterisk (*) was introduced to
display information related to all
VRF instances.
Usage Guidelines Use the show ip pim tunnel to display information about PIM tunnel interfaces.
PIM tunnel interfaces are used by the IPv4 Multicast Forwarding Information Base (MFIB) for the PIM sparse
mode (PIM-SM) registration process. Two types of PIM tunnel interfaces are used by the the IPv4 MFIB:
• A PIM encapsulation tunnel (PIM Encap Tunnel)
• A PIM decapsulation tunnel (PIM Decap Tunnel)
The PIM Encap Tunnel is dynamically created whenever a group-to-rendezvous point (RP) mapping is learned
(through auto-RP, bootstrap router (BSR), or static RP configuration). The PIM Encap Tunnel is used to
encapsulate multicast packets sent by first-hop designated routers (DRs) that have directly connected sources.
Similar to the PIM Encap Tunnel, the PIM Decap Tunnel interface is dynamically created—but it is created
only on the RP whenever a group-to-RP mapping is learned. The PIM Decap Tunnel interface is used by the
RP to decapsulate PIM register messages.
Note PIM tunnels will not appear in the running configuration.
The following syslog message appears when a PIM tunnel interface is created:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
829
IP Multicast Routing
show ip pim tunnel
* %LINEPROTO-5-UPDOWN: Line protocol on Interface Tunnel<interface_number>,
changed state to up
The asterisk (*) refers to all VRFs. In this case, using asterisk will display information related to tunnel
interfaces, for all applicable VRFs.
The following is sample output from the show ip pim tunnel taken from an RP. The output is used
to verify the PIM Encap and Decap Tunnel on the RP:
# show ip pim tunnel
Tunnel0
Type : PIM Encap
RP : 70.70.70.1*
Source: 70.70.70.1
Tunnel1*
Type : PIM Decap
RP : 70.70.70.1*
Source: -R2#
Note The asterisk (*) indicates that the router is the RP. The RP will always have a PIM Encap and Decap
Tunnel interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
830
IP Multicast Routing
show platform software fed switch ip multicast groups
show platform software fed switch ip multicast groups
To display platform-dependent IP multicast groups information, use the show platform software fed switch
ip multicast groups command in privileged EXEC mode.
show platform software fed switch {switch-number |active |standby }ip multicast groups [vrf-id vrf-id
|vrf-name vrf-name ][group-address [source source-address][detail] | count | summary ]
Syntax Description switch {switch_num | active | standby } The device for which you want to display information.
• switch_num—Enter the switch ID. Displays
information for the specified switch.
• active—Displays information for the active
switch.
• standby—Displays information for the standby
switch, if available.
vrf vrf-id (Optional) Specifies the multicast Virtual Routing and
Forwarding (VRF) ID.
vrf vrf-name (Optional) Specifies the multicast Virtual Routing and
Forwarding (VRF) name.
group-address (Optional) Specifies the IP Multicast Group Address.
source source-address (Optional) Specifies the IP Multicast Source Address
detail (Optional) Specifies the IP Multicast group detail.
count (Optional) Specifies the IP Multicast group count.
summary (Optional) Specifies the Multicast group summary.
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced
Command Modes Privileged EXEC (#)
Usage Guidelines Use this command only when you are working directly with a technical support representative while
troubleshooting a problem. Do not use this command unless a technical support representative asks you to do
so.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
831
IP Multicast Routing
show platform software fed switch ip multicast
show platform software fed switch ip multicast
To display platform-dependent IP multicast tables and other information, use the show platform software
fed switch ip multicast command in privileged EXEC mode.
show platform software fed switch{switch-number | active | standby} ip multicast {groups |
hardware[{detail}] | interfaces | retry}
Syntax Description switch {switch_num | The device for which you want to display information.
active | standby }
• switch_num—Enter the switch ID. Displays information for the specified
switch.
• active—Displays information for the active switch.
• standby—Displays information for the standby switch, if available.
groups Displays the IP multicast routes per group.
hardware [detail] Displays the IP multicast routes loaded into hardware. The optional detail
keyword is used to show the port members in the destination index and route
index.
interfaces Displays the IP multicast interfaces.
retry Displays the IP multicast routes in the retry queue.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command only when you are working directly with a technical support representative while
troubleshooting a problem. Do not use this command unless a technical support representative asks you to do
so.
Example
The following example shows how to display platform IP multicast routes per group:
# show platform software fed active ip multicast groups
Total Number of entries:3
MROUTE ENTRY vrf 0 (*, 224.0.0.0)
Token: 0x0000001f6 flags: C
No RPF interface.
Number of OIF: 0
Flags: 0x10 Pkts : 0
OIF Details:No OIF interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
832
IP Multicast Routing
show platform software fed switch ip multicast
DI details
----------
Handle:0x603cf7f8 Res-Type:ASIC_RSC_DI Asic-Num:255
Feature-ID:AL_FID_L3_MULTICAST_IPV4 Lkp-ftr-id:LKP_FEAT_INVALID ref_count:1
Hardware Indices/Handles: index0:0x51f6 index1:0x51f6
Cookie length 56
0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x4 0xe0 0x0 0x0 0x0 0x0 0x0
0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0
0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0 0x0
Detailed Resource Information (ASIC# 0)
----------------------------------------
al_rsc_di
RM:index = 0x51f6
RM:pmap = 0x0
RM:cmi = 0x0
RM:rcp_pmap = 0x0
RM:force data copy = 0
RM:remote cpu copy = 0
RM:remote data copy = 0
RM:local cpu copy = 0
RM:local data copy = 0
al_rsc_cmi
RM:index = 0x51f6
RM:cti_lo[0] = 0x0
RM:cti_lo[1] = 0x0
RM:cti_lo[2] = 0x0
RM:cpu_q_vpn[0] = 0x0
RM:cpu_q_vpn[1] = 0x0
RM:cpu_q_vpn[2] = 0x0
RM:npu_index = 0x0
RM:strip_seg = 0x0
RM:copy_seg = 0x0
Detailed Resource Information (ASIC# 1)
----------------------------------------
al_rsc_di
RM:index = 0x51f6
RM:pmap = 0x0
RM:cmi = 0x0
RM:rcp_pmap = 0x0
RM:force data copy = 0
RM:remote cpu copy = 0
RM:remote data copy = 0
RM:local cpu copy = 0
RM:local data copy = 0
al_rsc_cmi
RM:index = 0x51f6
RM:cti_lo[0] = 0x0
RM:cti_lo[1] = 0x0
RM:cti_lo[2] = 0x0
RM:cpu_q_vpn[0] = 0x0
RM:cpu_q_vpn[1] = 0x0
RM:cpu_q_vpn[2] = 0x0
RM:npu_index = 0x0
RM:strip_seg = 0x0
RM:copy_seg = 0x0
==============================================================
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
833
IP Multicast Routing
show platform software fed switch ip multicast
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
834
IP Multicast Routing
show platform software fed switch ip multicast df
show platform software fed switch ip multicast df
To display information about platform-dependent IP multicast designated forwarders (DF), use the show
platform software fed switch ip multicast df command in privileged EXEC mode.
show platform software fed switch{switch-number | active | standby} ip multicast df[{vrf-id vrf-id |
vrf-name vrf-name}][{df-index}]
Syntax Description switch {switch_num | active | standby } The device for which you want to display information.
• switch_num—Enter the switch ID. Displays
information for the specified switch.
• active—Displays information for the active
switch.
• standby—Displays information for the standby
switch, if available.
vrf-id vrf-id (Optional) Specifies the multicast Virtual Routing and
Forwarding (VRF) ID.
vrf vrf-name (Optional) Specifies the multicast Virtual Routing and
Forwarding (VRF) name.
df-index (Optional) Specifies the DF index.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines Use this command only when you are working directly with a technical support representative while
troubleshooting a problem. Do not use this command unless a technical support representative asks you to do
so.
The following is sample output from the show platform software fed switch ip multicast df command:
Device# show platform software fed switch active ip multicast df
VRF-ID DF-Index Ref-Count DF Set
================================================
2 1 1 Vlan254
Vlan186
Vlan305
Vlan135
Tunnel4
Null0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
835
IP Multicast Routing
show platform software fed switch ip multicast df
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
836
PA R T VI
Layer 2/3
• Layer 2/3 Commands, on page 839
Layer 2/3 Commands
• avb, on page 842
• channel-group, on page 844
• channel-protocol, on page 847
• clear l2protocol-tunnel counters, on page 848
• clear lacp, on page 849
• clear pagp, on page 850
• clear spanning-tree counters, on page 851
• clear spanning-tree detected-protocols, on page 852
• debug etherchannel, on page 853
• debug lacp, on page 854
• debug pagp, on page 855
• debug platform pm, on page 856
• debug platform udld, on page 857
• debug spanning-tree , on page 858
• instance (VLAN), on page 860
• interface port-channel, on page 862
• l2protocol-tunnel, on page 864
• lacp fast-switchover, on page 867
• lacp max-bundle, on page 869
• lacp port-priority, on page 870
• lacp rate, on page 871
• lacp system-priority, on page 872
• loopdetect, on page 873
• mvrp vlan creation, on page 875
• mvrp registration, on page 876
• mvrp timer, on page 878
• name (MST), on page 880
• no ptp enable, on page 881
• pagp learn-method, on page 882
• pagp port-priority, on page 884
• peer (PTP), on page 885
• policy-map, on page 886
• port-channel, on page 888
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
839
Layer 2/3
• port-channel auto, on page 889
• port-channel load-balance, on page 890
• port-channel load-balance extended, on page 892
• port-channel min-links, on page 894
• ptp dot1as extend property, on page 895
• ptp ip dscp, on page 896
• ptp priority1 value, on page 897
• ptp priority2 value, on page 898
• ptp profile dot1as, on page 899
• ptp property, on page 900
• ptp role primary, on page 901
• rep admin vlan, on page 902
• rep block port, on page 903
• rep lsl-age-timer, on page 905
• rep lsl-retries, on page 906
• rep preempt delay, on page 907
• rep preempt segment, on page 908
• rep segment, on page 909
• rep stcn, on page 911
• revision, on page 912
• show avb domain, on page 913
• show avb streams, on page 915
• show dot1q-tunnel, on page 916
• show etherchannel, on page 917
• show interfaces rep detail, on page 920
• show l2protocol-tunnel, on page 921
• show lacp, on page 923
• show loopdetect, on page 927
• show msrp port bandwidth, on page 928
• show msrp streams, on page 930
• show pagp, on page 932
• show platform etherchannel, on page 934
• show platform hardware fed active vlan ingress, on page 935
• show platform pm, on page 936
• show platform software fed active ptp interface loopback, on page 937
• show platform software fed switch ptp, on page 938
• show ptp brief, on page 940
• show ptp clock, on page 941
• show ptp parent, on page 942
• show ptp port, on page 944
• show ptp port loopback, on page 945
• show ptp transport properties, on page 946
• show rep topology, on page 947
• show spanning-tree, on page 949
• show spanning-tree mst, on page 955
• show udld, on page 958
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
840
Layer 2/3
• show vlan dot1q tag native, on page 962
• source ip interface, on page 963
• spanning-tree backbonefast, on page 964
• spanning-tree bpdufilter, on page 965
• spanning-tree bpduguard, on page 967
• spanning-tree bridge assurance, on page 969
• spanning-tree cost, on page 970
• spanning-tree etherchannel guard misconfig, on page 972
• spanning-tree extend system-id, on page 974
• spanning-tree guard, on page 975
• spanning-tree link-type, on page 976
• spanning-tree loopguard default, on page 978
• spanning-tree mode, on page 979
• spanning-tree mst, on page 980
• spanning-tree mst configuration, on page 981
• spanning-tree mst forward-time, on page 983
• spanning-tree mst hello-time, on page 984
• spanning-tree mst max-age, on page 985
• spanning-tree mst max-hops, on page 986
• spanning-tree mst pre-standard, on page 987
• spanning-tree mst priority, on page 989
• spanning-tree mst root, on page 990
• spanning-tree mst simulate pvst global, on page 991
• spanning-tree pathcost method, on page 992
• spanning-tree port-priority, on page 993
• spanning-tree portfast edge bpdufilter default, on page 995
• spanning-tree portfast edge bpduguard default, on page 997
• spanning-tree portfast default, on page 998
• spanning-tree transmit hold-count, on page 1000
• spanning-tree uplinkfast, on page 1001
• spanning-tree vlan, on page 1002
• switchport, on page 1005
• switchport access vlan, on page 1006
• switchport mode, on page 1007
• switchport nonegotiate, on page 1009
• switchport trunk, on page 1010
• switchport voice vlan, on page 1013
• transport unicast ipv4 local loopback, on page 1016
• udld, on page 1017
• udld port, on page 1019
• udld reset, on page 1021
• vlan dot1q tag native, on page 1022
• vtp mode, on page 1023
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
841
Layer 2/3
avb
avb
To enable Audio Video Bridging (AVB), use the avb command in global configuration mode. To disable
AVB, use the no form of this command.
avb [{ msrp-join-timer milliseconds | msrp-leave-timer milliseconds | msrp-leaveall-timer
milliseconds | msrp-tx-slow | strict | vlan vlan-id }]
no avb [{ msrp-join-timer | msrp-leave-timer | msrp-leaveall-timer | msrp-tx-slow | strict |
vlan }]
Syntax Description msrp-join-timer milliseconds (Optional) Configures the Multiple Stream Reservation Protocol (MSRP)
join timer value in milliseconds. The range is from 100 to 4000. The
default is 200.
msrp-leave-timer milliseconds (Optional) Configures the MSRP leave timer value in milliseconds. The
range is from 500 to 60000. The default is 1000.
msrp-leaveall-timer (Optional) Configures the MSRP leaveall timer value in milliseconds. The
milliseconds range is from 10000 to 50000. The default is 10000.
msrp-tx-slow (Optional) Slows down the default packet sending rate with a gap of 100
milliseconds.
strict (Optional) Configures the strict mode of AVB.
vlan vlan-id (Optional) Configures a specified VLAN as the default AVB VLAN. The
range is from from 2 to 4094.
Command Default AVB is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Cisco IOS XE Gibraltar 16.12.5 The msrp-join-timer, msrp-leave-timer, msrp-leaveall-timer,
msrp-tx-slow keywords were introduced.
Example
This example shows how to enable AVB:
Device> enable
Device# configure terminal
Device(config)# avb
This example shows how to configure the MSRP leave timer value:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
842
Layer 2/3
avb
Device> enable
Device# configure terminal
Device(config)# avb msrp-leave-timer 6000
This example shows how to set a specified VLAN as the default AVB VLAN:
Device> enable
Device# configure terminal
Device(config)# avb vlan 10
This example shows how set a specified VLAN as the default AVB VLAN:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 1/1/1
Device(config-if)# switchport mode trunk
Device(config-if)# exit
Device(config)# vlan 2
Device(config)# avb vlan 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
843
Layer 2/3
channel-group
channel-group
To assign an Ethernet port to an EtherChannel group, or to enable an EtherChannel mode, or both, use the
channel-group command in interface configuration mode. To remove an Ethernet port from an EtherChannel
group, use the no form of this command.
channel-group channel-group-number mode {active | auto [non-silent] | desirable [non-silent] | on |
passive}
no channel-group
Syntax Description channel-group-number Channel group number.
The range is 1 to 128.
mode Specifies the EtherChannel mode.
active Unconditionally enables Link
Aggregation Control Protocol
(LACP).
auto Enables the Port Aggregation
Protocol (PAgP) only if a PAgP
device is detected.
non-silent (Optional) Configures the interface
for nonsilent operation when
connected to a partner that is
PAgP-capable. Use in PAgP mode
with the auto or desirable keyword
when traffic is expected from the
other device.
desirable Unconditionally enables PAgP.
on Enables the on mode.
passive Enables LACP only if a LACP
device is detected.
Command Default No channel groups are assigned.
No mode is configured.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines For Layer 2 EtherChannels, the channel-group command automatically creates the port-channel interface
when the channel group gets its first physical port. You do not have to use the interface port-channel command
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
844
Layer 2/3
channel-group
in global configuration mode to manually create a port-channel interface. If you create the port-channel
interface first, the channel-group-number can be the same as the port-channel-number, or you can use a new
number. If you use a new number, the channel-group command dynamically creates a new port channel.
Although it is not necessary to disable the IP address that is assigned to a physical port that is part of a channel
group, we strongly recommend that you do so.
You create Layer 3 port channels by using the interface port-channel command followed by the no switchport
interface configuration command. Manually configure the port-channel logical interface before putting the
interface into the channel group.
After you configure an EtherChannel, configuration changes that you make on the port-channel interface
apply to all the physical ports assigned to the port-channel interface. Configuration changes applied to the
physical port affect only the port where you apply the configuration. To change the parameters of all ports in
an EtherChannel, apply configuration commands to the port-channel interface, for example, spanning-tree
commands or commands to configure a Layer 2 EtherChannel as a trunk.
Active mode places a port into a negotiating state in which the port initiates negotiations with other ports by
sending LACP packets. A channel is formed with another port group in either the active or passive mode.
Auto mode places a port into a passive negotiating state in which the port responds to PAgP packets it receives
but does not start PAgP packet negotiation. A channel is formed only with another port group in desirable
mode. When auto is enabled, silent operation is the default.
Desirable mode places a port into an active negotiating state in which the port starts negotiations with other
ports by sending PAgP packets. An EtherChannel is formed with another port group that is in the desirable
or auto mode. When desirable is enabled, silent operation is the default.
If you do not specify non-silent with the auto or desirable mode, silent is assumed. The silent mode is used
when the switch is connected to a device that is not PAgP-capable and rarely, if ever, sends packets. An
example of a silent partner is a file server or a packet analyzer that is not generating traffic. In this case, running
PAgP on a physical port prevents that port from ever becoming operational. However, it allows PAgP to
operate, to attach the port to a channel group, and to use the port for transmission. Both ends of the link cannot
be set to silent.
In on mode, a usable EtherChannel exists only when both connected port groups are in the on mode.
Caution Use care when using the on mode. This is a manual configuration, and ports on both ends of the EtherChannel
must have the same configuration. If the group is misconfigured, packet loss or spanning-tree loops can occur.
Passive mode places a port into a negotiating state in which the port responds to received LACP packets but
does not initiate LACP packet negotiation. A channel is formed only with another port group in active mode.
Do not configure an EtherChannel in both the PAgP and LACP modes. EtherChannel groups running PAgP
and LACP can coexist on the same switch or on different switches in the stack (but not in a cross-stack
configuration). Individual EtherChannel groups can run either PAgP or LACP, but they cannot interoperate.
If you set the protocol by using the channel-protocol interface configuration command, the setting is not
overridden by the channel-group interface configuration command.
Do not configure a port that is an active or a not-yet-active member of an EtherChannel as an IEEE 802.1x
port. If you try to enable IEEE 802.1x authentication on an EtherChannel port, an error message appears, and
IEEE 802.1x authentication is not enabled.
Do not configure a secure port as part of an EtherChannel or configure an EtherChannel port as a secure port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
845
Layer 2/3
channel-group
For a complete list of configuration guidelines, see the “Configuring EtherChannels” chapter in the software
configuration guide for this release.
Caution Do not enable Layer 3 addresses on the physical EtherChannel ports. Do not assign bridge groups on the
physical EtherChannel ports because it creates loops.
This example shows how to configure an EtherChannel on a single switch in the stack. It assigns
two static-access ports in VLAN 10 to channel 5 with the PAgP mode desirable:
Device# configure terminal
Device(config)# interface range GigabitEthernet 2/0/1 - 2
Device(config-if-range)# switchport mode access
Device(config-if-range)# switchport access vlan 10
Device(config-if-range)# channel-group 5 mode desirable
Device(config-if-range)# end
This example shows how to configure an EtherChannel on a single switch in the stack. It assigns
two static-access ports in VLAN 10 to channel 5 with the LACP mode active:
Device# configure terminal
Device(config)# interface range GigabitEthernet 2/0/1 - 2
Device(config-if-range)# switchport mode access
Device(config-if-range)# switchport access vlan 10
Device(config-if-range)# channel-group 5 mode active
Device(config-if-range)# end
This example shows how to configure a cross-stack EtherChannel in a switch stack. It uses LACP
passive mode and assigns two ports on stack member 2 and one port on stack member 3 as static-access
ports in VLAN 10 to channel 5:
Device# configure terminal
Device(config)# interface range GigabitEthernet 2/0/4 - 5
Device(config-if-range)# switchport mode access
Device(config-if-range)# switchport access vlan 10
Device(config-if-range)# channel-group 5 mode passive
Device(config-if-range)# exit
Device(config)# interface GigabitEthernet 3/0/3
Device(config-if)# switchport mode access
Device(config-if)# switchport access vlan 10
Device(config-if)# channel-group 5 mode passive
Device(config-if)# exit
You can verify your settings by entering the show running-config privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
846
Layer 2/3
channel-protocol
channel-protocol
To restrict the protocol used on a port to manage channeling, use the channel-protocol command in interface
configuration mode. To return to the default setting, use the no form of this command.
channel-protocol {lacp | pagp}
no channel-protocol
Syntax Description lacp Configures an EtherChannel with the Link Aggregation Control Protocol (LACP).
pagp Configures an EtherChannel with the Port Aggregation Protocol (PAgP).
Command Default No protocol is assigned to the EtherChannel.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the channel-protocol command only to restrict a channel to LACP or PAgP. If you set the protocol by
using the channel-protocol command, the setting is not overridden by the channel-group command in
interface configuration mode.
You must use the channel-group command in interface configuration mode to configure the EtherChannel
parameters. The channel-group command also can set the mode for the EtherChannel.
You cannot enable both the PAgP and LACP modes on an EtherChannel group.
PAgP and LACP are not compatible; both ends of a channel must use the same protocol.
You cannot configure PAgP on cross-stack configurations.
This example shows how to specify LACP as the protocol that manages the EtherChannel:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# channel-protocol lacp
You can verify your settings by entering the show etherchannel [channel-group-number] protocol
command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
847
Layer 2/3
clear l2protocol-tunnel counters
clear l2protocol-tunnel counters
To clear the protocol counters in protocol tunnel ports, use the clear l2protocol-tunnel counters command
in privileged EXEC mode.
clear l2protocol-tunnel counters [interface-id]
Syntax Description interface-id (Optional) The interface (physical interface or port cha
counters are to be cleared.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines Use this command to clear protocol tunnel counters on the switch or on the specified interface.
This example shows how to clear Layer 2 protocol tunnel counters on an interface:
Device# clear l2protocol-tunnel counters gigabitethernet1/0/3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
848
Layer 2/3
clear lacp
clear lacp
To clear Link Aggregation Control Protocol (LACP) channel-group counters, use the clear lacp command
in privileged EXEC mode.
clear lacp [channel-group-number] counters
Syntax Description channel-group-number (Optional) Channel group number.
The range is 1 to 128.
counters Clears traffic counters.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can clear all counters by using the clear lacp counters command, or you can clear only the counters for
the specified channel group by using the clear lacp channel-group-number counters command.
This example shows how to clear all channel-group information:
Device> enable
Device# clear lacp counters
This example shows how to clear LACP traffic counters for group 4:
Device> enable
Device# clear lacp 4 counters
You can verify that the information was deleted by entering the show lacp counters or the show
lacp channel-group-number counters command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
849
Layer 2/3
clear pagp
clear pagp
To clear the Port Aggregation Protocol (PAgP) channel-group information, use the clear pagp command in
privileged EXEC mode.
clear pagp [channel-group-number] counters
Syntax Description channel-group-number (Optional) Channel group number.
The range is 1 to 128.
counters Clears traffic counters.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can clear all counters by using the clear pagp counters command, or you can clear only the counters
for the specified channel group by using the clear pagp channel-group-number counters command.
This example shows how to clear all channel-group information:
Device> enable
Device# clear pagp counters
This example shows how to clear PAgP traffic counters for group 10:
Device> enable
Device# clear pagp 10 counters
You can verify that the information was deleted by entering the show pagp command in privileged
EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
850
Layer 2/3
clear spanning-tree counters
clear spanning-tree counters
To clear the spanning-tree counters, use the clear spanning-tree counters command in privileged EXEC
mode.
clear spanning-tree counters [interface interface-id]
Syntax Description interface interface-id (Optional) Clears all spanning-tree counters on the specified
include physical ports, VLANs, and port channels.
The VLAN range is 1 to 4094.
The port channel range is 1 to 128.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If the interface-id value is not specified, spanning-tree counters are cleared for all interfaces.
This example shows how to clear spanning-tree counters for all interfaces:
Device> enable
Device# clear spanning-tree counters
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
851
Layer 2/3
clear spanning-tree detected-protocols
clear spanning-tree detected-protocols
To restart the protocol migration process and force renegotiation with neighboring devices on the interface,
use the clear spanning-tree detected-protocols command in privileged EXEC mode.
clear spanning-tree detected-protocols [interface interface-id]
Syntax Description interface interface-id (Optional) Restarts the protocol migration process on the specified in
channels.
The VLAN range is 1 to 4094.
The port channel range is 1 to 128.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A device running the rapid per-VLAN spanning-tree plus (rapid-PVST+) protocol or the Multiple Spanning
Tree Protocol (MSTP) supports a built-in protocol migration method that enables it to interoperate with legacy
IEEE 802.1D devices. If a rapid-PVST+ or an MSTP device receives a legacy IEEE 802.1D configuration
bridge protocol data unit (BPDU) with the protocol version set to 0, the device sends only IEEE 802.1D
BPDUs on that port. A multiple spanning-tree (MST) device can also detect that a port is at the boundary of
a region when it receives a legacy BPDU, an MST BPDU (Version 3) associated with a different region, or
a rapid spanning-tree (RST) BPDU (Version 2).
The device does not automatically revert to the rapid-PVST+ or the MSTP mode if it no longer receives IEEE
802.1D BPDUs because it cannot learn whether the legacy switch has been removed from the link unless the
legacy switch is the designated switch. Use the clear spanning-tree detected-protocols command in this
situation.
This example shows how to restart the protocol migration process on a port:
Device> enable
Device# clear spanning-tree detected-protocols interface gigabitethernet2/0/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
852
Layer 2/3
debug etherchannel
debug etherchannel
To enable debugging of EtherChannels, use the debug etherchannel command in privileged EXEC mode.
To disable debugging, use the no form of the command.
debug etherchannel [{all | detail | error | event | idb }]
no debug etherchannel [{all | detail | error | event | idb }]
Syntax Description all (Optional) Displays all EtherChannel debug messages.
detail (Optional) Displays detailed EtherChannel debug messages.
error (Optional) Displays EtherChannel error debug messages.
event (Optional) Displays EtherChannel event messages.
idb (Optional) Displays PAgP interface descriptor block debug messages.
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug etherchannel command is the same as the no debug etherchannel command.
Note Although the linecard keyword is displayed in the command-line help, it is not supported.
This example shows how to display all EtherChannel debug messages:
Device> enable
Device# debug etherchannel all
This example shows how to display debug messages related to EtherChannel events:
Device> enable
Device# debug etherchannel event
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
853
Layer 2/3
debug lacp
debug lacp
To enable debugging of Link Aggregation Control Protocol (LACP) activity, use the debug lacp command
in privileged EXEC mode. To disable LACP debugging, use the no form of this command.
debug lacp [{all | event | fsm | misc | packet}]
no debug lacp [{all | event | fsm | misc | packet}]
Syntax Description all (Optional) Displays all LACP debug messages.
event (Optional) Displays LACP event debug messages.
fsm (Optional) Displays messages about changes within the LACP finite state machine.
misc (Optional) Displays miscellaneous LACP debug messages.
packet (Optional) Displays the receiving and transmitting LACP control packets.
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug etherchannel command is the same as the no debug etherchannel command.
This example shows how to display all LACP debug messages:
Device> enable
Device# debug LACP all
This example shows how to display debug messages related to LACP events:
Device> enable
Device# debug LACP event
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
854
Layer 2/3
debug pagp
debug pagp
To enable debugging of Port Aggregation Protocol (PAgP) activity, use the debug pagp command in privileged
EXEC mode. To disable PAgP debugging, use the no form of this command.
debug pagp [{all | dual-active | event | fsm | misc | packet}]
no debug pagp [{all | dual-active | event | fsm | misc | packet}]
Syntax Description all (Optional) Displays all PAgP debug messages.
dual-active (Optional) Displays dual-active detection messages.
event (Optional) Displays PAgP event debug messages.
fsm (Optional) Displays messages about changes within the
PAgP finite state machine.
misc (Optional) Displays miscellaneous PAgP debug messages.
packet (Optional) Displays the receiving and transmitting PAgP
control packets.
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug pagp command is the same as the no debug pagp command.
This example shows how to display all PAgP debug messages:
Device> enable
Device# debug pagp all
This example shows how to display debug messages related to PAgP events:
Device> enable
Device# debug pagp event
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
855
Layer 2/3
debug platform pm
debug platform pm
To enable debugging of the platform-dependent port manager software module, use the debug platform pm
command in privileged EXEC mode. To disable debugging, use the no form of this command.
debug platform pm {all | counters | errdisable | fec | if-numbers | l2-control | link-status |
platform | pm-vectors [detail] | ses | vlans}
no debug platform pm {all | counters | errdisable | fec | if-numbers | l2-control | link-status |
platform | pm-vectors [detail] | ses | vlans}
Syntax Description all Displays all port manager debug messages.
counters Displays counters for remote procedure call (RPC) debug messages.
errdisable Displays error-disabled-related events debug messages.
fec Displays forwarding equivalence class (FEC) platform-related events
debug messages.
if-numbers Displays interface-number translation event debug messages.
l2-control Displays Layer 2 control infra debug messages.
link-status Displays interface link-detection event debug messages.
platform Displays port manager function event debug messages.
pm-vectors Displays port manager vector-related event debug messages.
detail (Optional) Displays vector-function details.
ses Displays service expansion shelf (SES) related event debug messages.
vlans Displays VLAN creation and deletion event debug messages.
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug platform pm command is the same as the no debug platform pm command.
This example shows how to display debug messages related to the creation and deletion of VLANs:
Device> enable
Device# debug platform pm vlans
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
856
Layer 2/3
debug platform udld
debug platform udld
To enable debugging of the platform-dependent UniDirectional Link Detection (UDLD) software, use the
debug platform udld command in privileged EXEC mode. To disable debugging, use the no form of this
command.
debug platform udld [{error | event}] [switch switch-number]
no debug platform udld [{error | event}] [switch switch-number]
Syntax Description error (Optional) Displays error condition debug messages.
event (Optional) Displays UDLD-related platform event debug messages.
switch (Optional) Displays UDLD debug messages for the specified stack member.
switch-number
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug platform udld command is the same as the no debug platform udld command.
When you enable debugging on a switch stack, it is enabled only on the active switch. To enable debugging
on a stack member, you can start a session from the active switch by using the session switch-number command
in privileged EXEC mode. Then enter the debug command at the command-line prompt of the stack member.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
857
Layer 2/3
debug spanning-tree
debug spanning-tree
To enable debugging of spanning-tree activities, use the debug spanning-tree command in EXEC mode. To
disable debugging, use the no form of this command.
debug spanning-tree {all | backbonefast | bpdu | bpdu-opt | config | etherchannel | events | exceptions
| general | ha | mstp | pvst+ | root | snmp | synchronization | switch | uplinkfast}
no debug spanning-tree {all | backbonefast | bpdu | bpdu-opt | config | etherchannel | events |
exceptions | general | mstp | pvst+ | root | snmp | synchronization | switch | uplinkfast}
Syntax Description all Displays all spanning-tree debug messages.
backbonefast Displays BackboneFast-event debug messages.
bpdu Displays spanning-tree bridge protocol data unit (BPDU)
debug messages.
bpdu-opt Displays optimized BPDU handling debug messages.
config Displays spanning-tree configuration change debug
messages.
etherchannel Displays EtherChannel-support debug messages.
events Displays spanning-tree topology event debug messages.
exceptions Displays spanning-tree exception debug messages.
general Displays general spanning-tree activity debug messages.
ha Displays high-availability spanning-tree debug messages.
mstp Debugs Multiple Spanning Tree Protocol (MSTP) events.
pvst+ Displays per-VLAN spanning-tree plus (PVST+) event
debug messages.
root Displays spanning-tree root-event debug messages.
snmp Displays spanning-tree Simple Network Management
Protocol (SNMP) handling debug messages.
switch Displays switch shim command debug messages. This
shim is the software module that is the interface between
the generic Spanning Tree Protocol (STP) code and the
platform-specific code of various device platforms.
synchronization Displays the spanning-tree synchronization event debug
messages.
uplinkfast Displays UplinkFast-event debug messages.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
858
Layer 2/3
debug spanning-tree
Command Default Debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The undebug spanning-tree command is the same as the no debug spanning-tree command.
When you enable debugging on a stack, it is enabled only on the active switch. To enable debugging on the
standby switch, start a session from the active switch by using the session switch-number command in
privileged EXEC mode. Enter the debug command at the command-line prompt of the standby switch.
To enable debugging on the standby switch without first starting a session on the active switch, use the remote
command switch-number LINE command in privileged EXEC mode.
This example shows how to display all spanning-tree debug messages:
Device> enable
Device# debug spanning-tree all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
859
Layer 2/3
instance (VLAN)
instance (VLAN)
To map a VLAN or a group of VLANs to a multiple spanning tree (MST) instance, use the instance command
in MST configuration mode. To return the VLANs to the default internal spanning tree (CIST) instance, use
the no form of this command.
instance instance-id vlans vlan-range
no instance instance-id
Syntax Description instance-id Instance to which the specified VLANs are mapped. The range is from 0 to 4094.
vlans vlan-range Specifies the number of the VLANs to be mapped to the specified instance. The range
is from 1 to 4094.
Command Default No VLANs are mapped to any MST instance (all VLANs are mapped to the CIST instance).
Command Modes MST configuration mode (config-mst)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The vlans vlan-range is entered as a single value or a range.
The mapping is incremental, not absolute. When you enter a range of VLANs, this range is added or removed
to the existing instances.
Any unmapped VLAN is mapped to the CIST instance.
Examples The following example shows how to map a range of VLANs to instance 2:
Device(config)# spanning-tree mst configuration
Device(config-mst)# instance 2 vlans 1-100
Device(config-mst)#
The following example shows how to map a VLAN to instance 5:
Device(config)# spanning-tree mst configuration
Device(config-mst)# instance 5 vlans 1100
Device(config-mst)#
The following example shows how to move a range of VLANs from instance 2 to the CIST instance:
Device(config)# spanning-tree mst configuration
Device(config-mst)# no instance 2 vlans 40-60
Device(config-mst)#
The following example shows how to move all the VLANs that are mapped to instance 2 back to
the CIST instance:
Device(config)# spanning-tree mst configuration
Device(config-mst)# no instance 2
Device(config-mst)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
860
Layer 2/3
instance (VLAN)
Related Commands Command Description
name (MST configuration mode) 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 mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
861
Layer 2/3
interface port-channel
interface port-channel
To access or create a port channel, use the interface port-channel command in global configuration mode.
Use the no form of this command to remove the port channel.
interface port-channel port-channel-number
no interface port-channel
Syntax Description port-channel-number Channel group
number.
The range is 1 to 128.
Command Default No port channel logical interfaces are defined.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines For Layer 2 EtherChannels, you do not have to create a port-channel interface before assigning physical ports
to a channel group. Instead, you can use the channel-group command in interface configuration mode, which
automatically creates the port-channel interface when the channel group obtains its first physical port. If you
create the port-channel interface first, the channel-group-number can be the same as the port-channel-number,
or you can use a new number. If you use a new number, the channel-group command dynamically creates a
new port channel.
You create Layer 3 port channels by using the interface port-channel command followed by the no switchport
command in interface configuration mode. You should manually configure the port-channel logical interface
before putting the interface into the channel group.
Only one port channel in a channel group is allowed.
Caution When using a port-channel interface as a routed port, do not assign Layer 3 addresses on the physical ports
that are assigned to the channel group.
Caution Do not assign bridge groups on the physical ports in a channel group used as a Layer 3 port channel interface
because it creates loops. You must also disable spanning tree.
Follow these guidelines when you use the interface port-channel command:
• If you want to use the Cisco Discovery Protocol (CDP), you must configure it on the physical port and
not on the port channel interface.
• Do not configure a port that is an active member of an EtherChannel as an IEEE 802.1x port. If IEEE
802.1x is enabled on a not-yet active port of an EtherChannel, the port does not join the EtherChannel.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
862
Layer 2/3
interface port-channel
For a complete list of configuration guidelines, see the “Configuring EtherChannels” chapter in the software
configuration guide for this release.
This example shows how to create a port channel interface with a port channel number of 5:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 5
You can verify your setting by entering either the show running-config in privileged EXEC mode
or the show etherchannel channel-group-number detail command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
863
Layer 2/3
l2protocol-tunnel
l2protocol-tunnel
To enable tunneling of Layer 2 protocols on an access port, IEEE 802.1Q tunnel port, or a port channel, use
the l2protocol-tunnel command in interface configuration mode on the switch stack or on a standalone
switch. Use the no form of this command to disable tunneling on the interface.
l2protocol-tunnel [{drop-threshold | shutdown-threshold}] [value] [{cdp | stp | vtp }] [lldp]
[{point-to-point | [{pagp | lacp | udld}]}]
no l2protocol-tunnel [{drop-threshold | shutdown-threshold}] [value] [{cdp | stp | vtp }] [lldp]
[{point-to-point | [{pagp | lacp | udld}]}]
Syntax Description drop-threshold (Optional) Sets a drop threshold for the maximum rate of Layer 2 protocol packets per
second to be received before an interface drops packets.
shutdown-threshold (Optional) Sets a shutdown threshold for the maximum rate of Layer 2 protocol packets
per second to be received before an interface is shut down.
value A threshold in packets per second to be received for encapsulation before the interface
shuts down, or the threshold before the interface drops packets. The range is 1 to 4096.
The default is no threshold.
cdp (Optional) Enables tunneling of CDP, specifies a shutdown threshold for CDP, or
specifies a drop threshold for CDP.
stp (Optional) Enables tunneling of STP, specifies a shutdown threshold for STP, or
specifies a drop threshold for STP.
vtp (Optional) Enables tunneling or VTP, specifies a shutdown threshold for VTP, or
specifies a drop threshold for VTP.
lldp (Optional) Enables tunneling of LLDP packets.
point-to-point (Optional) Enables point-to point tunneling of PAgP, LACP, and UDLD packets.
pagp (Optional) Enables point-to-point tunneling of PAgP, specifies a shutdown threshold
for PAgP, or specifies a drop threshold for PAgP.
lacp (Optional) Enables point-to-point tunneling of LACP, specifies a shutdown threshold
for LACP, or specifis a drop threshold for LACP.
udld (Optional) Enables point-to-point tunneling of UDLD, specifies a shutdown threshold
for UDLD, or specifies a drop threshold for UDLD.
Command Default The default is that no Layer 2 protocol packets are tunneled.
The default is no shutdown threshold for the number of Layer 2 protocol packets.
The default is no drop threshold for the number of Layer 2 protocol packets.
Command Modes Interface configuration
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
864
Layer 2/3
l2protocol-tunnel
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines You can enable tunneling for Cisco Discovery Protocol (CDP), Spanning Tree Protocol (STP), or VLAN
Trunking Protocol (VTP) packets. You can also enable point-to-point tunneling for Port Aggregation Protocol
(PAgP), Link Aggregation Control Protocol (LACP), or UniDirectional Link Detection (UDLD) packets.
You must enter this command, with or without protocol types, to tunnel Layer 2 packets.
If you enter this command for a port channel, all ports in the channel must have the same configuration.
Layer 2 protocol tunneling across a service-provider network ensures that Layer 2 information is propagated
across the network to all customer locations. When protocol tunneling is enabled, protocol packets are
encapsulated with a well-known Cisco multicast address for transmission across the network. When the packets
reach their destination, the well-known MAC address is replaced by the Layer 2 protocol MAC address.
You can enable Layer 2 protocol tunneling for CDP, STP, and VTP individually or for all three protocols.
In a service-provider network, you can use Layer 2 protocol tunneling to enhance the creation of EtherChannels
by emulating a point-to-point network topology. When protocol tunneling is enabled on the service-provider
switch for PAgP or LACP, remote customer switches receive the protocol data units (PDUs) and can negotiate
automatic creation of EtherChannels.
To enable tunneling of PAgP, LACP, and UDLD packets, you must have a point-to-point network topology.
To decrease the link-down detection time, you should also enable UDLD on the interface when you enable
tunneling of PAgP or LACP packets.
You can enable point-to-point protocol tunneling for PAgP, LACP, and UDLD individually or for all three
protocols.
Caution PAgP, LACP, and UDLD tunneling is only intended to emulate a point-to-point topology. An erroneous
configuration that sends tunneled packets to many ports could lead to a network failure.
Enter the shutdown-threshold keyword to control the number of protocol packets per second that are received
on an interface before it shuts down. When no protocol option is specified with the keyword, the threshold is
applied to each of the tunneled Layer 2 protocol types. If you also set a drop threshold on the interface, the
shutdown-threshold value must be greater than or equal to the drop-threshold value.
When the shutdown threshold is reached, the interface is error-disabled. If you enable error recovery by
entering the errdisable recovery cause l2ptguard global configuration command, the interface is brought
out of the error-disabled state and allowed to retry the operation again when all the causes have timed out. If
the error recovery function is not enabled for l2ptguard, the interface stays in the error-disabled state until
you enter the shutdown and no shutdown interface configuration commands.
Enter the drop-threshold keyword to control the number of protocol packets per second that are received on
an interface before it drops packets. When no protocol option is specified with a keyword, the threshold is
applied to each of the tunneled Layer 2 protocol types. If you also set a shutdown threshold on the interface,
the drop-threshold value must be less than or equal to the shutdown-threshold value.
When the drop threshold is reached, the interface drops Layer 2 protocol packets until the rate at which they
are received is below the drop threshold.
The configuration is saved in NVRAM.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
865
Layer 2/3
l2protocol-tunnel
For more information about Layer 2 protocol tunneling, see the software configuration guide for this release.
Examples This example shows how to enable protocol tunneling for CDP packets and to configure the shutdown
threshold as 50 packets per second:
Device(config-if)# l2protocol-tunnel cdp
Device(config-if)# l2protocol-tunnel shutdown-threshold cdp 50
This example shows how to enable protocol tunneling for STP packets and to configure the drop
threshold as 400 packets per second:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet1/0/11
Device(config-if)# l2protocol-tunnel stp
Device(config-if)# l2protocol-tunnel drop-threshold stp 400
This example shows how to enable point-to-point protocol tunneling for PAgP and UDLD packets
and to configure the PAgP drop threshold as 1000 packets per second:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# switchport access vlan 19
Device(config-if)# switchport mode dot1q-tunnel
Device(config-if)# l2protocol-tunnel point-to-point pagp
Device(config-if)# l2protocol-tunnel point-to-point udld
Device(config-if)# l2protocol-tunnel drop-threshold point-to-point pagp 1000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
866
Layer 2/3
lacp fast-switchover
lacp fast-switchover
To enable Link Aggregation Control Protocol (LACP) 1:1 link redundancy, use the lacp fast-switchover
command in interface configuration mode. To disable LACP 1:1 link redundancy, use the no form of this
command.
lacp fast-switchover [dampening time]
no lacp fast-switchover[dampening time]
Syntax Description dampening time Enables LACP 1:1 hot-standby dampening. The range is 30 to 180 seconds.
Command Default LACP 1:1 link redundancy is disabled by default.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Usage Guidelines Prior to entering the lacp fast-switchover command, you must ensure the following:
• The port channel protocol type is LACP.
• The lacp max-bundle 1 command has been entered on the port channel. Note that the lacp fast-switchover
command will not affect the lacp max-bundle command.
Prior to entering the lacp fast-switchover dampening command, you must ensure the following:
• The port channel protocol type is LACP.
• The lacp max-bundle 1 and lacp fast-switchover commands have been entered on the port channel.
When you enable LACP 1:1 link redundancy, based on the system priority and port priority, the port with the
higher system priority chooses one link as the active link and the other link as the standby link (lower the
LACP port priority, higher the preference, and lower the LACP system priority, higher the preference). In the
case of the LACP 1:1 Redundancy feature, when the active link fails, the standby link is selected as the new
active link without taking down the port channel. When the original active link recovers, it reverts to its active
link status. During this changeover, the port channel is also up.
In the case of LACP 1:1 Hot Standby Dampening feature, a timer is configured that delays the switchover
back to the higher priority port after it becomes active.
Note • We recommend that you configure only two ports (one active and one hot standby) in the bundle, for
optimum performance.
• LACP 1:1 redundancy must be enabled at both ends of the LACP EtherChannel.
• LACP 1:1 redundancy and dampening work only on LACP port channels.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
867
Layer 2/3
lacp fast-switchover
Examples The following example shows how to enable LACP 1:1 link redundancy:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 40
Device(config-if)# lacp fast-switchover
Device(config-if)# lacp max-bundle 1
The following example shows how to enable LACP 1:1 hot standby dampening:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 40
Device(config-if)# lacp fast-switchover
Device(config-if)# lacp max-bundle 1
Device(config-if)# lacp fast-switchover dampening 70
Related Commands Command Description
lacp max-bundle Assigns and configures an EtherChannel interface to an EtherChannel group.
show etherchannel Displays the EtherChannel information for a channel.
show lacp Displays the LACP channel group information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
868
Layer 2/3
lacp max-bundle
lacp max-bundle
To define the maximum number of active LACP ports allowed in a port channel, use the lacp max-bundle
command in interface configuration mode. To return to the default setting, use the no form of this command.
lacp max-bundle max_bundle_number
no lacp max-bundle
Syntax Description max_bundle_number The maximum number of active LACP ports in the port channel. The range is 1 to
8. The default is 8.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active,
and up to eight ports can be in hot-standby mode. When there are more than eight ports in an LACP channel
group, the device on the controlling end of the link uses port priorities to determine which ports are bundled
into the channel and which ports are put in hot-standby mode. Port priorities on the other device (the
noncontrolling end of the link) are ignored.
The lacp max-bundle command must specify a number greater than the number specified by the port-channel
min-links command.
Use the show etherchannel summary command in privileged EXEC mode to see which ports are in the
hot-standby mode (denoted with an H port-state flag in the output display).
This example shows how to specify a maximum of five active LACP ports in port channel 2:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 2
Device(config-if)# lacp max-bundle 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
869
Layer 2/3
lacp port-priority
lacp port-priority
To configure the port priority for the Link Aggregation Control Protocol (LACP), use the lacp port-priority
command in interface configuration mode. To return to the default setting, use the no form of this command.
lacp port-priority priority
no lacp port-priority
Syntax Description priority Port priority for LACP. The range is 1 to 65535.
Command Default The default is 32768.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The lacp port-priority command in interface configuration mode determines which ports are bundled and
which ports are put in hot-standby mode when there are more than eight ports in an LACP channel group.
An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active,
and up to eight ports can be in standby mode.
In port-priority comparisons, a numerically lower value has a higher priority: When there are more than eight
ports in an LACP channel group, the eight ports with the numerically lowest values (highest priority values)
for LACP port priority are bundled into the channel group, and the lower-priority ports are put in hot-standby
mode. If two or more ports have the same LACP port priority (for example, they are configured with the
default setting of 65535), then an internal value for the port number determines the priority.
Note The LACP port priorities are only effective if the ports are on the device that controls the LACP link. See the
lacp system-priority command in global configuration mode for determining which device controls the link.
Use the show lacp internal command in privileged EXEC mode to display LACP port priorities and internal
port number values.
For information about configuring LACP on physical ports, see the configuration guide for this release.
This example shows how to configure the LACP port priority on a port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# lacp port-priority 1000
You can verify your settings by entering the show lacp [channel-group-number] internal command
in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
870
Layer 2/3
lacp rate
lacp rate
To set the rate at which Link Aggregation Control Protocol (LACP) control packets are ingressed to an
LACP-supported interface, use the lacp rate command in interface configuration mode. To return to the
default settings, use the no form of this command
lacp rate {normal | fast}
no lacp rate
Syntax Description normal Specifies that LACP control packets are ingressed at the normal rate, every 30 seconds after the
link is bundled.
fast Specifies that LACP control packets are ingressed at the fast rate, once every 1 second.
Command Default The default ingress rate for control packets is 30 seconds after the link is bundled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to modify the duration of LACP timeout. The LACP timeout value on Cisco switch is
three times the LACP rate that is configured on the interface. Using the lacp ratecommand, you can select
the LACP timeout value for a switch to be either 90 seconds or 3 seconds.
This command is supported only on LACP-enabled interfaces.
This example shows how to specify the fast (1 second) ingress rate on interface GigabitEthernet 0/0:
Device> enable
Device# configure terminall
Device(config)# interface gigabitEthernet 0/0
Device(config-if)# lacp rate fast
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
871
Layer 2/3
lacp system-priority
lacp system-priority
To configure the system priority for the Link Aggregation Control Protocol (LACP), use the lacp
system-priority command in global configuration mode on the device. To return to the default setting, use
the no form of this command.
lacp system-priority priority
no lacp system-priority
Syntax Description priority System priority for LACP. The range is 1 to 65535.
Command Default The default is 32768.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The lacp system-priority command determines which device in an LACP link controls port priorities.
An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active,
and up to eight ports can be in standby mode. When there are more than eight ports in an LACP channel group,
the device on the controlling end of the link uses port priorities to determine which ports are bundled into the
channel and which ports are put in hot-standby mode. Port priorities on the other device (the noncontrolling
end of the link) are ignored.
In priority comparisons, numerically lower values have a higher priority. Therefore, the system with the
numerically lower value (higher priority value) for LACP system priority becomes the controlling system. If
both devices have the same LACP system priority (for example, they are both configured with the default
setting of 32768), the LACP system ID (the device MAC address) determines which device is in control.
The lacp system-priority command applies to all LACP EtherChannels on the device.
Use the show etherchannel summary command in privileged EXEC mode to see which ports are in the
hot-standby mode (denoted with an H port-state flag in the output display).
This example shows how to set the LACP system priority:
Device> enable
Device# configure terminal
Device(config)# lacp system-priority 20000
You can verify your settings by entering the show lacp sys-id command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
872
Layer 2/3
loopdetect
loopdetect
To detect network loops, use the loopdetect command in interface configuration mode. To disable
loop-detection guard use the no form of this command.
loopdetect [ time | action syslog | source-port ]
no loopdetect [ time | action syslog | source-port ]
Syntax Description time (Optional) Time interval at which loop-detect frames are sent, in seconds. Range: 0 to 10.
Default: 5.
action syslog (Optional) Displays a system message when a loop is detected.
source-port (Optional) Error-disables the source port.
Command Default Loop-detection guard is not enabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Usage Guidelines You can error-disable either the source port or the destination port depending on your requirement. When the
loopdetect command is configured without any of the keywords or variables, the feature is enabled and the
destination port is error-disabled when a loop is detected.We recommend that you error-disable the source
port to better control traffic flow to and from your network.
The loopdetect action syslog command displays only a system message and does not error-disable the
configured port. The no loopdetect action syslog command reverts the system to the last configured option.
Examples The following example shows how to enable loop-detection guard. In this example, the destination
port is error-disabled by default and loop-detect frames are sent at the default time interval of five
seconds:
Device# enable
Device# configure terminal
Device(config)# interface tengigabitethernet 1/0/18
Device(config-if)# loopdetect
The following example shows how to configure the time interval to send loop-detect frames. In this
example, loop-detect frames are sent every 7 seconds and destination port is error-disabled when a
loop is detected:
Device# enable
Device# configure terminal
Device(config)# interface tengigabitethernet 1/0/18
Device(config-if)# loopdetect 7
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
873
Layer 2/3
loopdetect
The following example shows how to enable the feature and only display a system message. There
is no action taken on either the destination port or the source port:
Device# enable
Device# configure terminal
Device(config)# interface tengigabitethernet 1/0/18
Device(config-if)# loopdetect action syslog
The following example shows how to enable the feature and error-disable the source port:
Device# enable
Device# configure terminal
Device(config)# interface tengigabitethernet 1/0/18
Device(config-if)# loopdetect source-port
The following example shows how the no loopdetect action syslog command works. In the first
part of the example, the feature has been configured to error disable the source port (loopdetect
source-port). The feature is then reconfigured to display a system message and not error-disable a
port (loopdetect action syslog). In the last part of the example, the no form of the loopdetect action
syslog command is configured, which causes the system to revert to the last configured option, that
is, to error disable the source port.
Part 1: Error-disabling the source port:
Device# enable
Device# configure terminal
Device(config)# interface twentyfivegigabitethernet 1/0/20
Device(config-if)# loopdetect source-port
Part 2: Reconfiguring to display a system message and not error-disable a port:
Device(config-if)# loopdetect action syslog
Part 3: Using the no form of loopdetect action syslog (see Twe1/0/20 ):
Device(config-if)# no loopdetect action syslog
Device(config-if)# end
Device# show loopdetect
Interface Interval Elapsed-Time Port-to-Errdisbale ACTION
--------- -------- ------------ --------------------- ---------
Twe1/0/1 5 3 errdisable Source Port SYSLOG
Twe1/0/20 5 0 errdisable Source Port ERRDISABLE
Twe2/0/3 5 2 errdisable Dest Port ERRDISABLE
Loopdetect is ENABLED
Related Commands Command Description
show loopdetect Displays details of all the interfaces where loop-detection guard is enabled.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
874
Layer 2/3
mvrp vlan creation
mvrp vlan creation
To enable dynamic VLAN creation on a device using Multiple VLAN Registration Protocol (MVRP), use
the mvrpvlancreationcommand in global configuration mode. To disable dynamic VLAN creation for MVRP,
use the no form of this command.
mvrp vlan creation
no mvrp vlan creation
Syntax Description This command has no arguments or keywords.
Command Default MVRP is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines MVRP dynamic VLAN creation can be used only if Virtual Trunking Protocol (VTP) is in transparent mode.
Examples The following example shows a command sequence enabling MVRP dynamic VLAN creation.
Notice that the device recognizes that the VTP mode is incorrect and rejects the request for dynamic
VLAN creation. Once the VTP mode is changed, MVRP dynamic VLAN creation is allowed.
Device(config)# mvrp vlan creation
%Command Rejected: VTP is in non-transparent (server) mode.
Device(config)# vtp mode transparent
Setting device to VTP TRANSPARENT mode.
Device(config)# mvrp vlan creation
%VLAN now may be dynamically created via MVRP/
Related Commands Command Description
mvrp global Enables MVRP globally on a device.
vtp mode Sets the mode for VTP mode on the device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
875
Layer 2/3
mvrp registration
mvrp registration
To set the registrars in a Multiple Registration Protocol (MRP) Attribute Declaration (MAD) instance associated
with an interface, use the mvrpregistrationcommand in global configuration mode. To disable the registrars,
use the no form of this command.
mvrp registration {normal | fixed | forbidden}
no mvrp registration
Syntax Description normal Registrar responds normally to incoming Multiple VLAN Registration Protocol (MVRP)
messages. Normal is the default state.
fixed Registrar ignores all incoming MVRP messages and remains in the IN state.
forbidden Registrar ignores all incoming MVRP messages and remains in the EMPTY (MT) state.
Command Default Registrars are set to the normal state.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines The mvrpregistration command is operational only if MVRP is configured on an interface.
The nomvrpregistration command sets the registrar state to the default (normal).
This command can be used to set the registrar in a MAD instance associated with an interface to one of the
three states. This command is effective only if MVRP is operational on the interface.
Given that up to 4094 VLANs can be configured on a trunk port, there may be up to 4094 Advanced Services
Module (ASM) and Route Switch Module (RSM) pairs in a MAD instance associated with that interface.
Examples The following example sets a fixed, forbidden, and normal registrar on a MAD instance:
Device(config)# mvrp global
%MVRP is now globally enabled. MVRP is operational on IEEE 802.1q trunk ports only.
Device(config)# interface fastethernet2/1
Device(config-if)# mvrp registration fixed
Device(config-if)# interface fastethernet2/2
Device(config-if)# mvrp registration forbidden
Device(config-if)# interface fastethernet2/3
Device(config-if)# no mvrp registration
Related Commands Command Description
clear mvrp statistics Clears MVRP-related statistics recorded on one or all MVRP-enabled ports.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
876
Layer 2/3
mvrp registration
Command Description
debug mvrp Displays MVRP debugging information.
mvrp global Enables MVRP globally on a device and on a particular interface.
mvrp mac-learning auto Enables automatic learning of MAC table entries by MVRP.
mvrp timer Sets period timers that are used in MRP on a given interface.
mvrp vlan create Enables an MVRP dynamic VLAN.
show mvrp interface Displays details of the administrative and operational MVRP states of all or
one particular IEEE 802.1Q trunk port in the device.
show mvrp summary Displays the MVRP configuration at the device level.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
877
Layer 2/3
mvrp timer
mvrp timer
To set period timers that are used in Multiple VLAN Registration Protocol (MVRP) on a given interface, use
the mvrp timer command in interface configuration mode. To remove the timer value, use the no form of
this command.
mvrp timer {join | leave | leave-all | periodic} [centiseconds]
no mvrp timer
Syntax Description join Specifies the time interval between two transmit opportunities that are applied to the Applicant
State Machine (ASMs).
leave Specifies the duration time before a registrar is moved to EMPTY (MT) state from leave-all
(LV) state.
leave-all Specifies the time it takes for a LeaveAll timer to expire.
periodic Sets the timer value to periodic, a fixed value of 100 centiseconds.
centiseconds Timer value measured in centiseconds.
• Join timer value range is 20 to 10000000.
• Leave timer value range is 60 to 10000000.
• LeaveAll timer value range is 10000 and 10000000.
• Periodic timer value is fixed at 100 centiseconds.
Command Default Join timer value: 20 centiseconds
Leave timer value: 60 centiseconds
LeaveAll timer value: 10000 centiseconds
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines The nomvrptimer command resets the timer value to the default value.
Examples The following example sets the timer levels on an interface:
Device(config)# mvrp global
%MVRP is now globally enabled. MVRP is operational on IEE 802.1q trunk ports.
Device(config)# interface GigabitEthernet 6/1
Device(config-if)# mvrp timer join 30
Device(config-if)# mvrp timer leave 70
Device(config-if)# mvrp timer leaveAll 15000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
878
Layer 2/3
mvrp timer
Related Commands Command Description
clear mvrp statistics Clears MVRP-related statistics recorded on one or all MVRP enabled ports.
debug mvrp Displays MVRP debugging information.
mvrp global Enables MVRP globally on a device and on a particular interface.
mvrp mac-learning auto Enables automatic learning of MAC table entries by MVRP.
mvrp registration Sets the registrars in a MAD instance associated with an interface.
mvrp vlan create Enables an MVRP dynamic VLAN.
show mvrp interface Displays details of the administrative and operational MVRP states of all or
one particular IEEE 802.1q trunk port in the device.
show mvrp summary Displays the MVRP configuration at the device level.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
879
Layer 2/3
name (MST)
name (MST)
To set the name of a Multiple Spanning Tree (MST) region, use the name command in MST configuration
submode. To return to the default name, use the no form of this command.
name name
no name name
Syntax Description name Name to give the MST region. It can be any string with a maximum length of 32 characters.
Command Modes MST configuration (config-mst)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Two or more devices with the same VLAN mapping and configuration version number are considered to be
in different MST regions if the region names are different.
Note Be careful when using the name command to set the name of an MST region. If you make a mistake, you can
put the device in a different region. The configuration name is a case-sensitive parameter.
Examples This example shows how to name a region:
Device(config)# spanning-tree mst configuration
Device(config-mst)# name Cisco
Device(config-mst)#
Related Commands Command Description
instance Maps a VLAN or a set of VLANs to an MST instance.
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.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
880
Layer 2/3
no ptp enable
no ptp enable
To disable PTP on an interface, use the no ptp enable command in interface configuration mode.
To re-enable PTP on the same interface, use the ptp enable command in interface configuration mode.
no ptp enable
ptp enable
Syntax Description This command has no aruguments or keywords.
Command Default PTP is enabled on all the ports, by default.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples This example shows how to disable PTP on an interface:
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# no ptp enable
Related Commands Command Description
ptp (interface) Configures PTP on interfaces.
ptp profile dot1as Enables Generalized Precision Time Protocol (gPTP)
globally.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
881
Layer 2/3
pagp learn-method
pagp learn-method
To learn the source address of incoming packets received from an EtherChannel port, use the pagp
learn-method command in interface configuration mode. To return to the default setting, use the no form of
this command.
pagp learn-method {aggregation-port | physical-port}
no pagp learn-method
Syntax Description aggregation-port Specifies address learning on the logical port channel. The device sends packets to the
source using any port in the EtherChannel. This setting is the default. With
aggregation-port learning, it is not important on which physical port the packet arrives.
physical-port Specifies address learning on the physical port within the EtherChannel. The device
sends packets to the source using the same port in the EtherChannel from which it
learned the source address. The other end of the channel uses the same port in the channel
for a particular destination MAC or IP address.
Command Default The default is aggregation-port (logical port channel).
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The learn method must be configured the same at both ends of the link.
The device supports address learning only on aggregate ports even though the physical-port keyword is
provided in the command-line interface (CLI). The pagp learn-method and the pagp port-priority commands
in interface configuration mode have no effect on the device hardware, but they are required for PAgP
interoperability with devices that only support address learning by physical ports.
When the link partner to the device is a physical learner, we recommend that you configure the device as a
physical-port learner by using the pagp learn-method physical-port command in interface configuration
mode. We also recommend that you set the load-distribution method based on the source MAC address by
using the port-channel load-balance src-mac command in global configuration mode. Use the pagp
learn-method command in interface configuration mode only in this situation.
This example shows how to set the learning method to learn the address on the physical port within
the EtherChannel:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 2
Device(config-if)# pagp learn-method physical-port
This example shows how to set the learning method to learn the address on the port channel within
the EtherChannel:
Device> enable
Device# configure terminal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
882
Layer 2/3
pagp learn-method
Device(config)# interface port-channel 2
Device(config-if)# pagp learn-method aggregation-port
You can verify your settings by entering either the show running-config command in privileged
EXEC mode or the show pagp channel-group-number internal command in privileged EXEC
mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
883
Layer 2/3
pagp port-priority
pagp port-priority
To select a port over which all Port Aggregation Protocol (PAgP) traffic through the EtherChannel is sent,
use the pagp port-priority command in interface configuration mode. If all unused ports in the EtherChannel
are in hot-standby mode, they can be placed into operation if the currently selected port and link fails. To
return to the default setting, use the no form of this command.
pagp port-priority priority
no pagp port-priority
Syntax Description priority Priority number. The range is from 0 to 255.
Command Default The default is 128.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The physical port with the highest priority that is operational and has membership in the same EtherChannel
is the one selected for PAgP transmission.
The device supports address learning only on aggregate ports even though the physical-port keyword is
provided in the command-line interface (CLI). The pagp learn-method and the pagp port-priority commands
in interface configuration mode have no effect on the device hardware, but they are required for PAgP
interoperability with devices that only support address learning by physical ports, such as the Catalyst 1900
switch.
When the link partner to the device is a physical learner, we recommend that you configure the device as a
physical-port learner by using the pagp learn-method physical-port command in interface configuration
mode. We also recommend that you set the load-distribution method based on the source MAC address by
using the port-channel load-balance src-mac command in global configuration mode. Use the pagp
learn-method command in interface configuration mode only in this situation.
This example shows how to set the port priority to 200:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# pagp port-priority 200
You can verify your setting by entering the show running-config command in privileged EXEC
mode or the show pagp channel-group-number internal command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
884
Layer 2/3
peer (PTP)
peer (PTP)
To connect to a peer Precision Time Protocol-aware (PTP-aware) device, use the peer command in property
transport sub-configuration mode.
peer { ip ip_address | vrf word ip ip_address }
Syntax Description ip ip_address IP address of a peer PTP device.
vrf word Default virtual routing and forwarding (VRF) or
user-defined VRF.
Command Default None
Command Modes Property transport configuration (config-property-transport)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines You must configure the PTP-property name using the ptp property command and configure a unicast IPv4
connection from a loopback interface using the transport unicast ipv4 local loopback command before
connecting to a peer PTP-aware device.
Examples The following example shows how to connect to a peer PTP-aware device:
Device> enable
Device# configure terminal
Device(config)# ptp property cisco1
Device(config-property)# transport unicast ipv4 local loopback 0
Device(config-property-transport)# peer ip 192.0.2.1
Device(config-property-transport)# end
Related Commands Command Description
ptp dot1as extend property Extends IEEE 802.1AS profile to a PTP property name.
ptp property Sets the PTP property name.
transport unicast ipv4 local loopback Configures a unicast IPv4 connection from a loopback interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
885
Layer 2/3
policy-map
policy-map
To enter policy-map configuration mode and create or modify a policy map that can be attached to one or
more interfaces to specify a service policy, use the policy-mapcommand in global configuration mode. To
delete a policy map, use the no form of this command.
policy-map [ type { access-control | control subscriber | packet-service | performance-monitor
}] policy-map name
Syntax Description type (Optional) Specifies the policy-map type.
access-control (Optional) Enables the access-control specific policy map.
control subscriber (Optional) Enables subscriber control policy domain.
packet-service (Optional) Enables packet service policy map.
performance-monitor (Optional) Enables policy map for the performance monitoring feature.
policy-map name Specifies the policy map.
Command Default The policy map is not configured.
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration (config)
Usage Guidelines Use the policy-map command to specify the name of the policy map to create (add or modify) before you
configure policies for classes whose match criteria are defined in a class map with the class-map and match
commands.
Note You can configure class policies in a policy map only if the classes have match criteria defined for them.
Note Because you can configure a maximum of 64 class maps, a policy map cannot contain more than 64 class
policies.
A single policy map can be attached concurrently to more than one interface. Except as noted, when you
attempt to attach a policy map to an interface, the attempt is denied if the available bandwidth on the interface
cannot accommodate the total bandwidth requested by the multiple policies. In such cases, if the policy map
is already attached to other interfaces, the map is removed.
Example:
The following is sample output from the policy-map command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
886
Layer 2/3
policy-map
Device# policy-map AVB-Output-Child-Policy
policy-map AVB-Output-Child-Policy
class VOIP-PRIORITY-QUEUE
bandwidth remaining percent 30
queue-buffers ratio 10
class MULTIMEDIA-CONFERENCING-STREAMING-QUEUE
bandwidth remaining percent 15
queue-limit dscp AF41 percent 80
queue-limit dscp AF31 percent 80
queue-limit dscp AF42 percent 90
queue-limit dscp AF32 percent 90
queue-buffers ratio 10
class TRANSACTIONAL-DATA-QUEUE
bandwidth remaining percent 15
queue-limit dscp AF21 percent 80
queue-limit dscp AF22 percent 90
queue-buffers ratio 10
class BULK-SCAVENGER-DATA-QUEUE
bandwidth remaining percent 15
queue-limit dscp AF11 percent 80
queue-limit dscp AF12 percent 90
queue-limit dscp CS1 percent 80
queue-buffers ratio 15
class class-default
bandwidth remaining percent 25
queue-buffers ratio 25
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
887
Layer 2/3
port-channel
port-channel
To convert the auto created EtherChannel into a manual channel and adding configuration on the EtherChannel,
use the port-channel command in privileged EXEC mode.
port-channel {channel-group-number persistent | persistent }
Syntax Description channel-group-number Channel group number.
The range is 1 to 128.
persistent Converts the auto created EtherChannel into a manual channel and allows you to
add configuration on the EtherChannel.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can use the show etherchannel summary command in privileged EXEC mode to display the EtherChannel
information.
Examples This example shows how to convert the auto created EtherChannel into a manual channel:
Device> enable
Device# port-channel 1 persistent
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
888
Layer 2/3
port-channel auto
port-channel auto
To enable the auto-LAG feature on a switch globally, use the port-channel auto command in global
configuration mode. To disable the auto-LAG feature on the switch globally, use no form of this command.
port-channel auto
no port-channel auto
Command Default By default, the auto-LAG feature is disabled globally and is enabled on all port interfaces.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can use the show etherchannel auto command in privileged EXEC mode to verify if the EtherChannel
was created automatically.
Examples This example shows how to enable the auto-LAG feature on the switch:
Device> enable
Device# configure terminal
Device(config)# port-channel auto
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
889
Layer 2/3
port-channel load-balance
port-channel load-balance
To set the load-distribution method among the ports in the EtherChannel, use the port-channel load-balance
command in global configuration mode. To reset the load-balancing mechanism to the default setting, use the
no form of this command.
port-channel load-balance {dst-ip | dst-mac | dst-mixed-ip-port | dst-port | extended | src-dst-ip |
src-dst-mac | src-dst-mixed-ip-port | src-dst-port | src-ip | src-mac | src-mixed-ip-port | src-port}
no port-channel load-balance
Syntax Description dst-ip Specifies load distribution based on the destination host IP address.
dst-mac Specifies load distribution based on the destination host MAC address. Packets to
the same destination are sent on the same port, but packets to different destinations
are sent on different ports in the channel.
dst-mixed-ip-port Specifies load distribution based on the destination IPv4 or IPv6 address and the
TCP/UDP (Layer 4) port number.
dst-port Specifies load distribution based on the destination TCP/UDP (Layer 4) port number
for both IPv4 and IPv6.
extended Sets extended load balance methods among the ports in the EtherChannel.
src-dst-ip Specifies load distribution based on the source and destination host IP address.
src-dst-mac Specifies load distribution based on the source and destination host MAC address.
src-dst-mixed-ip-port Specifies load distribution based on the source and destination host IP address and
TCP/UDP (layer 4) port number.
src-dst-port Specifies load distribution based on the source and destination TCP/UDP (Layer 4)
port number.
src-ip Specifies load distribution based on the source host IP address.
src-mac Specifies load distribution based on the source MAC address. Packets from different
hosts use different ports in the channel, but packets from the same host use the same
port.
src-mixed-ip-port Specifies load distribution based on the source host IP address and TCP/UDP (Layer
4) port number.
src-port Specifies load distribution based on the TCP/UDP (Layer 4) port number.
Command Default The default value is src-mac.
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
890
Layer 2/3
port-channel load-balance
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can verify your setting by entering either the show running-config command in privileged EXEC mode
or the show etherchannel load-balance command in privileged EXEC mode.
Examples The following example shows how to set the load-distribution method to dst-mac:
Device> enable
Device# configure terminal
Device(config)# port-channel load-balance dst-mac
Related Commands Command Description
show etherchannel load-balance Displays information about EtherChannel load balancing.
show running-config Displays the running configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
891
Layer 2/3
port-channel load-balance extended
port-channel load-balance extended
To set combinations of load-distribution methods among the ports in the EtherChannel, use the port-channel
load-balance extended command in global configuration mode. To reset the extended load-balancing
mechanism to the default setting, use the no form of this command.
port-channel load-balance extended{dst-ip | dst-mac | dst-port | ipv6-label | l3-proto | src-ip | src-mac
| src-port}
no port-channel load-balance extended
Syntax Description dst-ip Specifies load distribution based on the destination host IP address.
dst-mac Specifies load distribution based on the destination host MAC address. Packets to the same
destination are sent on the same port, but packets to different destinations are sent on different
ports in the channel.
dst-port Specifies load distribution based on the destination TCP/UDP (Layer 4) port number for both
IPv4 and IPv6.
ipv6-label Specifies load distribution based on the source MAC address and IPv6 flow label.
l3-proto Specifies load distribution based on the source MAC address and Layer 3 protocols.
src-ip Specifies load distribution based on the source host IP address.
src-mac Specifies load distribution based on the source MAC address. Packets from different hosts use
different ports in the channel, but packets from the same host use the same port.
src-port Specifies load distribution based on the TCP/UDP (Layer 4) port number.
Command Default The default is src-mac.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Amsterdam 17.3.x The command was modified. You
have to mandatorily configure
atleast one of the keywords for the
port-channel load-balance
extended command.
Usage Guidelines You can verify your setting by entering either the show running-config command in privileged EXEC mode
or the show etherchannel load-balance command in privileged EXEC mode.
Examples This example shows how to set the extended load-distribution method:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
892
Layer 2/3
port-channel load-balance extended
Device> enable
Device# configure terminal
Device(config)# port-channel load-balance extended dst-ip dst-mac src-ip
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
893
Layer 2/3
port-channel min-links
port-channel min-links
To define the minimum number of LACP ports that must be bundled in the link-up state and bundled in the
EtherChannel in order that a port channel becomes active, use the port-channel min-links command in
interface configuration mode. To return to the default setting, use the no form of this command.
port-channel min-links min_links_number
no port-channel min-links
Syntax Description min_links_number The minimum number of active LACP ports in the port channel.
The range is 2 to 8 if the port channel number is 128 or lesser and the range is 2 to 4
if the port channel number is 129 or greater.
The default is 1.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active,
and up to eight ports can be in hot-standby mode. When there are more than eight ports in an LACP channel
group, the device on the controlling end of the link uses port priorities to determine which ports are bundled
into the channel and which ports are put in hot-standby mode. Port priorities on the other device (the
noncontrolling end of the link) are ignored.
The port-channel min-links command must specify a number a less than the number specified by the lacp
max-bundle command.
Use the show etherchannel summary command in privileged EXEC mode to see which ports are in the
hot-standby mode (denoted with an H port-state flag in the output display).
This example shows how to specify a minimum of three active LACP ports before port channel 2
becomes active:
Device> enable
Device# configure terminal
Device(config)# interface port-channel 2
Device(config-if)# port-channel min-links 3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
894
Layer 2/3
ptp dot1as extend property
ptp dot1as extend property
To extend IEEE 802.1AS profile to a Precision Time Protocol-property (PTP-property) name, use the ptp
dot1as extend property command in global configuration mode.
ptp dot1as extend property word
Syntax Description word PTP property name
Command Default None
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following example shows how to extend IEEE 802.1AS profile to a PTP-property name:
Device> enable
Device# configure terminal
Device(config)# ptp property cisco1
Device(config-property)# transport unicast ipv4 local loopback 0
Device(config-property-transport)# peer ip 192.0.2.1
Device(config-property-transport)# end
Device# configure terminal
Device(config)# ptp dot1as extend property cisco1
Device(config)# end
Related Commands Command Description
peer Connects to a peer PTP-aware device.
ptp property Sets the PTP property name.
source ip interface (Optional) Configures the source IP interface.
transport unicast ipv4 local loopback Configures a unicast IPv4 connection from a loopback interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
895
Layer 2/3
ptp ip dscp
ptp ip dscp
To configure IP DSCP value for PTP messages, use the ptp ip dscp command in global configuration mode.
To remove the configuration, use the no form of this command.
ptp ip dscp value message { event | general }
no ptp ip dscp value message { event | general }
Syntax Description value IP DSCP value. The range is from 0 to 63.
event Configures IP DSCP value for PTP event messages.
general Configures IP DSCP value for PTP general messages.
Command Default PTP uses 0x2f for general messages and 0x3b for event messages
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.1 This command was introduced.
Usage Guidelines Use this command for IEEE 1588 PTP profiles in IPv4 UDP transport mode only.
Examples The following example shows how to configure IP DSCP value for PTP messages:
Device> enable
Device# configure terminal
Device(config)# ptp transport-protocol ipv4 udp
Device(config)# ptp mode boundary delay-req
Device(config)# interface range gigabitethernet1/0/1-gigabitethernet1/0/2
Device(config-if-range)# ptp sync interval -3
Device(config-if-range)# ptp delay-req interval -3
Device(config-if-range)# exit
Device(config)# ptp ip dscp 46 message general
Device(config)# ptp ip dscp 46 message event
Device(config)# end
Related Commands Command Description
ptp mode boundary delay-req Configures the device for boundary clock mode using the peer delay request
mechanism.
ptp sync interval Configures the interval between PTP synchronization messages on the
interface range.
ptp delay-req interval Configures the logarithmic mean interval allowed between PTP delay request
messages when the port is in the master state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
896
Layer 2/3
ptp priority1 value
ptp priority1 value
To specify the priority 1 value to use when advertising a PTP clock, use the ptp priority1 value command
in global configuration mode.
ptp priority1 value
Syntax Description value Specifies the priority 1 number to use for this clock.
The range is 0 to 255. The default value is 128.
Note If the value of priority1 is configured to 255, the clock cannot become as
Grandmaster.
Command Default Default is 128.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was
introduced.
Example
This example shows how to specify the priority1 value:
Device> enable
Device# configure terminal
Device(config)# ptp priority1 120
Related Commands Command Description
ptp priority2 value Specifies the priority 2 number to use for this clock.
no ptp enable Disables PTP on an interface.
ptp profile dot1as Enables Generalized Precision Time Protocol (gPTP)
globally.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
897
Layer 2/3
ptp priority2 value
ptp priority2 value
To specify the priority 2 number to use when advertising a PTP clock, use the ptp priority2 value command
in global configuration mode
ptp priority2 value
Syntax Description value Specifies the priority 2 number to use for this clock.
The range is 0 to 255. The default value is 128.
Command Default Default is 128.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was
introduced.
Example
This example shows how to specify the priority2 value:
Device> enable
Device# configure terminal
Device(config)# ptp priority 2 120
Related Commands Command Description
ptp priority1 value Specifies the priority 1 number to use for this clock.
no ptp enable Disables PTP on an interface.
ptp profile dot1as Enables Generalized Precision Time Protocol (gPTP)
globally.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
898
Layer 2/3
ptp profile dot1as
ptp profile dot1as
To enable Generalized Precision Time Protocol (gPTP) globally, use the ptp profile dot1as command in
global configuration mode. To disable gPTP, use the no form of the command.
ptp profile dot1as
no ptp profile dot1as
Command Default PTP is disabled on interfaces.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples This example shows how to enable gPTP:
Device> enable
Device# configure terminal
Device(config)# ptp profile dot1as
Related Commands Command Description
ptp (interface) Configures PTP on interfaces.
no ptp enable Disables PTP on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
899
Layer 2/3
ptp property
ptp property
To set the Precision Time Protocol-property (PTP-property) name, use the ptp property command in global
configuration mode. To remove the PTP property name, use the no form of this command.
ptp property word
no ptp property word
Syntax Description word PTP-property name.
Command Default None
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines You can configure more than one IPv4 unicast connection that connects to a different boundary clock under
the same property name.
Examples The following example shows how to set the PTP-property name:
Device> enable
Device# configure terminal
Device(config)# ptp property cisco1
Device(config-property)#
Related Commands Command Description
peer Connects to a peer PTP-aware device.
ptp dot1as extend property Extends IEEE 802.1AS profile to a PTP property name.
source ip interface (Optional) Configures the source IP interface.
transport unicast ipv4 local loopback Configures a unicast IPv4 connection from a loopback interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
900
Layer 2/3
ptp role primary
ptp role primary
To set an interface permanently as primary (master), use the ptp role primary command in interface
configuration mode. To remove an interface as primary (master), use the no ptp role primary command.
ptp role primary
no ptp role primary
Command Default Interface is set as either primary (master) or secondary (slave) based on Best Master Clock Algorithm (BMCA)
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Setting a port permanently ensures that the port remain as a primary (master) even if a clock connected to the
port can be elected as grandmaster clock.
Note The command ptp role primary must be used only on ports that are used as end nodes on a network that
are connected to devices requiring synchronization.
Use the show ptp port interface_id command to verify if the port is set as primary (master).
Examples The following example shows how to set an interface permanently as primary (master):
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet1/0/1
Device(config-if)# ptp role primary
Related Commands Command Description
show ptp port interface_id Displays the details of the
port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
901
Layer 2/3
rep admin vlan
rep admin vlan
To configure a Resilient Ethernet Protocol (REP) administrative VLAN for the REP to transmit hardware
flood layer (HFL) messages, use the rep admin vlan command in global configuration mode. To return to
the default configuration with VLAN 1 as the administrative VLAN, use the no form of this command.
rep admin vlan vlan-id segment segment-id
no rep admin vlan vlan-id segment segment-id
Syntax Description vlan-id 48-bit static MAC address.
segment configures administrative VLAN for an REP
segment.
segment-id specifies the segment for which the admin
VLAN has been assigned. Segment id number
ranges from 1-1024
Command Default
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Amsterdam 17.2.1 The segment keyword was
introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
902
Layer 2/3
rep block port
rep block port
To configure Resilient Ethernet Protocol (REP) VLAN load balancing on a REP primary edge port, use the
rep block port command in interface configuration mode. To return to the default configuration with VLAN
1 as the administrative VLAN, use the no form of this command.
rep block port {id port-id | neighbor-offset | preferred} vlan {vlan-list | all}
no rep block port {id port-id | neighbor-offset | preferred}
Syntax Description id port-id Specifies the VLAN blocking alternate port by entering the unique port ID, which is
automatically generated when REP is enabled. The REP port ID is a 16-character hexadecimal
value.
neighbor-offset VLAN blocking alternate port by entering the offset number of a neighbor. The range is
from -256 to +256. A value of 0 is invalid.
preferred Selects the regular segment port previously identified as the preferred alternate port for
VLAN load balancing.
vlan Identifies the VLANs to be blocked.
vlan-list VLAN ID or range of VLAN IDs to be displayed. Enter a VLAN ID from 1 to 4094, or a
range or sequence of VLANs (such as 1-3, 22, and 41-44) to be blocked.
all Blocks all the VLANs.
Command Default The default behavior after you enter the rep preempt segment command in privileged EXEC (for manual
preemption) is to block all the VLANs at the primary edge port. This behavior remains until you configure
the rep block port command.
If the primary edge port cannot determine which port is to be the alternate port, the default action is no
preemption and no VLAN load balancing.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you select an alternate port by entering an offset number, this number identifies the downstream neighbor
port of an edge port. The primary edge port has an offset number of 1; positive numbers above 1 identify
downstream neighbors of the primary edge port. Negative numbers identify the secondary edge port (offset
number -1) and its downstream neighbors.
Note Do not enter an offset value of 1 because that is the offset number of the primary edge port itself.
If you have configured a preempt delay time by entering the rep preempt delay seconds command in interface
configuration mode and a link failure and recovery occurs, VLAN load balancing begins after the configured
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
903
Layer 2/3
rep block port
preemption time period elapses without another link failure. The alternate port specified in the load-balancing
configuration blocks the configured VLANs and unblocks all the other segment ports. If the primary edge
port cannot determine the alternate port for VLAN balancing, the default action is no preemption.
Each port in a segment has a unique port ID. To determine the port ID of a port, enter the show interfaces
interface-id rep detail command in privileged EXEC mode.
Examples The following example shows how to configure REP VLAN load balancing:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep block port id 0009001818D68700 vlan 1-100
Related Commands Command Description
show interfaces rep Displays detailed REP configuration and status for all the interfaces or the
detail specified interface, including the administrative VLAN.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
904
Layer 2/3
rep lsl-age-timer
rep lsl-age-timer
To configure the Resilient Ethernet Protocol (REP) link status layer (LSL) age-out timer value, use the rep
lsl-age-timer command in interface configuration mode. To restore the default age-out timer value, use the
no form of this command.
rep lsl-age-timer milliseconds
no rep lsl-age-timer milliseconds
Syntax Description milliseconds REP LSL age-out timer value, in milliseconds (ms). The range is from 120 to 10000 in multiples
of 40.
Command Default The default LSL age-out timer value is 5 ms.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines While configuring REP configurable timers, we recommend that you configure the REP LSL number of retries
first and then configure the REP LSL age-out timer value.
Examples The following example shows how to configure a REP LSL age-out timer value:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 1 edge primary
Device(config-if)# rep lsl-age-timer 2000
Related Commands Command Description
interface interface-type interface-name Specifies a physical interface or port channel to receive STCNs.
rep segment Enables REP on an interface and assigns a segment ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
905
Layer 2/3
rep lsl-retries
rep lsl-retries
To configure the REP link status layer (LSL) number of retries, use the rep lsl-retries command in interface
configuration mode. To restore the default number of retries, use the no form of this command.
rep lsl-retries number-of-retries
no rep lsl-retries number-of-retries
Syntax Description number-of-retries Number of LSL retries. The range of retries is from 3 to 10.
Command Default The default number of LSL retries is 5.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced
Usage Guidelines The rep lsl-retries command is used to configure the number of retries before the REP link is disabled. While
configuring REP configurable timers, we recommend that you configure the REP LSL number of retries first
and then configure the REP LSL age-out timer value.
The following example shows how to configure REP LSL retries.
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 2 edge primary
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
906
Layer 2/3
rep preempt delay
rep preempt delay
To configure a waiting period after a segment port failure and recovery before Resilient Ethernet Protocol
(REP) VLAN load balancing is triggered, use the rep preempt delay command in interface configuration
mode. To remove the configured delay, use the no form of this command.
rep preempt delay seconds
no rep preempt delay
Syntax Description seconds Number of seconds to delay REP preemption. The range is from 15 to 300 seconds. The default is
manual preemption without delay.
Command Default REP preemption delay is not set. The default is manual preemption without delay.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Enter this command on the REP primary edge port.
Enter this command and configure a preempt time delay for VLAN load balancing to be automatically triggered
after a link failure and recovery.
If VLAN load balancing is configured after a segment port failure and recovery, the REP primary edge port
starts a delay timer before VLAN load balancing occurs. Note that the timer restarts after each link failure.
When the timer expires, the REP primary edge port alerts the alternate port to perform VLAN load balancing
(configured by using the rep block port command in interface configuration mode) and prepares the segment
for the new topology. The configured VLAN list is blocked at the alternate port, and all other VLANs are
blocked at the primary edge port.
You can verify your settings by entering the show interfaces rep command.
Examples The following example shows how to configure a REP preemption time delay of 100 seconds on the
primary edge port:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep preempt delay 100
Related Commands Command Description
rep block port Configures VLAN load balancing.
show interfaces rep Displays detailed REP configuration and status for all the interfaces or the
detail specified interface, including the administrative VLAN.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
907
Layer 2/3
rep preempt segment
rep preempt segment
To manually start Resilient Ethernet Protocol (REP) VLAN load balancing on a segment, use the rep preempt
segment command in privileged EXEC mode.
rep preempt segment segment-id
Syntax Description segment-id ID of the REP segment. The range is from 1 to 1024.
Command Default Manual preemption is the default behavior.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Enter this command on the segment, which has the primary edge port on the device.
Ensure that all the other segment configuratios are completed before setting preemption for VLAN load
balancing. When you enter the rep preempt segment segment-id command, a confirmation message appears
before the command is executed because preemption for VLAN load balancing can disrupt the network.
If you do not enter the rep preempt delay seconds command in interface configuration mode on the primary
edge port to configure a preemption time delay, the default configuration is to manually trigger VLAN load
balancing on the segment.
Enter the show rep topology command in privileged EXEC mode to see which port in the segment is the
primary edge port.
If you do not configure VLAN load balancing, entering the rep preempt segment segment-id command
results in the default behavior, that is, the primary edge port blocks all the VLANs.
You can configure VLAN load balancing by entering the rep block port command in interface configuration
mode on the REP primary edge port before you manually start preemption.
Examples The following example shows how to manually trigger REP preemption on segment 100:
Device> enable
Device# rep preempt segment 100
Related Commands Command Description
rep block port Configures VLAN load balancing.
rep preempt Configures a waiting period after a segment port failure and recovery before REP VLAN
delay load balancing is triggered.
show rep Displays REP topology information for a segment or for all the segments.
topology
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
908
Layer 2/3
rep segment
rep segment
To enable Resilient Ethernet Protocol (REP) on an interface and to assign a segment ID to the interface, use
the rep segment command in interface configuration mode. To disable REP on the interface, use the no form
of this command.
rep segment segment-id [edge [no-neighbor] [primary]] [preferred]
no rep segment
Syntax Description segment-id Segment for which REP is enabled. Assign a segment ID to the interface. The range is from
1 to 1024.
edge (Optional) Configures the port as an edge port. Each segment has only two edge ports.
no-neighbor (Optional) Specifies the segment edge as one with no external REP neighbor.
primary (Optional) Specifies that the port is the primary edge port where you can configure VLAN
load balancing. A segment has only one primary edge port.
preferred (Optional) Specifies that the port is the preferred alternate port or the preferred port for VLAN
load balancing.
Note Configuring a port as a preferred port does not guarantee that it becomes the
alternate port; it merely gives it a slight edge among equal contenders. The
alternate port is usually a previously failed port.
Command Default REP is disabled on the interface.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines REP ports must be a Layer 2 IEEE 802.1Q port or a 802.1AD port. You must configure two edge ports on
each REP segment, a primary edge port and a secondary edge port.
If REP is enabled on two ports on a device, both the ports must be either regular segment ports or edge ports.
REP ports follow these rules:
• If only one port on a device is configured in a segment, that port should be an edge port.
• If two ports on a device belong to the same segment, both the ports must be regular segment ports.
• If two ports on a device belong to the same segment, and one is configured as an edge port and one as a
regular segment port (a misconfiguration), the edge port is treated as a regular segment port.
Caution REP interfaces come up in a blocked state and remain in a blocked state until notified that it is safe to unblock.
Be aware of this to avoid sudden connection losses.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
909
Layer 2/3
rep segment
When REP is enabled on an interface, the default is for that port to be a regular segment port.
Examples The following example shows how to enable REP on a regular (nonedge) segment port:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 100
The following example shows how to enable REP on a port and identify the port as the REP primary
edge port:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 100 edge primary
The following example shows how to enable REP on a port and identify the port as the REP secondary
edge port:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 100 edge
The following example shows how to enable REP as an edge no-neighbor port:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep segment 1 edge no-neighbor primary
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
910
Layer 2/3
rep stcn
rep stcn
To configure a Resilient Ethernet Protocol (REP) edge port to send segment topology change notifications
(STCNs) to another interface or to other segments, use the rep stcn command in interface configuration mode.
To disable the task of sending STCNs to the interface or to the segment, use the no form of this command.
rep stcn {interface interface-id | segment segment-id-list}
no rep stcn {interface | segment}
Syntax Description interface interface-id Specifies a physical interface or port channel to receive STCNs.
segment segment-id-list Specifies one REP segment or a list of REP segments to receive STCNs. The
segment range is from 1 to 1024. You can also configure a sequence of segments,
for example, 3 to 5, 77, 100.
Command Default Transmission of STCNs to other interfaces or segments is disabled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can verify your settings by entering the show interfaces rep detail command in privileged EXEC mode.
Examples The following example shows how to configure a REP edge port to send STCNs to segments 25 to
50:
Device> enable
Device# configure terminal
Device(config)# interface TenGigabitEthernet 4/1
Device(config-if)# rep stcn segment 25-50
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
911
Layer 2/3
revision
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 version Revision number for the configuration; valid values are from 0 to 65535.
Command Default version is 0
Command Modes MST configuration (config-mst)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Devices that have the same configuration but different revision numbers are considered to be part of two
different regions.
Note 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:
Device(config)# spanning-tree mst configuration
Device(config-mst)# revision 5
Device(config-mst)#
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.
show spanning-tree Displays information about the spanning-tree state.
spanning-tree mst configuration Enters MST-configuration submode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
912
Layer 2/3
show avb domain
show avb domain
To display the AVB domain information, use the show avb domain command.
show avb domain
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration mode (#)
Example:
The following is sample output from the show avb domain command:
Device# show avb domain
AVB Class-A
Priority Code Point : 3
VLAN : 2
Core ports : 1
Boundary ports : 67
AVB Class-B
Priority Code Point : 2
VLAN : 2
Core ports : 1
Boundary ports : 67
--------------------------------------------------------------------------------
Interface State Delay PCP VID Information
--------------------------------------------------------------------------------
Te1/0/1 down N/A Oper state not up
Te1/0/2 down N/A Oper state not up
Te1/0/3 down N/A Oper state not up
Te1/0/4 down N/A Oper state not up
Te1/0/5 up N/A Port is not asCapable
Te1/0/6 down N/A Oper state not up
Te1/0/7 down N/A Oper state not up
Te1/0/8 down N/A Oper state not up
Te1/0/9 down N/A Oper state not up
Te1/0/10 down N/A Oper state not up
Te1/0/11 down N/A Oper state not up
Te1/0/12 down N/A Oper state not up
Te1/0/13 down N/A Oper state not up
Te1/0/14 down N/A Oper state not up
Te1/0/15 down N/A Oper state not up
Te1/0/16 down N/A Oper state not up
Te1/0/17 down N/A Oper state not up
Te1/0/18 down N/A Oper state not up
Te1/0/19 up N/A Port is not asCapable
Te1/0/20 down N/A Oper state not up
Te1/0/21 down N/A Oper state not up
Te1/0/22 down N/A Oper state not up
Te1/0/23 up N/A Port is not asCapable
Te1/0/24 down N/A Oper state not up
Te1/0/25 down N/A Oper state not up
Te1/0/26 down N/A Oper state not up
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
913
Layer 2/3
show avb domain
Te1/0/27 down N/A Oper state not up
Te1/0/28 down N/A Oper state not up
Te1/0/29 up N/A Port is not asCapable
Te1/0/30 down N/A Oper state not up
Te1/0/31 down N/A Oper state not up
Te1/0/32 down N/A Oper state not up
Te1/0/33 down N/A Oper state not up
Te1/0/34 down N/A Oper state not up
Te1/0/35 up N/A Port is not asCapable
Te1/0/36 down N/A Oper state not up
Te1/0/37 down N/A Oper state not up
Te1/0/38 down N/A Oper state not up
Te1/0/39 up 507ns
Class- A core 3 2
Class- B core 2 2
Te1/0/40 down N/A Oper state not up
Te1/0/41 down N/A Oper state not up
Te1/0/42 down N/A Oper state not up
Te1/0/43 down N/A Oper state not up
Te1/0/44 down N/A Oper state not up
Te1/0/45 down N/A Oper state not up
Te1/0/46 down N/A Oper state not up
Te1/0/47 down N/A Oper state not up
Te1/0/48 down N/A Oper state not up
Te1/1/1 down N/A Oper state not up
Te1/1/2 down N/A Oper state not up
Te1/1/3 down N/A Oper state not up
Te1/1/4 down N/A Oper state not up
Te1/1/5 down N/A Oper state not up
Te1/1/6 down N/A Oper state not up
Te1/1/7 down N/A Oper state not up
Te1/1/8 down N/A Oper state not up
Te1/1/9 down N/A Oper state not up
Te1/1/10 down N/A Oper state not up
Te1/1/11 down N/A Oper state not up
Te1/1/12 down N/A Oper state not up
Te1/1/13 down N/A Oper state not up
Te1/1/14 down N/A Oper state not up
Te1/1/15 down N/A Oper state not up
Te1/1/16 down N/A Oper state not up
Fo1/1/1 down N/A Oper state not up
Fo1/1/2 down N/A Oper state not up
Fo1/1/3 down N/A Oper state not up
Fo1/1/4 down N/A Oper state not up
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
914
Layer 2/3
show avb streams
show avb streams
To display the AVB stream information, use the show avb streams command.
show avb streams
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration mode (#)
Example:
The following is sample output from the show avb streams command:
Device# show avb streams
Stream ID: 0011.0100.0001:1 Incoming Interface: Te1/1/1
Destination : 91E0.F000.FE00
Class : A
Rank : 1
Bandwidth : 6400 Kbit/s
Outgoing Interfaces:
----------------------------------------------------------------------------
Interface State Time of Last Update Information
----------------------------------------------------------------------------
Te1/1/1 Ready Tue Apr 26 01:25:40.634
Stream ID: 0011.0100.0002:2 Incoming Interface: Te1/1/1
Destination : 91E0.F000.FE01
Class : A
Rank : 1
Bandwidth : 6400 Kbit/s
Outgoing Interfaces:
----------------------------------------------------------------------------
Interface State Time of Last Update Information
----------------------------------------------------------------------------
Te1/1/1 Ready Tue Apr 26 01:25:40.634
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
915
Layer 2/3
show dot1q-tunnel
show dot1q-tunnel
To display information about IEEE 802.1Q tunnel ports, use the show dot1q-tunnel in EXEC mode.
show dot1q-tunnel [interface interface-id]
Syntax Description interface interface-id (Optional) Specifies the interface for which to display IEEE 802.1Q tunneling
information. Valid interfaces include physical ports and port channels.
Command Default None
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Examples The following are examples of output from the show dot1q-tunnel command:
Device# show dot1q-tunnel
dot1q-tunnel mode LAN Port(s)
-----------------------------
Gi1/0/1
Gi1/0/2
Gi1/0/3
Gi1/0/6
Po2
Device# show dot1q-tunnel interface gigabitethernet1/0/1
dot1q-tunnel mode LAN Port(s)
-----------------------------
Gi1/0/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
916
Layer 2/3
show etherchannel
show etherchannel
To display EtherChannel information for a channel, use the show etherchannel command in user EXEC
mode.
show etherchannel [{channel-group-number | {detail | port | port-channel | protocol | summary }}]
| [{detail | load-balance | port | port-channel | protocol | summary}]
Syntax Description channel-group-number (Optional) Channel group number.
The range is 1 to 128.
detail (Optional) Displays detailed EtherChannel information.
load-balance (Optional) Displays the load-balance or frame-distribution
scheme among ports in the port channel.
port (Optional) Displays EtherChannel port information.
port-channel (Optional) Displays port-channel information.
protocol (Optional) Displays the protocol that is being used in the
channel.
summary (Optional) Displays a one-line summary per channel group.
Command Modes User EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not specify a channel group number, all channel groups are displayed.
In the output, the passive port list field is displayed only for Layer 3 port channels. This field means that the
physical port, which is still not up, is configured to be in the channel group (and indirectly is in the only port
channel in the channel group).
This is an example of output from the show etherchannel channel-group-number detail command:
Device> show etherchannel 1 detail
Group state = L2
Ports: 2 Maxports = 16
Port-channels: 1 Max Port-channels = 16
Protocol: LACP
Ports in the group:
-------------------
Port: Gi1/0/1
------------
Port state = Up Mstr In-Bndl
Channel group = 1 Mode = Active Gcchange = -
Port-channel = Po1GC = - Pseudo port-channel = Po1
Port index = 0Load = 0x00 Protocol = LACP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
917
Layer 2/3
show etherchannel
Flags: S - Device is sending Slow LACPDUs F - Device is sending fast LACPDU
A - Device is in active mode. P - Device is in passive mode.
Local information:
LACP port Admin Oper Port Port
Port Flags State Priority Key Key Number State
Gi1/0/1 SA bndl 32768 0x1 0x1 0x101 0x3D
Gi1/0/2 A bndl 32768 0x0 0x1 0x0 0x3D
Age of the port in the current state: 01d:20h:06m:04s
Port-channels in the group:
----------------------
Port-channel: Po1 (Primary Aggregator)
Age of the Port-channel = 01d:20h:20m:26s
Logical slot/port = 10/1 Number of ports = 2
HotStandBy port = null
Port state = Port-channel Ag-Inuse
Protocol = LACP
Ports in the Port-channel:
Index Load Port EC state No of bits
------+------+------+------------------+-----------
0 00 Gi1/0/1 Active 0
0 00 Gi1/0/2 Active 0
Time since last port bundled: 01d:20h:24m:44s Gi1/0/2
This is an example of output from the show etherchannel channel-group-number summary
command:
Device> show etherchannel 1 summary
Flags: D - down P - in port-channel
I - stand-alone s - suspended
H - Hot-standby (LACP only)
R - Layer3 S - Layer2
u - unsuitable for bundling
U - in use f - failed to allocate aggregator
d - default port
Number of channel-groups in use: 1
Number of aggregators: 1
Group Port-channel Protocol Ports
------+-------------+-----------+----------------------------------------
1 Po1(SU) LACP Gi1/0/1(P) Gi1/0/2(P)
This is an example of output from the show etherchannel channel-group-number port-channel
command:
Device> show etherchannel 1 port-channel
Port-channels in the group:
----------------------
Port-channel: Po1 (Primary Aggregator)
------------
Age of the Port-channel = 01d:20h:24m:50s
Logical slot/port = 10/1 Number of ports = 2
Logical slot/port = 10/1 Number of ports = 2
Port state = Port-channel Ag-Inuse
Protocol = LACP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
918
Layer 2/3
show etherchannel
Ports in the Port-channel:
Index Load Port EC state No of bits
------+------+------+------------------+-----------
0 00 Gi1/0/1 Active 0
0 00 Gi1/0/2 Active 0
Time since last port bundled: 01d:20h:24m:44s Gi1/0/2
This is an example of output from show etherchannel protocol command:
Device# show etherchannel protocol
Channel-group listing:
-----------------------
Group: 1
----------
Protocol: LACP
Group: 2
----------
Protocol: PAgP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
919
Layer 2/3
show interfaces rep detail
show interfaces rep detail
To display detailed Resilient Ethernet Protocol (REP) configuration and status for all interfaces or a specified
interface, including the administrative VLAN, use the show interfaces rep detail command in privileged
EXEC mode.
show interfaces [interface-id] rep detail
Syntax Description interface-id (Optional) Physical interface used to display the port ID.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Enter this command on a segment edge port to send STCNs to one or more segments or to an interface.
You can verify your settings by entering the show interfaces rep detail command in privileged EXEC mode.
Examples The following example shows how to display the REP configuration and status for a specified
interface;
Device> enable
Device# show interfaces TenGigabitEthernet4/1 rep detail
TenGigabitEthernet4/1 REP enabled
Segment-id: 3 (Primary Edge)
PortID: 03010015FA66FF80
Preferred flag: No
Operational Link Status: TWO_WAY
Current Key: 02040015FA66FF804050
Port Role: Open
Blocked VLAN: <empty>
Admin-vlan: 1
Preempt Delay Timer: disabled
Configured Load-balancing Block Port: none
Configured Load-balancing Block VLAN: none
STCN Propagate to: none
LSL PDU rx: 999, tx: 652
HFL PDU rx: 0, tx: 0
BPA TLV rx: 500, tx: 4
BPA (STCN, LSL) TLV rx: 0, tx: 0
BPA (STCN, HFL) TLV rx: 0, tx: 0
EPA-ELECTION TLV rx: 6, tx: 5
EPA-COMMAND TLV rx: 0, tx: 0
EPA-INFO TLV rx: 135, tx: 136
Related Commands Command Description
rep admin Configures a REP administrative VLAN for the REP to transmit HFL messages.
vlan
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
920
Layer 2/3
show l2protocol-tunnel
show l2protocol-tunnel
To display information about Layer 2 protocol tunnel ports, use the show l2protocol-tunnel in EXEC mode.
show l2protocol-tunnel [interface interface-id] summary
Syntax Description interface interface-id (Optional) Specifies the interface for which protocol tunneling information appears.
Valid interfaces are physical ports and port channels.
The port-channel range is 1 to 128.
summary (Optional) Displays only Layer 2 protocol summary information.
Command Default None
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines After enabling Layer 2 protocol tunneling on an access or IEEE 802.1Q tunnel port by using the
l2protocol-tunnel interface configuration command, you can configure some or all of these parameters:
• Protocol type to be tunneled
• Shutdown threshold
• Drop threshold
If you enter the show l2protocol-tunnel interface command, only information about the active ports on
which all the parameters are configured appears.
If you enter the show l2protocol-tunnel summary command, only information about the active ports on
which some or all of the parameters are configured appears.
Examples This is an example of output from the show l2protocol-tunnel command:
Device> show l2protocol-tunnel
COS for Encapsulated Packets: 5
Drop Threshold for Encapsulated Packets: 0
Port Protocol Shutdown Drop Encapsulation Decapsulation Drop
Threshold Threshold Counter Counter Counter
---------- -------- --------- --------- ------------- ------------- -------------
Gi3/0/3 --- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
pagp ---- ---- 0 242500
lacp ---- ---- 24268 242640
udld ---- ---- 0 897960
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
921
Layer 2/3
show l2protocol-tunnel
Gi3/0/4 --- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
pagp 1000 ---- 24249 242700
lacp ---- ---- 24256 242660
udld ---- ---- 0 897960
Gi6/0/1 cdp ---- ---- 134482 1344820
--- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
pagp 1000 ---- 0 242500
lacp 500 ---- 0 485320
udld 300 ---- 44899 448980
Gi6/0/2 cdp ---- ---- 134482 1344820
--- ---- ---- ---- ---- ----
--- ---- ---- ---- ---- ----
pagp ---- 1000 0 242700
lacp ---- ---- 0 485220
udld 300 ---- 44899 448980
This is an example of output from the show l2protocol-tunnel summary command:
Device> show l2protocol-tunnel summary
COS for Encapsulated Packets: 5
Drop Threshold for Encapsulated Packets: 0
Port Protocol Shutdown Drop Status
Threshold Threshold
(cdp/stp/vtp) (cdp/stp/vtp)
(pagp/lacp/udld) (pagp/lacp/udld)
------- ------------- ---------------- ---------------- ----------
Gi3/0/2 pagp lacp udld ----/----/---- ----/----/---- up
Gi4/0/3 pagp lacp udld 1000/ 500/---- ----/----/---- up
Gi9/0/1 pagp ---- ---- ----/----/---- 1000/----/---- down
Gi9/0/2 pagp ---- ---- ----/----/---- 1000/----/---- down
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
922
Layer 2/3
show lacp
show lacp
To display Link Aggregation Control Protocol (LACP) channel-group information, use the show lacp command
in user EXEC mode.
show lacp [channel-group-number] {counters | internal | neighbor | sys-id}
Syntax Description channel-group-number (Optional) Channel group number.
The range is 1 to 128.
counters Displays traffic information.
internal Displays internal information.
neighbor Displays neighbor information.
sys-id Displays the system identifier that is being used by LACP. The system identifier
consists of the LACP system priority and the device MAC address.
Command Modes User EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can enter any show lacp command to display the active channel-group information. To display specific
channel information, enter the show lacp command with a channel-group number.
If you do not specify a channel group, information for all channel groups appears.
You can enter the channel-group-number to specify a channel group for all keywords except sys-id.
This is an example of output from the show lacp counters user EXEC command. The table that
follows describes the fields in the display.
Device> show lacp counters
LACPDUs Marker Marker Response LACPDUs
Port Sent Recv Sent Recv Sent Recv Pkts Err
---------------------------------------------------------------------
Channel group:1
Gi2/0/1 19 10 0 0 0 0 0
Gi2/0/2 14 6 0 0 0 0 0
Table 119: show lacp counters Field Descriptions
Field Description
LACPDUs Sent and Recv The number of LACP packets sent and received by a
port.
Marker Sent and Recv The number of LACP marker packets sent and
received by a port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
923
Layer 2/3
show lacp
Field Description
Marker Response Sent and Recv The number of LACP marker response packets sent
and received by a port.
LACPDUs Pkts and Err The number of unknown and illegal packets received
by LACP for a port.
This is an example of output from the show lacp internal command:
Device> show lacp 1 internal
Flags: S - Device is requesting Slow LACPDUs
F - Device is requesting Fast LACPDUs
A - Device is in Active mode P - Device is in Passive mode
Channel group 1
LACP port Admin Oper Port Port
Port Flags State Priority Key Key Number State
Gi2/0/1 SA bndl 32768 0x3 0x3 0x4 0x3D
Gi2/0/2 SA bndl 32768 0x3 0x3 0x5 0x3D
The following table describes the fields in the display:
Table 120: show lacp internal Field Descriptions
Field Description
State State of the specific port. These are the allowed
values:
• – —Port is in an unknown state.
• bndl—Port is attached to an aggregator and
bundled with other ports.
• susp—Port is in a suspended state; it is not
attached to any aggregator.
• hot-sby—Port is in a hot-standby state.
• indiv—Port is incapable of bundling with any
other port.
• indep—Port is in an independent state (not
bundled but able to handle data traffic. In this
case, LACP is not running on the partner port).
• down—Port is down.
LACP Port Priority Port priority setting. LACP uses the port priority to
put ports in standby mode when there is a hardware
limitation that prevents all compatible ports from
aggregating.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
924
Layer 2/3
show lacp
Field Description
Admin Key Administrative key assigned to this port. LACP
automatically generates an administrative key value
as a hexadecimal number. The administrative key
defines the ability of a port to aggregate with other
ports. A port’s ability to aggregate with other ports is
determined by the port physical characteristics (for
example, data rate and duplex capability) and
configuration restrictions that you establish.
Oper Key Runtime operational key that is being used by this
port. LACP automatically generates this value as a
hexadecimal number.
Port Number Port number.
Port State State variables for the port, encoded as individual bits
within a single octet with these meanings:
• bit0: LACP_Activity
• bit1: LACP_Timeout
• bit2: Aggregation
• bit3: Synchronization
• bit4: Collecting
• bit5: Distributing
• bit6: Defaulted
• bit7: Expired
Note In the list above, bit7 is the MSB and
bit0 is the LSB.
This is an example of output from the show lacp neighbor command:
Device> show lacp neighbor
Flags: S - Device is sending Slow LACPDUs F - Device is sending Fast LACPDUs
A - Device is in Active mode P - Device is in Passive mode
Channel group 3 neighbors
Partner’s information:
Partner Partner Partner
Port System ID Port Number Age Flags
Gi2/0/1 32768,0007.eb49.5e80 0xC 19s SP
LACP Partner Partner Partner
Port Priority Oper Key Port State
32768 0x3 0x3C
Partner’s information:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
925
Layer 2/3
show lacp
Partner Partner Partner
Port System ID Port Number Age Flags
Gi2/0/2 32768,0007.eb49.5e80 0xD 15s SP
LACP Partner Partner Partner
Port Priority Oper Key Port State
32768 0x3 0x3C
This is an example of output from the show lacp sys-id command:
Device> show lacp sys-id
32765,0002.4b29.3a00
The system identification is made up of the system priority and the system MAC address. The first
two bytes are the system priority, and the last six bytes are the globally administered individual MAC
address associated to the system.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
926
Layer 2/3
show loopdetect
show loopdetect
To display the details of all the interfaces where loop-detection guard is enabled, use the show loopdetect
command in user EXEC or privileged EXEC mode.
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes User EXEC (>)
Privileged EXEC(#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Examples The following is a sample output of the show loopdetect command:
Device# show loopdetect
Interface Interval Elapsed-Time Port-to-Errdisbale ACTION
--------- -------- ------------ --------------------- ---------
Twe1/0/1 5 3 errdisable Source Port SYSLOG
Twe1/0/20 5 0 errdisable Source Port ERRDISABLE
Twe2/0/3 5 2 errdisable Dest Port ERRDISABLE
Loopdetect is ENABLED
The table below describes the significant fields shown in the display.
Table 121: show loopdetect Field Descriptions
Field Description
Interface Displays the interfaces that have loop-detection guard enabled.
Interval Displays the time interval set to send the loop-detect frames in seconds.
Elapsed-Time Displays the time elapsed within the set time interval to send loop-detect frames.
Port-to-Errdisbale Displays the port that is configured to be error-disabled.
Action Displays the action the system will take when it detects a network loop.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
927
Layer 2/3
show msrp port bandwidth
show msrp port bandwidth
To display Multiple Stream Reservation Protocol (MSRP) port bandwidth information, use the show msrp
port bandwidth command.
show msrp port bandwidth
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration mode (#)
Example:
The following is sample output from the show msrp port bandwidth command:
Device# show msrp port bandwidth
--------------------------------------------------------------------------------
Ethernet Capacity Assigned Available Reserved
Interface (Kbit/s) A | B A | B A | B
--------------------------------------------------------------------------------
Te1/0/1 10000000 75 | 0 75 | 75 0 | 0
Te1/0/2 10000000 75 | 0 75 | 75 0 | 0
Te1/0/3 1000000 75 | 0 75 | 75 0 | 0
Te1/0/4 10000000 75 | 0 75 | 75 0 | 0
Te1/0/5 10000000 75 | 0 75 | 75 0 | 0
Te1/0/6 10000000 75 | 0 75 | 75 0 | 0
Te1/0/8 10000000 75 | 0 75 | 75 0 | 0
Te1/0/9 10000000 75 | 0 75 | 75 0 | 0
Te1/0/10 10000000 75 | 0 75 | 75 0 | 0
Te1/0/11 10000000 75 | 0 75 | 75 0 | 0
Te1/0/12 10000000 75 | 0 75 | 75 0 | 0
Te1/0/13 1000000 75 | 0 75 | 75 0 | 0
Te1/0/14 10000000 75 | 0 75 | 75 0 | 0
Te1/0/15 10000000 75 | 0 75 | 75 0 | 0
Te1/0/16 10000000 75 | 0 75 | 75 0 | 0
Te1/0/17 10000000 75 | 0 75 | 75 0 | 0
Te1/0/18 10000000 75 | 0 75 | 75 0 | 0
Te1/0/19 1000000 75 | 0 75 | 75 0 | 0
Te1/0/20 10000000 75 | 0 75 | 75 0 | 0
Te1/0/21 10000000 75 | 0 75 | 75 0 | 0
Te1/0/22 10000000 75 | 0 75 | 75 0 | 0
Te1/0/23 10000000 75 | 0 75 | 75 0 | 0
Te1/0/24 10000000 75 | 0 75 | 75 0 | 0
Gi1/1/1 1000000 75 | 0 75 | 75 0 | 0
Gi1/1/2 1000000 75 | 0 75 | 75 0 | 0
Gi1/1/3 1000000 75 | 0 75 | 75 0 | 0
Gi1/1/4 1000000 75 | 0 75 | 75 0 | 0
Te1/1/1 10000000 75 | 0 75 | 75 0 | 0
Te1/1/2 10000000 75 | 0 75 | 75 0 | 0
Te1/1/3 10000000 75 | 0 75 | 75 0 | 0
Te1/1/4 10000000 75 | 0 75 | 75 0 | 0
Te1/1/5 10000000 75 | 0 75 | 75 0 | 0
Te1/1/6 10000000 75 | 0 75 | 75 0 | 0
Te1/1/7 10000000 75 | 0 75 | 75 0 | 0
Te1/1/8 10000000 75 | 0 75 | 75 0 | 0
Fo1/1/1 40000000 75 | 0 75 | 75 0 | 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
928
Layer 2/3
show msrp port bandwidth
Fo1/1/2 40000000 75 | 0 75 | 75 0 | 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
929
Layer 2/3
show msrp streams
show msrp streams
To display information about the Multiple Stream Reservation Protocol (MSRP) streams, use the show msrp
streams command.
show msrp streams [ detailed | brief ]
Syntax Description detailed Displays detailed MSRP stream information.
brief Displays MSRP stream information in brief.
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration mode (#)
Example:
The following is sample output from the show msrp streams command:
Device# show msrp streams
--------------------------------------------------------------------------------
Stream ID Talker Listener
Advertise Fail Ready ReadyFail AskFail
R | D R | D R | D R | D R | D
--------------------------------------------------------------------------------
yy:yy:yy:yy:yy:yy:0001 1 | 2 0 | 0 1 | 0 0 | 1 1 | 0
zz:zz:zz:zz:zz:zz:0002 1 | 0 0 | 1 1 | 0 0 | 0 0 | 1
The following is sample output from the show msrp streams detailed command:
Device# show msrp streams detailed
Stream ID: 0011.0100.0001:1
Stream Age: 01:57:46 (since Mon Apr 25 23:41:11.413)
Create Time: Mon Apr 25 23:41:11.413
Destination Address: 91E0.F000.FE00
VLAN Identifier: 1
Data Frame Priority: 3 (Class A)
MaxFrameSize: 100
MaxIntervalFrames: 1 frames/125us
Stream Bandwidth: 6400 Kbit/s
Rank: 1
Received Accumulated Latency: 20
Stream Attributes Table:
----------------------------------------------------------------------------
Interface Attr State Direction Type
----------------------------------------------------------------------------
Gi1/0/1 Register Talker Advertise
Attribute Age: 01:57:46 (since Mon Apr 25 23:41:11.413)
MRP Applicant: Very Anxious Observer, send None
MRP Registrar: In
Accumulated Latency: 20
----
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
930
Layer 2/3
show msrp streams
Te1/1/1 Declare Talker Advertise
Attribute Age: 00:19:52 (since Tue Apr 26 01:19:05.525)
MRP Applicant: Quiet Active, send None
MRP Registrar: In
Accumulated Latency: 20
----
Te1/1/1 Register Listener Ready
Attribute Age: 00:13:17 (since Tue Apr 26 01:25:40.635)
MRP Applicant: Very Anxious Observer, send None
MRP Registrar: In
----
Gi1/0/1 Declare Listener Ready
Attribute Age: 00:13:17 (since Tue Apr 26 01:25:40.649)
MRP Applicant: Quiet Active, send None
MRP Registrar: In
The following is sample output from the show msrp streams brief command:
Device# show msrp streams brief
Legend: R = Registered, D = Declared.
--------------------------------------------------------------------------------
Stream ID Destination Bandwidth Talkers Listeners Fail
Address (Kbit/s) R | D R | D
--------------------------------------------------------------------------------
0011.0100.0001:1 91E0.F000.FE00 6400 1 | 1 1 | 1 No
0011.0100.0002:2 91E0.F000.FE01 6400 1 | 1 1 | 1 No
0011.0100.0003:3 91E0.F000.FE02 6400 1 | 1 1 | 1 No
0011.0100.0004:4 91E0.F000.FE03 6400 1 | 1 1 | 1 No
0011.0100.0005:5 91E0.F000.FE04 6400 1 | 1 1 | 1 No
0011.0100.0006:6 91E0.F000.FE05 6400 1 | 1 1 | 1 No
0011.0100.0007:7 91E0.F000.FE06 6400 1 | 1 1 | 1 No
0011.0100.0008:8 91E0.F000.FE07 6400 1 | 1 1 | 1 No
0011.0100.0009:9 91E0.F000.FE08 6400 1 | 1 1 | 1 No
0011.0100.000A:10 91E0.F000.FE09 6400 1 | 1 1 | 1 No
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
931
Layer 2/3
show pagp
show pagp
To display Port Aggregation Protocol (PAgP) channel-group information, use the show pagp command in
EXEC mode.
show pagp [channel-group-number] {counters | dual-active | internal | neighbor}
Syntax Description channel-group-number (Optional) Channel group number.
The range is 1 to 128.
counters Displays traffic information.
dual-active Displays the dual-active status.
internal Displays internal information.
neighbor Displays neighbor information.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can enter any show pagp command to display the active channel-group information. To display the
nonactive information, enter the show pagp command with a channel-group number.
Examples This is an example of output from the show pagp 1 counters command:
Device> show pagp 1 counters
Information Flush
Port Sent Recv Sent Recv
----------------------------------------
Channel group: 1
Gi1/0/1 45 42 0 0
Gi1/0/2 45 41 0 0
This is an example of output from the show pagp dual-active command:
Device> show pagp dual-active
PAgP dual-active detection enabled: Yes
PAgP dual-active version: 1.1
Channel group 1
Dual-Active Partner Partner Partner
Port Detect Capable Name Port Version
Gi1/0/1 No -p2 Gi3/0/3 N/A
Gi1/0/2 No -p2 Gi3/0/4 N/A
<output truncated>
This is an example of output from the show pagp 1 internal command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
932
Layer 2/3
show pagp
Device> show pagp 1 internal
Flags: S - Device is sending Slow hello. C - Device is in Consistent state.
A - Device is in Auto mode.
Timers: H - Hello timer is running. Q - Quit timer is running.
S - Switching timer is running. I - Interface timer is running.
Channel group 1
Hello Partner PAgP Learning Group
Port Flags State Timers Interval Count Priority Method Ifindex
Gi1/0/1 SC U6/S7 H 30s 1 128 Any 16
Gi1/0/2 SC U6/S7 H 30s 1 128 Any 16
This is an example of output from the show pagp 1 neighbor command:
Device> show pagp 1 neighbor
Flags: S - Device is sending Slow hello. C - Device is in Consistent state.
A - Device is in Auto mode. P - Device learns on physical port.
Channel group 1 neighbors
Partner Partner Partner Partner Group
Port Name Device ID Port Age Flags Cap.
Gi1/0/1 -p2 0002.4b29.4600 Gi01//1 9s SC 10001
Gi1/0/2 -p2 0002.4b29.4600 Gi1/0/2 24s SC 10001
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
933
Layer 2/3
show platform etherchannel
show platform etherchannel
To display platform-dependent EtherChannel information, use the show platform etherchannel command
in privileged EXEC mode.
show platform etherchannel channel-group-number {group-mask | load-balance mac src-mac
dst-mac [ip src-ip dst-ip [port src-port dst-port]]} [switch switch-number]
Syntax Description channel-group-number Channel group number.
The range is 1 to 128.
group-mask Displays EtherChannel group mask.
load-balance Tests EtherChannel load-balance hash algorithm.
mac src-mac Specifies the source and destination MAC addresses.
dst-mac
ip src-ip dst-ip (Optional) Specifies the source and destination IP addresses.
port src-port (Optional) Specifies the source and destination layer port numbers.
dst-port
switch (Optional) Specifies the stack member.
switch-number
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command only when you are working directly with a technical support representative while
troubleshooting a problem.
Do not use this command unless a technical support representative asks you to do so.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
934
Layer 2/3
show platform hardware fed active vlan ingress
show platform hardware fed active vlan ingress
To display if native vlan tagging is enabled or disabled for a particular vlan, use the show platform hardware
fed active vlan ingress
show platform hardware fed active vlan vlan ID ingress
Syntax Description
Syntax Description
vlan vlan ID Specifies the VLAN ID.
ingress Specifies Spanning Tree Protocol (STP) state
information in ingress direction.
Command Modes Privileged EXEC mode (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.11.1 This command was introduced.
Example
The following is sample output from the show platform hardware fed active vlan ingress command:
Device# show platform hardware fed active vlan 1 ingress
VLAN STP State in hardware
vlan id is:: 1
Interfaces in forwarding state: : Hu1/0/45(Tagged)
flood list: : Hu1/0/45
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
935
Layer 2/3
show platform pm
show platform pm
To display platform-dependent port manager information, use the show platform pm command in privileged
EXEC mode.
show platform pm {etherchannel channel-group-number group-mask | interface-numbers | port-data
interface-id | port-state}
Syntax Description etherchannel channel-group-number Displays the EtherChannel group-mask table for the specified
group-mask channel group.
The range is 1 to 128.
interface-numbers Displays interface numbers information.
port-data interface-id Displays port data information for the specified interface.
port-state Displays port state information.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command only when you are working directly with your technical support representative while
troubleshooting a problem.
Do not use this command unless your technical support representative asks you to do so.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
936
Layer 2/3
show platform software fed active ptp interface loopback
show platform software fed active ptp interface loopback
To display the Precision Time Protocol (PTP) connection details and events of the specified loopback interface,
use the show platform software fed active ptp interface loopback command in privileged EXEC mode.
show platform software fed active php interface value
Syntax Description value Loopback interface number. The maximum number
of sessions supported is 127.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show platform software fed active ptp interface loopback
command:
Device> enable
Device# show platform software fed active ptp interface loopback 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
937
Layer 2/3
show platform software fed switch ptp
show platform software fed switch ptp
To display information about ptp status on the port, use the show platform software fed switch ptp command.
show platform software fed switch { switch-number | active | standby} ptp { domain domain-value
| if-id value | test }
Syntax Description switch switch-number Displays information about the switch. Valid values
for switch-number argument are from 0 to 9.
active Displays information about the active instance of the
switch.
standby Displays information about the standby instance of
the switch.
domain domain-value Displays information about the specified domain.
if-id value Displays information about the specified interface.
test Executes ptp test
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Command Modes Global configuration mode (#)
Example:
The following is sample output from the show platform software fed switch active ptp if-id 0x20 command:
Device# show platform software fed switch active ptp if-id 0x20
Displaying port data for if_id 20
=======================================
Port Mac Address 04:6C:9D:4E:3A:9A
Port Clock Identity 04:6C:9D:FF:FE:4E:3A:80
Port number 28
PTP Version 2
domain_value 0
dot1as capable: FALSE
sync_recpt_timeout_time_interval 375000000 nanoseconds
sync_interval 125000000 nanoseconds
neighbor_rate_ratio 0.000000
neighbor_prop_delay 0 nanoseconds
compute_neighbor_rate_ratio: TRUE
compute_neighbor_prop_delay: TRUE
port_enabled: TRUE
ptt_port_enabled: TRUE
current_log_pdelay_req_interval 0
pdelay_req_interval 0 nanoseconds
allowed_lost_responses 3
neighbor_prop_delay_threshold 2000 nanoseconds
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
938
Layer 2/3
show platform software fed switch ptp
is_measuring_delay : FALSE
Port state: : MASTER
sync_seq_num 22023
delay_req_seq_num 23857
num sync messages transmitted 0
num sync messages received 0
num followup messages transmitted 0
num followup messages received 0
num pdelay requests transmitted 285695
num pdelay requests received 0
num pdelay responses transmitted 0
num pdelay responses received 0
num pdelay followup responses transmitted 0
num pdelay followup responses received 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
939
Layer 2/3
show ptp brief
show ptp brief
To display a brief status of PTP on the interfaces, use the show ptp brief command in global configuration
mode.
show ptp brief
Syntax Description This command has no aruguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples The following is a sample output from the show ptp brief command:
Device# show ptp brief
Interface Domain PTP State
FortyGigabitEthernet1/1/1 0 FAULTY
FortyGigabitEthernet1/1/2 0 SLAVE
GigabitEthernet1/1/1 0 FAULTY
GigabitEthernet1/1/2 0 FAULTY
GigabitEthernet1/1/3 0 FAULTY
GigabitEthernet1/1/4 0 FAULTY
TenGigabitEthernet1/0/1 0 FAULTY
TenGigabitEthernet1/0/2 0 FAULTY
TenGigabitEthernet1/0/3 0 MASTER
TenGigabitEthernet1/0/4 0 FAULTY
TenGigabitEthernet1/0/5 0 FAULTY
TenGigabitEthernet1/0/6 0 FAULTY
TenGigabitEthernet1/0/7 0 MASTER
TenGigabitEthernet1/0/8 0 FAULTY
TenGigabitEthernet1/0/9 0 FAULTY
TenGigabitEthernet1/0/10 0 FAULTY
TenGigabitEthernet1/0/11 0 MASTER
TenGigabitEthernet1/0/12 0 FAULTY
TenGigabitEthernet1/0/13 0 FAULTY
TenGigabitEthernet1/0/14 0 FAULTY
TenGigabitEthernet1/0/15 0 FAULTY
TenGigabitEthernet1/0/16 0 FAULTY
.
.
.
Related Commands Command Description
show ptp clock Displays PTP clock information.
show ptp parent Displays the parent clock information.
show ptp port Displays the PTP port information.
show ptp time-property Displays the PTP clock time property.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
940
Layer 2/3
show ptp clock
show ptp clock
To display PTP clock information, use the show ptp clock command in global configuration mode.
show ptp clock
Syntax Description This command has no aruguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples The following is a sample output from the show ptp clock command:
Device# show ptp clock
PTP CLOCK INFO
PTP Device Type: Boundary clock
PTP Device Profile: IEEE 802/1AS Profile
Clock Identity: 0x4:6C:9D:FF:FE:4F:95:0
Clock Domain: 0
Number of PTP ports: 38
PTP Packet priority: 4
Priority1: 128
Priority2: 128
Clock Quality:
Class: 248
Accuracy: Unknown
Offset (log variance): 16640
Offset From Master(ns): 0
Mean Path Delay(ns): 0
Steps Removed: 3
Local clock time: 00:12:13 UTC Jan 1 1970
-----------------------------------------------------------
Related Commands Command Description
show ptp brief Displays a brief status of PTP on the interfaces.
show ptp parent Displays the parent clock information.
show ptp port Displays the PTP port information.
show ptp time-property Displays the PTP clock time property.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
941
Layer 2/3
show ptp parent
show ptp parent
To display the PTP parent clock information, use the show ptp parent command in global configuration
mode.
show ptp parent
Syntax Description This command has no aruguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples The following is a sample output from the show ptp parent command:
Device# show ptp parent
Steps Removed: 3
Local clock time: 00:12:13 UTC Jan 1 1970
---------------------------------------------------------------------------
This command can be used to view the parent clock information.
Device#show ptp parent
PTP PARENT PROPERTIES
Parent Clock:
Parent Clock Identity: 0xB0:7D:47:FF:FE:9E:B6:80
Parent Port Number: 3
Observed Parent Offset (log variance): 16640
Observed Parent Clock Phase Change Rate: N/A
Grandmaster Clock:
Grandmaster Clock Identity: 0x4:6C:9D:FF:FE:67:3A:80
Grandmaster Clock Quality:
Class: 248
Accuracy: Unknown
Offset (log variance): 16640
Priority1: 0
Priority2: 128
---------------------------------------------------------------------------
Related Commands Command Description
show ptp brief Displays a brief status of PTP on the interfaces.
show ptp clock Displays PTP clock information.
show ptp port Displays the PTP port information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
942
Layer 2/3
show ptp parent
Command Description
show ptp time-property Displays the PTP clock time property.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
943
Layer 2/3
show ptp port
show ptp port
To display the PTP port information, use the show ptp port command in global configuration mode.
show ptp port
Syntax Description This command has no aruguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was introduced.
Examples The following is a sample output from the show ptp port command:
Device# show ptp port
PTP PORT DATASET: FortyGigabitEthernet1/1/1
Port identity: clock identity: 0x4:6C:9D:FF:FE:4E:3A:80
Port identity: port number: 1
PTP version: 2
Port state: FAULTY
Delay request interval(log mean): 5
Announce receipt time out: 3
Peer mean path delay(ns): 0
Announce interval(log mean): 1
Sync interval(log mean): 0
Delay Mechanism: End to End
Peer delay request interval(log mean): 0
Sync fault limit: 500000000
PTP PORT DATASET: FortyGigabitEthernet1/1/2
Port identity: clock identity: 0x4:6C:9D:FF:FE:4E:3A:80
Port identity: port number: 2
PTP version: 2
Port state: FAULTY
Delay request interval(log mean): 5
Announce receipt time out: 3
Peer mean path delay(ns): 0
Announce interval(log mean): 1
--More—
----------------------------------------------------------------------------------
Related Commands Command Description
show ptp brief Displays a brief status of PTP on the interfaces.
show ptp clock Displays PTP clock information.
show ptp parent Displays the parent clock information.
show ptp time-property Displays the PTP clock time property.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
944
Layer 2/3
show ptp port loopback
show ptp port loopback
To display Precision Time Protocol (PTP) configurations of a loopback interface, use the show ptp port
loopback command in privileged EXEC mode.
show ptp port loopback value
Syntax Description value Loopback interface number. The maximum number
of sessions supported is 127.
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show ptp port loopback command:
Device> enable
Device# show ptp port loopback
PTP PORT DATASET: Loopback0
Port identity: clock identity: 0xF8:F:6F:FF:FE:CB:4D:C0
Port identity: port number: 34818
PTP version: 2
PTP port number: 2
PTP slot number: 17
Port state: SLAVE
Delay request interval(log mean): 0
Announce receipt time out: 3
Neighbor prop delay(ns): 0
Announce interval(log mean): 0
Sync interval(log mean): -2
Delay Mechanism: End to End
Peer delay request interval(log mean): 0
Sync fault limit: 500000000
ptp role primary : Disabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
945
Layer 2/3
show ptp transport properties
show ptp transport properties
To display a Precision Time Protocol (PTP) profile and its properties, use the show ptp transport properties
command in privileged EXEC mode.
show ptp transport properties
Command Default None
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show ptp transport properties command:
Device> enable
Device# show ptp transport properties
Profile Property flow1 extended to : Dot1as
S.No Transport Interface SourceIP Vrf PeerIp Ptp State
---- --------- --------------- --------------- ---------- --------------- ---------------
1 IPv4 Loopback0 4.4.4.4 192.168.2.2 SLAVE
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
946
Layer 2/3
show rep topology
show rep topology
To display Resilient Ethernet Protocol (REP) topology information for a segment or for all the segments,
including the primary and secondary edge ports in the segment, use the show rep topology command in
privileged EXEC mode.
show rep topology [segment segment-id] [archive] [detail]
Syntax Description segment segment-id (Optional) Specifies the segment for which to display the REP topology
information. The segment-id range is from 1 to 1024.
archive (Optional) Displays the previous topology of the segment. This keyword is
useful for troubleshooting a link failure.
detail (Optional) Displays detailed REP topology information.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is a sample output from the show rep topology command:
Device# show rep topology
REP Segment 1
BridgeName PortName Edge Role
---------------- ---------- ---- ----
10.64.106.63 Te5/4 Pri Open
10.64.106.228 Te3/4 Open
10.64.106.228 Te3/3 Open
10.64.106.67 Te4/3 Open
10.64.106.67 Te4/4 Alt
10.64.106.63 Te4/4 Sec Open
REP Segment 3
BridgeName PortName Edge Role
---------------- ---------- ---- ----
10.64.106.63 Gi50/1 Pri Open
SVT_3400_2 Gi0/3 Open
SVT_3400_2 Gi0/4 Open
10.64.106.68 Gi40/2 Open
10.64.106.68 Gi40/1 Open
10.64.106.63 Gi50/2 Sec Alt
The following is a sample output from the show rep topology detail command:
Device# show rep topology detail
REP Segment 1
10.64.106.63, Te5/4 (Primary Edge)
Open Port, all vlans forwarding
Bridge MAC: 0005.9b2e.1700
Port Number: 010
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
947
Layer 2/3
show rep topology
Port Priority: 000
Neighbor Number: 1 / [-6]
10.64.106.228, Te3/4 (Intermediate)
Open Port, all vlans forwarding
Bridge MAC: 0005.9b1b.1f20
Port Number: 010
Port Priority: 000
Neighbor Number: 2 / [-5]
10.64.106.228, Te3/3 (Intermediate)
Open Port, all vlans forwarding
Bridge MAC: 0005.9b1b.1f20
Port Number: 00E
Port Priority: 000
Neighbor Number: 3 / [-4]
10.64.106.67, Te4/3 (Intermediate)
Open Port, all vlans forwarding
Bridge MAC: 0005.9b2e.1800
Port Number: 008
Port Priority: 000
Neighbor Number: 4 / [-3]
10.64.106.67, Te4/4 (Intermediate)
Alternate Port, some vlans blocked
Bridge MAC: 0005.9b2e.1800
Port Number: 00A
Port Priority: 000
Neighbor Number: 5 / [-2]
10.64.106.63, Te4/4 (Secondary Edge)
Open Port, all vlans forwarding
Bridge MAC: 0005.9b2e.1700
Port Number: 00A
Port Priority: 000
Neighbor Number: 6 / [-1]
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
948
Layer 2/3
show spanning-tree
show spanning-tree
To display spanning-tree information for the specified spanning-tree instances, use the show spanning-tree
command in privileged EXEC mode.
show spanning-tree [bridge-group] [{ active | backbonefast | blockedports | bridge [id] | detail |
inconsistentports | instances | interface interface-type interface-number | mst [{ list | configuration
[digest] }] | pathcost method | root | summary [totals] | uplinkfast | vlan vlan-id }]
Syntax Description bridge-group (Optional) Specifies the bridge group number. The range is 1 to 255.
active (Optional) Displays spanning-tree information on active interfaces only.
backbonefast (Optional) Displays spanning-tree BackboneFast status.
blockedports (Optional) Displays blocked port information.
bridge (Optional) Displays status and configuration of this switch.
detail (Optional) Shows status and configuration details.
inconsistentports (Optional) Displays information about inconsistent ports.
instances (Optional) Displays information about maximum STP instances.
interface interface-type (Optional) Specifies the type and number of the interface. Enter each
interface-number interface designator, using a space to separate it from the one before and
the one after. Ranges are not supported. Valid interfaces include physical
ports and virtual LANs (VLANs). See the “Usage Guidelines” for valid
values.
mst (Optional) Specifies multiple spanning-tree.
list (Optional) Specifies a multiple spanning-tree instance list.
configuration digest (Optional) Displays the multiple spanning-tree current region configuration.
pathcost method (Optional) Displays the default path-cost calculation method that is used.
See the “Usage Guidelines” section for the valid values.
root (Optional) Displays root-switch status and configuration.
summary (Optional) Specifies a summary of port states.
totals (Optional) Displays the total lines of the spanning-tree state section.
uplinkfast (Optional) Displays spanning-tree UplinkFast status.
vlan vlan-id (Optional) Specifies the VLAN ID. The range is 1 to 4094.
If the vlan-id value is omitted, the command applies to the spanning-tree
instance for all VLANs.
id (Optional) Identifies the spanning tree bridge.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
949
Layer 2/3
show spanning-tree
port-channel number (Optional) Identifies the Ethernet channel associated with the interfaces.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The keywords and arguments that are available with the show spanning-tree command vary depending on
the platform you are using and the network modules that are installed and operational.
The port-channel number values from 257 to 282 are supported on the Content Switching Module (CSM)
and the Firewal Services Module (FWSM) only.
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 2 to 13 and valid values for the port number are from
1 to 48.
When checking spanning tree-active states and you have a large number of VLANs, you can enter the show
spanning-tree summary total command. You can display the total number of VLANs without having to
scroll through the list of VLANs.
The valid values for keyword pathcoast method are:
• append: Appends the redirected output to a URL (supporting the append operation).
• begin: Begins with the matching line.
• exclude: Excludes matching lines.
• include: Includes matching lines.
• redirect: Redirects output to a URL.
• tee: Copies output to a URL.
When you run the show spanning-tree command for a VLAN or an interface the switch router will display
the different port states for the VLAN or interface. The valid spanning-tree port states are listening, learning,
forwarding, blocking, disabled, and loopback.
Device#
show spanning-tree
VLAN0001
Spanning tree enabled protocol rstp
Root ID Priority 32769
Address 5c71.0dfe.8380
This bridge is the root
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32769 (priority 32768 sys-id-ext 1)
Address 5c71.0dfe.8380
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Aging Time 300 sec
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
950
Layer 2/3
show spanning-tree
Interface Role Sts Cost Prio.Nbr Type
------------------- ---- --- --------- -------- --------------------------------
Gi1/0/1 Desg FWD 20000 128.1 P2p
Gi1/0/18 Desg FWD 20000 128.18 P2p
Gi1/0/21 Desg FWD 20000 128.21 P2p
Te1/0/25 Desg FWD 20000 128.25 P2p
Te1/0/37 Desg FWD 2000 128.37 P2p
Te1/0/38 Desg FWD 2000 128.38 P2p
Te1/0/45 Desg FWD 20000 128.45 P2p
Te1/0/48 Desg FWD 20000 128.48 P2p
See the table below for definitions of the port states:
Table 122: show spanning-tree vlan Command Port States
Field Definition
BLK Blocked is when the port is still sending and listening to BPDU packets but is not forwarding traffic.
DIS Disabled is when the port is not sending or listening to BPDU packets and is not forwarding traffic.
FWD Forwarding is when the port is sending and listening to BPDU packets and forwarding traffic.
LBK Loopback is when the port recieves its own BPDU packet back.
LIS Listening is when the port spanning tree initially starts to listen for BPDU packets for the root bridge.
LRN Learning is when the port sets the proposal bit on the BPDU packets it sends out
This example shows how to display a summary of interface information:
Device#
show spanning-tree
VLAN0001
Spanning tree enabled protocol rstp
Root ID Priority 32769
Address 6cb2.ae4a.4fc0
This bridge is the root
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32769 (priority 32768 sys-id-ext 1)
Address 6cb2.ae4a.4fc0
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Aging Time 300 sec
Interface Role Sts Cost Prio.Nbr Type
------------------- ---- --- --------- -------- --------------------------------
Fif1/0/17 Desg FWD 2000 128.17 P2p
Fif1/0/19 Desg FWD 800 128.19 P2p
Fif1/0/21 Desg FWD 2000 128.21 P2p
Fif1/0/23 Desg FWD 2000 128.23 P2p
TwoH1/0/42 Desg FWD 500 128.42 P2p
Fou1/0/44 Desg FWD 50 128.44 P2p
Fif2/0/17 Back BLK 2000 128.185 P2p
Fif2/0/19 Back BLK 800 128.187 P2p
Fif2/0/21 Back BLK 2000 128.189 P2p
Fif2/0/23 Back BLK 2000 128.191 P2p
Fou2/0/43 Desg FWD 50 128.211 P2p
Fou2/0/44 Back BLK 50 128.212 P2p
Hu5/0/13 Desg FWD 500 128.685 P2p
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
951
Layer 2/3
show spanning-tree
Hu5/0/15 Desg FWD 500 128.687 P2p
Hu5/0/21 Back BLK 500 128.693 P2p
Hu5/0/23 Back BLK 500 128.695 P2p
Fou6/0/27 Back BLK 50 128.867 P2p
Hu6/0/29 Desg FWD 200 128.869 P2p
Hu6/0/30 Back BLK 200 128.870 P2p
The table below describes the fields that are shown in the example.
Table 123: show spanning-tree Command Output Fields
Field Definition
Port ID Prio.Nbr Port ID and priority number.
Cost Port cost.
Sts Status information.
This example shows how to display information about the spanning tree for this bridge only:
Device# show spanning-tree bridge
Hello Max Fwd
Vlan Bridge ID Time Age Dly Protocol
---------------- --------------------------------- ----- --- --- --------
VLAN0001 32769 (32768, 1) 5c71.0dfe.8380 2 20 15 rstp
This example shows how to display detailed information about the interface:
Device#
show spanning-tree detail
VLAN0001 is executing the rstp compatible Spanning Tree protocol
Bridge Identifier has priority 32768, sysid 1, address 5c71.0dfe.8380
Configured hello time 2, max age 20, forward delay 15, transmit hold-count 6
We are the root of the spanning tree
Topology change flag not set, detected flag not set
Number of topology changes 27 last change occurred 4d19h ago
from TenGigabitEthernet1/0/48
Times: hold 1, topology change 35, notification 2
hello 2, max age 20, forward delay 15
Timers: hello 0, topology change 0, notification 0, aging 300
Port 1 (GigabitEthernet1/0/1) of VLAN0001 is designated forwarding
Port path cost 20000, Port priority 128, Port Identifier 128.1.
Designated root has priority 32769, address 5c71.0dfe.8380
Designated bridge has priority 32769, address 5c71.0dfe.8380
Designated port id is 128.1, designated path cost 0
Timers: message age 0, forward delay 0, hold 0
Number of transitions to forwarding state: 1
Link type is point-to-point by default
BPDU: sent 208695, received 1
Port 18 (GigabitEthernet1/0/18) of VLAN0001 is designated forwarding
!
!
<<output truncated>>
This example shows how to display a summary of port states:
Device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
952
Layer 2/3
show spanning-tree
show spanning-tree summary
Switch is in rapid-pvst mode
Root bridge for: VLAN0001
Extended system ID is enabled
Portfast Default is disabled
PortFast BPDU Guard Default is disabled
Portfast BPDU Filter Default is disabled
Loopguard Default is disabled
EtherChannel misconfig guard is enabled
UplinkFast is disabled
BackboneFast is enabled but inactive in rapid-pvst mode
Configured Pathcost method used is long
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
VLAN0001 1 0 0 26 27
---------------------- -------- --------- -------- ---------- ----------
1 vlan 1 0 0 26 27
This example shows how to display the total lines of the spanning-tree state section:
Device#
show spanning-tree summary total Switch is in rapid-pvst mode
Root bridge for: VLAN0001
Extended system ID is enabled
Portfast Default is disabled
PortFast BPDU Guard Default is disabled
Portfast BPDU Filter Default is disabled
Loopguard Default is disabled
EtherChannel misconfig guard is enabled
UplinkFast is disabled
BackboneFast is enabled but inactive in rapid-pvst mode
Configured Pathcost method used is long
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
1 vlan 1 0 0 26 27
This example shows how to display information about the spanning tree for a specific VLAN:
Device#
show spanning-tree vlan 200
VLAN0001
Spanning tree enabled protocol rstp
Root ID Priority 32769
Address 5c71.0dfe.8380
This bridge is the root
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32769 (priority 32768 sys-id-ext 1)
Address 5c71.0dfe.8380
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Aging Time 300 sec
Interface Role Sts Cost Prio.Nbr Type
------------------- ---- --- --------- -------- --------------------------------
Gi1/0/1 Desg FWD 20000 128.1 P2p
Gi1/0/18 Desg FWD 20000 128.18 P2p
Gi1/0/21 Desg FWD 20000 128.21 P2p
Te1/0/25 Desg FWD 20000 128.25 P2p
Te1/0/37 Desg FWD 2000 128.37 P2p
Te1/0/38 Desg FWD 2000 128.38 P2p
Te1/0/45 Desg FWD 20000 128.45 P2p
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
953
Layer 2/3
show spanning-tree
Te1/0/48 Desg FWD 20000 128.48 P2p
!
!
<<output truncated>>
The table below describes the fields that are shown in the example.
Table 124: show spanning-tree vlan Command Output Fields
Field Definition
Role Current 802.1w role; valid values are Boun (boundary), Desg (designated), Root, Altn (alternate),
and Back (backup).
Sts Spanning-tree states; valid values are BKN* (broken)3, BLK (blocking), DWN (down), LTN
(listening), LBK (loopback), LRN (learning), and FWD (forwarding).
Cost Port cost.
Prio.Nbr Port ID that consists of the port priority and the port number.
Status Status information; valid values are as follows:
• P2p/Shr: The interface is considered as a point-to-point (resp. shared) interface by the spanning
tree.
• Edge: PortFast has been configured (either globally using the defaultcommand or directly
on the interface) and no BPDU has been received.
• *ROOT_Inc, *LOOP_Inc, *PVID_Inc and *TYPE_Inc: The port is in a broken state (BKN*)
for an inconsistency. The port would be (respectively) Root inconsistent, Loopguard
inconsistent, PVID inconsistent, or Type inconsistent.
• Bound(type): When in MST mode, identifies the boundary ports and specifies the type of the
neighbor (STP, RSTP, or PVST).
• Peer(STP): When in PVRST rapid-pvst mode, identifies the port connected to a previous
version of the 802.1D bridge.
3
For information on the *, see the definition for the Status field.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
954
Layer 2/3
show spanning-tree mst
show spanning-tree mst
To display the information about the Multiple Spanning Tree (MST) protocol, use the show spanning-tree
mst command in privileged EXEC mode.
show spanning-tree mst [{ configuration [digest] | instance-id-number }] [ interface interface ] [
detail ] [ service instance ]
Syntax Description instance-id-number (Optional) Instance identification number. The range is from 0 to 4094.
detail (Optional) Displays detailed information about the MST protocol.
interface (Optional) Displays the information about the interfaces. See the “Usage Guidelines”
section for valid number values.
configuration (Optional) Displays information about the region configuration.
digest (Optional) Displays information about the message digest 5 (MD5) algorithm included
in the current MST configuration identifier (MSTCI).
interface (Optional) Displays information about the interface type.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The valid values for the interface argument 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 2 to 13 and
valid values for the port number are from 1 to 48.
The number of valid values for port-channel number are a maximum of 64 values ranging from 1 to 282.
The port-channel number values from 257 to 282 are supported on the Content Switching Module (CSM)
and the Firewall Services Module (FWSM) only.
The number of valid values for vlan are from 1 to 4094.
In the output display of the show spanning-tree mst configuration command, a warning message may be
displayed. This message appears if you do not map secondary VLANs to the same instance as the associated
primary VLAN. The display includes a list of the secondary VLANs that are not mapped to the same instance
as the associated primary VLAN. The warning message is as follows:
These secondary vlans are not mapped to the same instance as their primary:
-> 3
In the output display of the show spanning-tree mst configuration digest command, if the output applies
to both standard and prestandard bridges at the same time on a per-port basis, two different digests are displayed.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
955
Layer 2/3
show spanning-tree mst
If you configure a port to transmit prestandard PortFast bridge protocol data units (BPDUs) only, the prestandard
flag displays in the show spanning-tree commands. The variations of the prestandard flag are as follows:
• Pre-STD (or pre-standard in long format): This flag is displayed if the port is configured to transmit
prestandard BPDUs and if a prestandard neighbor bridge has been detected on this interface.
• Pre-STD-Cf (or pre-standard (config) in long format): This flag is displayed if the port is configured to
transmit prestandard BPDUs but a prestandard BPDU has not been received on the port, the autodetection
mechanism has failed, or a misconfiguration, if there is no prestandard neighbor, has occurred.
• Pre-STD-Rx (or prestandard (rcvd) in long format): This flag is displayed when a prestandard BPDU
has been received on the port, but it has not been configured to send prestandard BPDUs. The port will
send prestandard BPDUs, but Cisco recommends that you change the port configuration so that the
interaction with the prestandard neighbor does not rely only on the autodetection mechanism.
If the configuration is not prestandard compliant (for example, a single MST instance has an ID that is greater
than or equal to 16,) the prestandard digest is not computed and the following output is displayed:
Device# show spanning-tree mst configuration digest
Name [region1]
Revision 2 Instances configured 3
Digest 0x3C60DBF24B03EBF09C5922F456D18A03
Pre-std Digest N/A, configuration not pre-standard compatible
MST BPDUs include an MSTCI that consists of the region name, region revision, and an MD5 digest of the
VLAN-to-instance mapping of the MST configuration.
See the show spanning-tree mst command field description table for output descriptions.
Examples The following example shows how to display information about the region configuration:
Device# show spanning-tree mst configuration
Name [train]
Revision 2702
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 1-9,11-19,21-29,31-39,41-4094
1 10,20,30,40
-------------------------------------------------------------------------------
The following example shows how to display additional MST-protocol values:
Device# show spanning-tree mst 3 detail
###### MST03 vlans mapped: 3,3000-3999
Bridge address 0002.172c.f400 priority 32771 (32768 sysid 3)
Root this switch for MST03
GigabitEthernet1/1 of MST03 is boundary forwarding
Port info port id 128.1 priority 128
cost 20000
Designated root address 0002.172c.f400 priority 32771
cost 0
Designated bridge address 0002.172c.f400 priority 32771 port
id 128.1
Timers: message expires in 0 sec, forward delay 0, forward transitions 1
Bpdus (MRecords) sent 4, received 0
FastEthernet4/1 of MST03 is designated forwarding
Port info port id 128.193 priority 128 cost
200000
Designated root address 0002.172c.f400 priority 32771
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
956
Layer 2/3
show spanning-tree mst
cost 0
Designated bridge address 0002.172c.f400 priority 32771 port id
128.193
Timers: message expires in 0 sec, forward delay 0, forward transitions 1
Bpdus (MRecords) sent 254, received 1
FastEthernet4/2 of MST03 is backup blocking
Port info port id 128.194 priority 128 cost
200000
Designated root address 0002.172c.f400 priority 32771
cost 0
Designated bridge address 0002.172c.f400 priority 32771 port id
128.193
Timers: message expires in 2 sec, forward delay 0, forward transitions 1
Bpdus (MRecords) sent 3, received 252
The following example shows how to display the MD5 digest included in the current MSTCI:
Device# show spanning-tree mst configuration digest
Name [mst-config]
Revision 10 Instances configured 25
Digest 0x40D5ECA178C657835C83BBCB16723192
Pre-std Digest 0x27BF112A75B72781ED928D9EC5BB4251
Related Commands Command Description
spanning-tree mst Sets the path cost and port-priority parameters for any MST instance.
spanning-tree mst forward-time Sets the forward-delay timer for all the instances on the Cisco 7600
series router.
spanning-tree mst hello-time Sets the hello-time delay timer for all the instances on the Cisco 7600
series router.
spanning-tree mst max-hops Specifies the number of possible hops in the region before a BPDU is
discarded.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
957
Layer 2/3
show udld
show udld
To display UniDirectional Link Detection (UDLD) administrative and operational status for all ports or the
specified port, use the show udld command in user EXEC mode.
show udld [Auto-Template | Capwap | GigabitEthernet | GroupVI | InternalInterface |
Loopback | Null | Port-channel | TenGigabitEthernet | Tunnel | Vlan] interface_number
show udld neighbors
Syntax Description Auto-Template (Optional) Displays UDLD operational status of the auto-template
interface. The range is from 1 to 999.
Capwap (Optional) Displays UDLD operational status of the CAPWAP
interface. The range is from 0 to 2147483647.
GigabitEthernet (Optional) Displays UDLD operational status of the
GigabitEthernet interface. The range is from 0 to 9.
GroupVI (Optional) Displays UDLD operational status of the group virtual
interface. The range is from 1 to 255.
InternalInterface (Optional) Displays UDLD operational status of the internal
interface. The range is from 0 to 9.
Loopback (Optional) Displays UDLD operational status of the loopback
interface. The range is from 0 to 2147483647.
Null (Optional) Displays UDLD operational status of the null
interface.
Port-channel (Optional) Displays UDLD operational status of the Ethernet
channel interfaces.
The range is 1 to 128.
TenGigabitEthernet (Optional) Displays UDLD operational status of the Ten Gigabit
Ethernet interface. The range is from 0 to 9.
Tunnel (Optional) Displays UDLD operational status of the tunnel
interface. The range is from 0 to 2147483647.
Vlan (Optional) Displays UDLD operational status of the VLAN
interface. The range is from 1 to 4095.
interface-id (Optional) ID of the interface and port number. Valid interfaces
include physical ports, VLANs, and port channels.
neighbors (Optional) Displays neighbor information only.
Command Modes User EXEC
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
958
Layer 2/3
show udld
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If you do not enter an interface ID, administrative and operational UDLD status for all interfaces appear.
This is an example of output from the show udld interface-id command. For this display, UDLD
is enabled on both ends of the link, and UDLD detects that the link is bidirectional. The table that
follows describes the fields in this display.
Device> show udld gigabitethernet2/0/1
Interface gi2/0/1
---
Port enable administrative configuration setting: Follows device default
Port enable operational state: Enabled
Current bidirectional state: Bidirectional
Current operational state: Advertisement - Single Neighbor detected
Message interval: 60
Time out interval: 5
Entry 1
Expiration time: 146
Device ID: 1
Current neighbor state: Bidirectional
Device name: Switch-A
Port ID: Gi2/0/1
Neighbor echo 1 device: Switch-B
Neighbor echo 1 port: Gi2/0/2
Message interval: 5
CDP Device name: Switch-A
Table 125: show udld Field Descriptions
Field Description
Interface The interface on the local device configured for
UDLD.
Port enable administrative configuration setting How UDLD is configured on the port. If UDLD is
enabled or disabled, the port enable configuration
setting is the same as the operational enable state.
Otherwise, the enable operational setting depends on
the global enable setting.
Port enable operational state Operational state that shows whether UDLD is
actually running on this port.
Current bidirectional state The bidirectional state of the link. An unknown state
appears if the link is down or if it is connected to an
UDLD-incapable device. A bidirectional state appears
if the link is a normal two-way connection to a
UDLD-capable device. All other values mean
miswiring.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
959
Layer 2/3
show udld
Field Description
Current operational state The current phase of the UDLD state machine. For a
normal bidirectional link, the state machine is most
often in the Advertisement phase.
Message interval How often advertisement messages are sent from the
local device. Measured in seconds.
Time out interval The time period, in seconds, that UDLD waits for
echoes from a neighbor device during the detection
window.
Entry 1 Information from the first cache entry, which contains
a copy of echo information received from the
neighbor.
Expiration time The amount of time in seconds remaining before this
cache entry is aged out.
Device ID The neighbor device identification.
Current neighbor state The neighbor’s current state. If both the local and
neighbor devices are running UDLD normally, the
neighbor state and local state should be bidirectional.
If the link is down or the neighbor is not
UDLD-capable, no cache entries appear.
Device name The device name or the system serial number of the
neighbor. The system serial number appears if the
device name is not set or is set to the default (Switch).
Port ID The neighbor port ID enabled for UDLD.
Neighbor echo 1 device The device name of the neighbors’ neighbor from
which the echo originated.
Neighbor echo 1 port The port number ID of the neighbor from which the
echo originated.
Message interval The rate, in seconds, at which the neighbor is sending
advertisement messages.
CDP device name The CDP device name or the system serial number.
The system serial number appears if the device name
is not set or is set to the default (Switch).
This is an example of output from the show udld neighbors command:
Device> enable
Device# show udld neighbors
Port Device Name Device ID Port-ID OperState
-------- -------------------- ---------- -------- --------------
Gi2/0/1 Switch-A 1 Gi2/0/1 Bidirectional
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
960
Layer 2/3
show udld
Gi3/0/1 Switch-A 2 Gi3/0/1 Bidirectional
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
961
Layer 2/3
show vlan dot1q tag native
show vlan dot1q tag native
To display the status of tagging on the native VLAN use the show vlan dot1q tag native command.
show vlan dot1q tag native
Syntax Description
This command has no arguments or keywords.
Command Modes Privileged EXEC mode (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is sample output from the show vlan dot1q tag native command:
Device# show vlan dot1q tag native
*Feb 1 06:47:30.719: %SYS-5-CONFIG_I: Configured from console by console
dot1q native vlan tagging is enabled globally
Per Port Native Vlan Tagging State
----------------------------------
Port Operational Native VLAN
Mode Tagging State
-------------------------------------------
Hu1/0/45 trunk enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
962
Layer 2/3
source ip interface
source ip interface
To configure the source IP address, use the source ip interface command in property transport sub-configuration
mode.
source ip interface interface_id
Syntax Description interface_id Source IP address.
Command Default None
Command Modes Property transport (config-property-transport)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines This command is optional. Use this command as an alternative to the peer command.
Examples The following example shows how to configure the source IP address:
Device> enable
Device# configure terminal
Device(config)# ptp property cisco1
Device(config-property)# transport unicast ipv4 local loopback 0
Device(config-property-transport)# source ip interface GigabitEthernet 1/0/1
Device(config-property-transport)# end
Related Commands Command Description
ptp dot1as extend property Extends IEEE 802.1AS profile to a PTP property name.
ptp property Sets the PTP property name.
transport unicast ipv4 local loopback Configures a unicast IPv4 connection from a loopback interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
963
Layer 2/3
spanning-tree backbonefast
spanning-tree backbonefast
To enable BackboneFast to allow a blocked port on a switch to change immediately to a listening mode, use
the spanning-tree backbonefast command in global configuration mode. To return to the default setting, use
the no form of this command.
spanning-tree backbonefast
no spanning-tree backbonefast
Syntax Description This command has no arguments or keywords.
Command Default BackboneFast is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines BackboneFast should be enabled on all of the Cisco devices containing an Ethernet switch network module.
BackboneFast provides for fast convergence in the network backbone after a spanning-tree topology change.
It enables the switch to detect an indirect link failure and to start the spanning-tree reconfiguration sooner
than it would under normal spanning-tree rules.
Use the show spanning-tree privileged EXEC command to verify your settings.
Examples The following example shows how to enable BackboneFast on the device:
Device(config)# spanning-tree backbonefast
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
964
Layer 2/3
spanning-tree bpdufilter
spanning-tree bpdufilter
To enable bridge protocol data unit (BPDU) filtering on the interface, use the spanning-tree bpdufilter
command in interface configuration or template configuration mode. To return to the default settings, use the
no form of this command.
spanning-tree bpdufilter { enable | disable }
no spanning-tree bpdufilter
Syntax Description enable Enables BPDU filtering on this interface.
disable Disables BPDU filtering on this interface.
Command Default The setting that is already configured when you enter the spanning-tree portfast edge bpdufilter default
command .
Command Modes Interface configuration (config-if)
Template configuration (config-template)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines
Caution Be careful when you enter the spanning-tree bpdufilter enable command. Enabling BPDU filtering on an
interface is similar to disabling the spanning tree for this interface. If you do not use this command correctly,
you might create bridging loops.
Entering the spanning-tree bpdufilter enable command to enable BPDU filtering overrides the PortFast
configuration.
When configuring Layer 2-protocol tunneling on all the service-provider edge switches, you must enable
spanning-tree BPDU filtering on the 802.1Q tunnel ports by entering the spanning-tree bpdufilter enable
command.
BPDU filtering prevents a port from sending and receiving BPDUs. The configuration is applicable to the
whole interface, whether it is trunking or not. This command has three states:
• spanning-tree bpdufilter enable: Unconditionally enables BPDU filtering on the interface.
• spanning-tree bpdufilter disable: Unconditionally disables BPDU filtering on the interface.
• no spanning-tree bpdufilter: Enables BPDU filtering on the interface if the interface is in operational
PortFast state and if you configure the spanning-tree portfast bpdufilter default command.
Use the spanning-tree portfast bpdufilter default command to enable BPDU filtering on all ports that are
already configured for PortFast.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
965
Layer 2/3
spanning-tree bpdufilter
Examples This example shows how to enable BPDU filtering on this interface:
Device(config-if)# spanning-tree bpdufilter enable
Device(config-if)#
The following example shows how to enable BPDU filtering on an interface using interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree bpdufilter enable
Device(config-template)# end
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
spanning-tree portfast edge bpdufilter default Enables BPDU filtering by default on all PortFast ports.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
966
Layer 2/3
spanning-tree bpduguard
spanning-tree bpduguard
To enable bridge protocol data unit (BPDU) guard on the interface, use the spanning-tree bpduguard
command in interface configuration and template configuration mode. To return to the default settings, use
the no form of this command.
spanning-tree bpduguard { enable | disable }
no spanning-tree bpduguard
Syntax Description enable Enables BPDU guard on this interface.
disable Disables BPDU guard on this interface.
Command Modes Interface configuration (config-if)
Template configuration (config-template)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines BPDU guard prevents a port from receiving BPDUs. Typically, this feature is used in a service-provider
environment where the network administrator wants to prevent an access port from participating in the spanning
tree. If the port still receives a BPDU, it is put in the error-disabled state as a protective measure. This command
has three states:
• spanning-tree bpduguard enable: Unconditionally enables BPDU guard on the interface.
• spanning-tree bpduguard disable: Unconditionally disables BPDU guard on the interface.
• no spanning-tree bpduguard: E nables BPDU guard on the interface if it is in the operational PortFast
state and if the spanning-tree portfast bpduguard default command is configured.
Examples This example shows how to enable BPDU guard on this interface:
Device(config-if)# spanning-tree bpduguard enable
Device(config-if)#
The following example shows how to enable BPDU guard on an interface using interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree bpduguard enable
Device(config-template)# end
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
967
Layer 2/3
spanning-tree bpduguard
Command Description
spanning-tree portfast edge bpduguard default Enables BPDU guard by default on all PortFast ports.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
968
Layer 2/3
spanning-tree bridge assurance
spanning-tree bridge assurance
To enable bridge assurance on all network ports on the device, use the spanning-tree bridge assurance
command in global configuration mode. To disable bridge assurance, use the no form of this command.
spanning-tree bridge assurance
no spanning-tree bridge assurance
Syntax Description This command has no arguments or keywords.
Command Default Bridge assurance is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Bridge assurance protects against a unidirectional link failure or other software failure and a device that
continues to forward data traffic when it is no longer running the spanning tree algorithm.
Bridge assurance is enabled only on spanning tree network ports that are point-to-point links. Both ends of
the link must have bridge assurance enabled. If the device on one side of the link has bridge assurance enabled
and the device on the other side either does not support bridge assurance or does not have this feature enabled,
the connecting port is blocked.
Disabling bridge assurance causes all configured network ports to behave as normal spanning tree ports.
Examples This example shows how to enable bridge assurance on all network ports on the switch:
Device(config)#
spanning-tree bridge assurance
Device(config)#
This example shows how to disable bridge assurance on all network ports on the switch:
Device(config)#
no spanning-tree bridge assurance
Device(config)#
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
969
Layer 2/3
spanning-tree cost
spanning-tree cost
To set the path cost of the interface for Spanning Tree Protocol (STP) calculations, use the spanning-tree
cost command in interface configuration or template configuration mode. To revert to the default value, use
the no form of this command.
spanning-tree cost cost
no spanning-tree cost
Syntax Description cost Path cost. The range is from 1 to 200000000.
Command Modes Interface configuration (config-if)
Template configuration (config-template)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines When you specify a value for the cost argument, higher values indicate higher costs. This range applies
regardless of the protocol type specified.
If a loop occurs, spanning tree uses the path cost when selecting an interface to place into the forwarding state.
A lower path cost represents higher-speed transmission.
Examples The following example shows how to access an interface and set a path cost value of 250 for the
spanning tree VLAN associated with that interface:
Router(config)# interface ethernet 2/0
Router(config-if)# spanning-tree cost 250
The following example shows how to set a path cost value of 250 for the spanning tree VLAN
associated with an interface using an interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree cost 250
Device(config-template)# end
Related Commands Command Description
show spanning-tree Displays spanning-tree information for the specified spanning-tree
instances.
spanning-tree port-priority Sets an interface priority when two bridges tie for position as the root
bridge.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
970
Layer 2/3
spanning-tree cost
Command Description
spanning-tree portfast (global) Enables PortFast mode, where the interface is immediately put into the
forwarding state upon linkup without waiting for the timer to expire.
spanning-tree portfast (interface) Enables PortFast mode, where the interface is immediately put into the
forwarding state upon linkup without waiting for the timer to expire.
spanning-tree uplinkfast Enables the UplinkFast feature.
spanning-tree vlan Configures STP on a per-VLAN basis.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
971
Layer 2/3
spanning-tree etherchannel guard misconfig
spanning-tree etherchannel guard misconfig
To display an error message when a loop due to a channel misconfiguration is detected, use the spanning-tree
etherchannel guard misconfig command in global configuration mode. To disable the error message, use
the no form of this command.
spanning-tree etherchannel guard misconfig
no spanning-tree etherchannel guard misconfig
Syntax Description This command has no arguments or keywords.
Command Default Error messages are displayed.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines EtherChannel uses either Port Aggregation Protocol (PAgP) or Link Aggregation Control Protocol (LACP)
and does not work if the EtherChannel mode of the interface is enabled using the channel-group group-number
mode on command.
The spanning-tree etherchannel guard misconfig command detects two types of errors: misconfiguration
and misconnection errors. A misconfiguration error is an error between the port-channel and an individual
port. A misconnection error is an error between a device that is channeling more ports and a device that is not
using enough Spanning Tree Protocol (STP) Bridge Protocol Data Units (BPDUs) to detect the error. In this
case, the device will only error disable an EtherChannel if the switch is a nonroot device.
When an EtherChannel-guard misconfiguration is detected, this error message displays:
msgdef(CHNL_MISCFG, SPANTREE, LOG_CRIT, 0, “Detected loop due to etherchannel misconfiguration
of %s %s”)
To determine which local ports are involved in the misconfiguration, enter the show interfaces status
err-disabled command. To check the EtherChannel configuration on the remote device, enter the show
etherchannel summary command on the remote device.
After you correct the configuration, enter the shutdown and the no shutdown commands on the associated
port-channel interface.
Examples This example shows how to enable the EtherChannel-guard misconfiguration:
Device(config)# spanning-tree etherchannel guard misconfig
Device(config)#
Related Commands Command Description
show etherchannel summary Displays the EtherChannel information for a channel.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
972
Layer 2/3
spanning-tree etherchannel guard misconfig
Command Description
show interfaces status err-disabled Displays the interface status or a list of interfaces in an error-disabled
state on LAN ports only.
shutdown Disables an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
973
Layer 2/3
spanning-tree extend system-id
spanning-tree extend system-id
To enable the extended-system ID feature on chassis that support 1024 MAC addresses, use the spanning-tree
extend system-id command in global configuration mode. To disable the extended system identification, use
the no form of this command.
spanning-tree extend system-id
no spanning-tree extend system-id
Syntax Description This command has no arguments or keywords.
Command Default Enabled on systems that do not provide 1024 MAC addresses.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Enabling or disabling the extended-system ID updates the bridge IDs of all active Spanning Tree Protocol
(STP) instances, which might change the spanning-tree topology.
Examples This example shows how to enable the extended-system ID:
Device(config)# spanning-tree extend system-id
Device(config)#
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
974
Layer 2/3
spanning-tree guard
spanning-tree guard
To enable or disable the guard mode, use the spanning-tree guard command in interface configuration and
template configuration mode. To return to the default settings, use the no form of this command.
spanning-tree guard { loop | root | none }
no spanning-tree guard
Syntax Description loop Enables the loop-guard mode on the interface.
root Enables root-guard mode on the interface.
none Sets the guard mode to none.
Command Default Guard mode is disabled.
Command Modes Interface configuration (config-if)
Template configuration (config-template)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples This example shows how to enable root guard:
Device(config-if)# spanning-tree guard root
Device(config-if)#
The following example shows how to enable root guard on an interface using an interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree guard root
Device(config-template)# end
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
spanning-tree loopguard default Enables loop guard as a default on all ports of a given bridge.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
975
Layer 2/3
spanning-tree link-type
spanning-tree link-type
To configure a link type for a port, use the spanning-tree link-type command in the interface configuration
and template configuration mode. To return to the default settings, use the no form of this command.
spanning-tree link-type { point-to-point | shared }
no spanning-tree link-type
Syntax Description point-to-point Specifies that the interface is a point-to-point link.
shared Specifies that the interface is a shared medium.
Command Default Link type is automatically derived from the duplex setting unless you explicitly configure the link type.
Command Modes Interface configuration (config-if)
Template configuration (config-template)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Rapid Spanning Tree Protocol Plus (RSTP+) fast transition works only on point-to-point links between two
bridges.
By default, the switch derives the link type of a port from the duplex mode. A full-duplex port is considered
as a point-to-point link while a half-duplex configuration is assumed to be on a shared link.
If you designate a port as a shared link, RSTP+ fast transition is forbidden, regardless of the duplex setting.
If you connect a port (local port) to a remote port through a point-to-point link and the local port becomes a
designated port, the device negotiates with the remote port and rapidly changes the local port to the forwarding
state
Examples This example shows how to configure the port as a shared link:
Device(config-if)# spanning-tree link-type shared
Device(config-if)#
The following example shows how to configure the port as a shared link using an interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree link-type shared
Device(config-template)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
976
Layer 2/3
spanning-tree link-type
Related Commands Command Description
show spanning-tree interface Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
977
Layer 2/3
spanning-tree loopguard default
spanning-tree loopguard default
To enable loop guard as a default on all ports of a given bridge, use the spanning-tree loopguard default
command in global configuration mode. To disable loop guard, use the no form of this command.
spanning-tree loopguard default
no spanning-tree loopguard default
Syntax Description This command has no arguments or keywords.
Command Default Loop guard is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Loop guard provides additional security in the bridge network. Loop guard prevents alternate or root ports
from becoming the designated port due to a failure that could lead to a unidirectional link.
Loop guard operates only on ports that are considered point to point by the spanning tree.
The individual loop-guard port configuration overrides this command.
Examples This example shows how to enable loop guard:
Device(config)# spanning-tree loopguard default
Device(config)#
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
spanning-tree guard Enables or disables the guard mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
978
Layer 2/3
spanning-tree mode
spanning-tree mode
To switch between Per-VLAN Spanning Tree+ (PVST+), Rapid-PVST+, and Multiple Spanning Tree (MST)
modes, use the spanning-tree mode command in global configuration mode. To return to the default settings,
use the no form of this command.
spanning-tree mode [{ pvst | mst | rapid-pvst }]
no spanning-tree mode
Syntax Description pvst (Optional) PVST+ mode.
mst (Optional) MST mode.
rapid-pvst (Optional) Rapid-PVST+ mode.
Command Default pvst
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines
Note Be careful when using the spanning-tree mode command to switch between PVST+, Rapid-PVST+, and
MST modes. When you enter the command, all spanning-tree instances are stopped for the previous mode
and are restarted in the new mode. Using this command may cause disruption of user traffic.
Examples This example shows how to switch to MST mode:
Device(config)# spanning-tree mode mst
Device(config)#
This example shows how to return to the default mode (PVST+):
Device(config)# no spanning-tree mode
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
979
Layer 2/3
spanning-tree mst
spanning-tree mst
To set the priority parameters or configure the device as a root for any Multiple Spanning Tree (MST) instance,
use the spanning-tree mst command in interface configuration mode. To return to the default settings, use
the no form of this command.
spanning-tree mst instance-id { priority priority | root { primary | secondary } }
no spanning-tree mst instance-id { { priority priority | root { primary | secondary } } }
Syntax Description priority priority Port priority for an instance. The range is from 0 to 61440 in increments of 4096.
root Configures the device as a root.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples This example shows how to set the priority:
Device(config-if)#
spanning-tree mst 0 priority 1
Device(config-if)#
This example shows how to set the device as a primary root:
Device(config-if)#
spanning-tree mst 0 root primary
Device(config-if)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
980
Layer 2/3
spanning-tree mst configuration
spanning-tree mst configuration
To enter MST-configuration submode, use the spanning-tree mst configuration command in global
configuration mode. To return to the default settings, use the no form of this command.
spanning-tree mst configuration
no spanning-tree mst configuration
Syntax Description This command has no arguments or keywords.
Command Default The default value for the Multiple Spanning Tree (MST) configuration is the default value for all its parameters:
• No VLANs are mapped to any MST instance (all VLANs are mapped to the Common and Internal
Spanning Tree [CIST] instance).
• The region name is an empty string.
• The revision number is 0.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The MST configuration consists of three main parameters:
• Instance VLAN mapping: See the instance command.
• Region name: See the name command (MST configuration submode).
• Configuration revision number: See the revision command.
The abort and exit commands allow you to exit MST configuration submode. The difference between the
two commands depends on whether you want to save your changes or not.
The exit command commits all the changes before leaving MST configuration submode. If you do not map
secondary VLANs to the same instance as the associated primary VLAN, when you exit MST-configuration
submode, a warning message displays and lists the secondary VLANs that are not mapped to the same instance
as the associated primary VLAN. The warning message is as follows:
These secondary vlans are not mapped to the same instance as their primary:
-> 3
The abort command leaves MST-configuration submode without committing any changes.
Changing an MST-configuration submode parameter can cause connectivity loss. To reduce service disruptions,
when you enter MST-configuration submode, make changes to a copy of the current MST configuration.
When you are done editing the configuration, you can apply all the changes at once by using the exit keyword,
or you can exit the submode without committing any change to the configuration by using the abort keyword.
In the unlikely event that two users commit a new configuration at exactly at the same time, this warning
message displays:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
981
Layer 2/3
spanning-tree mst configuration
% MST CFG:Configuration change lost because of concurrent access
Examples This example shows how to enter MST-configuration submode:
Device(config)# spanning-tree mst configuration
Device(config-mst)#
This example shows how to reset the MST configuration to the default settings:
Device(config)# no spanning-tree mst configuration
Device(config)#
Related Commands Command Description
instance Maps a VLAN or a set of VLANs to an MST instance.
name (MST) 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.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
982
Layer 2/3
spanning-tree mst forward-time
spanning-tree mst forward-time
To set the forward-delay timer for all the instances on the device, use the spanning-tree mst forward-time
command in global configuration mode. To return to the default settings, use the no form of this command.
spanning-tree mst forward-time seconds
no spanning-tree mst forward-time
Syntax Description seconds Number of seconds to set the forward-delay timer for all the instances on the device. The range
is from 4 to 30 seconds.
Command Default 15 seconds.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples This example shows how to set the forward-delay timer:
Device(config)# spanning-tree mst forward-time 20
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
983
Layer 2/3
spanning-tree mst hello-time
spanning-tree mst hello-time
To set the hello-time delay timer for all the instances on the device, use the spanning-tree mst hello-time
command in global configuration mode. To return to the default settings, use the no form of this command.
spanning-tree mst hello-time seconds
no spanning-tree mst hello-time
Syntax Description seconds Number of seconds to set the hello-time delay timer for all the instances on the device. The range
is from 1 to 10 in seconds.
Command Default 2 seconds
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines If you do not specify the hello-time value, the value is calculated from the network diameter.
Examples This example shows how to set the hello-time delay timer:
Device(config)# spanning-tree mst hello-time 3
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
984
Layer 2/3
spanning-tree mst max-age
spanning-tree mst max-age
To set the max-age timer for all the instances on the device, use the spanning-tree mst max-age command
in global configuration mode. To return to the default settings, use the no form of this command.
spanning-tree mst max-age seconds
no spanning-tree mst max-age
Syntax Description seconds Number of seconds to set the max-age timer for all the instances on the device. The range is from
6 to 40 in seconds.
Command Default 20 seconds
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples This example shows how to set the max-age timer:
Device(config)# spanning-tree mst max-age 40
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
985
Layer 2/3
spanning-tree mst max-hops
spanning-tree mst max-hops
To specify the number of possible hops in the region before a bridge protocol data unit (BPDU) is discarded,
use the spanning-tree mst max-hops command in global configuration mode. To return to the default settings,
use the no form of this command.
spanning-tree mst max-hops hopnumber
no spanning-tree mst max-hops
Syntax Description hopnumber Number of possible hops in the region before a BPDU is discarded. The range is from 1 to
255 hops.
Command Default 20 hops
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples This example shows how to set the number of possible hops:
Device(config)# spanning-tree mst max-hops 25
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
986
Layer 2/3
spanning-tree mst pre-standard
spanning-tree mst pre-standard
To configure a port to transmit only prestandard bridge protocol data units (BPDUs), use the spanning-tree
mst pre-standard command in interface configuration mode. To return to the default settings, use the no
form of this command.
spanning-tree mst pre-standard
no spanning-tree mst pre-standard
Syntax Description This command has no arguments or keywords.
Command Default The default is to automatically detect prestandard neighbors.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Even with the default configuration, the port can receive both prestandard and standard BPDUs.
Prestandard BPDUs are based on the Cisco IOS Multiple Spanning Tree (MST) implementation that was
created before the IEEE standard was finalized. Standard BPDUs are based on the finalized IEEE standard.
If you configure a port to transmit prestandard BPDUs only, the prestandard flag displays in the show
spanning-tree commands. The variations of the prestandard flag are as follows:
• Pre-STD (or pre-standard in long format): This flag displays if the port is configured to transmit
prestandard BPDUs and if a prestandard neighbor bridge has been detected on this interface.
• Pre-STD-Cf (or pre-standard (config) in long format): This flag displays if the port is configured to
transmit prestandard BPDUs but a prestandard BPDU has not been received on the port, the autodetection
mechanism has failed, or a misconfiguration, if there is no prestandard neighbor, has occurred.
• Pre-STD-Rx (or pre-standard (rcvd) in long format): This flag displays when a prestandard BPDU has
been received on the port but it has not been configured to send prestandard BPDUs. The port will send
prestandard BPDUs, but we recommend that you change the port configuration so that the interaction
with the prestandard neighbor does not rely only on the autodetection mechanism.
If the MST configuration is not compatible with the prestandard (if it includes an instance ID greater than
15), only standard MST BPDUs are transmitted, regardless of the STP configuration on the port.
Examples This example shows how to configure a port to transmit only prestandard BPDUs:
Router(config-if)# spanning-tree mst pre-standard
Router(config-if)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
987
Layer 2/3
spanning-tree mst pre-standard
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
988
Layer 2/3
spanning-tree mst priority
spanning-tree mst priority
To set the bridge priority for an instance, use the spanning-tree mst priority command in global configuration
mode. To return to the default setting, use the no form of this command.
spanning-tree mst instance priority priority
no spanning-tree mst priority
Syntax Description instance Instance identification number; valid values are from 0 to 4094.
priority priority Specifies the bridge priority; see the “Usage Guidelines” section for valid values and
additional information.
Command Default priority is 32768
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines You can set the bridge priority in increments of 4096 only. When you set the priority, valid values are 0, 4096,
8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, and 61440.
You can set the priority to 0 to make the switch root.
You can enter instance as a single instance or a range of instances, for example, 0-3,5,7-9.
Examples This example shows how to set the bridge priority:
Device(config)# spanning-tree mst 0 priority 4096
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
989
Layer 2/3
spanning-tree mst root
spanning-tree mst root
To designate the primary and secondary root switch and set the timer value for an instance, use the
spanning-tree mst root command in global configuration mode. To return to the default settings, use the no
form of this command.
spanning-tree mst instance root { primary | secondary } [ diameter diameter [ hello-time seconds
]]
no spanning-tree mst instance root
Syntax Description instance Instance identification number. The range is from 0 to 4094.
primary Specifies the high enough priority (low value) to make the root of the spanning-tree
instance.
secondary Specifies the switch as a secondary root, should the primary root fail.
diameter diameter (Optional) Specifies the timer values for the root switch that are based on the network
diameter. The range is from 1 to 7.
hello-time seconds (Optional) Specifies the duration between the generation of configuration messages
by the root switch.
Command Default The spanning-tree mst root command has no default settings.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines You can enter instance as a single instance or a range of instances, for example, 0-3,5,7-9.
The spanning-tree mst root secondary value is 16384.
The diameter diameter and hello-time seconds keywords and arguments are available for instance 0 only.
If you do not specify the seconds argument, the value for it is calculated from the network diameter.
Examples This example shows how to designate the primary root switch and timer values for an instance:
Router(config)# spanning-tree mst 0 root primary diameter 7 hello-time 2
Router(config)# spanning-tree mst 5 root primary
Router(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
990
Layer 2/3
spanning-tree mst simulate pvst global
spanning-tree mst simulate pvst global
To enable Per-VLAN Spanning Tree (PVST) simulation globally, enter the spanning-tree mst simulate pvst
global command in global configuration mode. To disable PVST simulation globally, enter the no form of
this command.
spanning-tree mst simulate pvst global
no spanning-tree mst simulate pvst global
Syntax Description This command has no arguments or keywords.
Command Default PVST simulation is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a Support for this command
was introduced.
Usage Guidelines PVST simulation is enabled by default so that all interfaces on the device interoperate between Multiple
Spanning Tree (MST) and Rapid Per-VLAN Spanning Tree Plus (PVST+). To prevent an accidental connection
to a device that does not run MST as the default Spanning Tree Protocol (STP) mode, you can disable PVST
simulation. If you disable PVST simulation, the MST-enabled port moves to the blocking state once it detects
it is connected to a Rapid PVST+-enabled port. This port remains in the inconsistent state until the port stops
receiving Bridge Protocol Data Units (BPDUs), and then the port resumes the normal STP transition process.
To override the global PVST simulation setting for a port, enter the spanning-tree mst simulate pvst interface
command in the interface command mode.
Examples This example shows how to prevent the switch from automatically interoperating with a connecting
device that is running Rapid PVST+:
Device(config)#
no spanning-tree mst simulate pvst global
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
991
Layer 2/3
spanning-tree pathcost method
spanning-tree pathcost method
To set the default path-cost calculation method, use the spanning-tree pathcost method command in global
configuration mode. To return to the default settings, use the no form of this command.
spanning-tree pathcost method { long | short }
no spanning-tree pathcost method
Syntax Description long Specifies the 32-bit based values for default port-path costs.
short Specifies the 16-bit based values for default port-path costs.
Command Default short
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The long path-cost calculation method utilizes all 32 bits for path-cost calculation and yields values in the
range of 1 through 200,000,000.
The short path-cost calculation method (16 bits) yields values in the range of 1 through 65535.
Examples This example shows how to set the default path-cost calculation method to long:
Device(config
#) spanning-tree pathcost method long
Device(config
#)
This example shows how to set the default path-cost calculation method to short:
Device(config
#) spanning-tree pathcost method short
Device(config
#)
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
992
Layer 2/3
spanning-tree port-priority
spanning-tree port-priority
To set an interface priority when two bridges tie for position as the root bridge, use the spanning-tree
port-priority command in interface configuration and template configuration mode. To revert to the default
value, use the no form of this command.
spanning-tree port-priority port-priority
no spanning-tree port-priority
Syntax Description port-priority Port priority. The range is from 0 to 240 in increments of 16 . The default is 128.
Command Default The default port priority is 128.
Command Modes Interface configuration (config-if)
Template configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The priority you set breaks the tie between two bridges to be designated as a root bridge.
Examples The following example shows how to increase the likelihood that spanning-tree instance 20 is chosen
as the root-bridge on interface Ethernet 2/0:
Device(config)# interface ethernet 2/0
Device(config-if)# spanning-tree port-priority 20
Device(config-if)#
The following example shows how increase the likelihood that spanning-tree instance 20 is chosen
as the root-bridge on an interface using an interface template:
Device# configure terminal
Device(config)# template user-template1
Device(config-template)# spanning-tree port-priority 20
Device(config-template)# end
Related Commands Command Description
show spanning-tree Displays spanning-tree information for the specified spanning-tree
instances.
spanning-tree cost Sets the path cost of the interface for STP calculations.
spanning-tree portfast (global) Enables PortFast mode, where the interface is immediately put into the
forwarding state upon linkup without waiting for the timer to expire.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
993
Layer 2/3
spanning-tree port-priority
Command Description
spanning-tree uplinkfast Enables the UplinkFast feature.
spanning-tree vlan Configures STP on a per-VLAN basis.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
994
Layer 2/3
spanning-tree portfast edge bpdufilter default
spanning-tree portfast edge bpdufilter default
To enable bridge protocol data unit (BPDU) filtering by default on all PortFast ports, use the spanning-tree
portfast edge bpdufilter default command in global configuration mode. To return to the default settings,
use the no form of this command.
spanning-tree portfast edge bpdufilter default
no spanning-tree portfast edge bpdufilter default
Syntax Description This command has no arguments or keywords.
Command Default Disabled
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The spanning-tree portfast edge bpdufilter command enables BPDU filtering globally on PortFast ports.
BPDU filtering prevents a port from sending or receiving any BPDUs.
You can override the effects of the portfast edge bpdufilter default command by configuring BPDU filtering
at the interface level.
Note Be careful when enabling BPDU filtering. The feature’s functionality is different when you enable it on a
per-port basis or globally. When enabled globally, BPDU filtering is applied only on ports that are in an
operational PortFast state. Ports send a few BPDUs at linkup before they effectively filter outbound BPDUs.
If a BPDU is received on an edge port, it immediately loses its operational PortFast status and BPDU filtering
is disabled. When enabled locally on a port, BPDU filtering prevents the device from receiving or sending
BPDUs on this port.
Caution Be careful when using this command. Using this command incorrectly can cause bridging loops.
Examples This example shows how to enable BPDU filtering by default:
Device(config)#
spanning-tree portfast edge bpdufilter default
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
995
Layer 2/3
spanning-tree portfast edge bpdufilter default
Command Description
spanning-tree bpdufilter Enables BPDU filtering on the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
996
Layer 2/3
spanning-tree portfast edge bpduguard default
spanning-tree portfast edge bpduguard default
To enable bridge protocol data unit (BPDU) guard by default on all PortFast ports, use the spanning-tree
portfast edge bpduguard default command in global configuration mode. To return to the default settings,
use the no form of this command.
spanning-tree portfast edge bpduguard default
no spanning-tree portfast edge bpduguard default
Syntax Description This command has no arguments or keywords.
Command Default Disabled
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines
Caution Be careful when using this command. You should use this command only with interfaces that connect to end
stations; otherwise, an accidental topology loop could cause a data-packet loop and disrupt the device and
network operation.
BPDU guard disables a port if it receives a BPDU. BPDU guard is applied only on ports that are PortFast
enabled and are in an operational PortFast state.
Examples This example shows how to enable BPDU guard by default:
Device(config)#
spanning-tree portfast edge bpduguard default
Device(config)#
Related Commands Command Description
show spanning-tree mst Displays the information about the MST protocol.
spanning-tree bpdufilter Enables BPDU filtering on the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
997
Layer 2/3
spanning-tree portfast default
spanning-tree portfast default
To enable PortFast by default on all access ports, use the spanning-tree portfast {edge | network | normal}
default command in global configuration mode. To disable PortFast by default on all access ports, use the
no form of this command.
spanning-tree portfast { edge [{ bpdufilter | bpduguard }] | network | normal } default
no spanning-tree portfast { edge [{ bpdufilter | bpduguard }] | network | normal } default
Syntax Description bpdufilter Enables PortFast edge BPDU filter by default on all PortFast edge ports.
bpduguard Enables PortFast edge BPDU guard by default on all PortFast edge ports.
edge Enables PortFast edge mode by default on all switch access ports.
network Enables PortFast network mode by default on all switch access ports.
normal Enables PortFast normal mode by default on all switch access ports.
Command Default PortFast is disabled by default on all access ports.
Command Modes Global configuration (config)
Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines
Note Be careful when using this command. You should use this command only with interfaces that connect to end
stations; otherwise, an accidental topology loop could cause a data-packet loop and disrupt the operation of
the router or switch and the network.
An interface with PortFast mode enabled is moved directly to the spanning-tree forwarding state when linkup
occurs without waiting for the standard forward-time delay.
You can enable PortFast mode on individual interfaces using the spanning-tree portfast (interface) command.
Examples This example shows how to enable PortFast edge mode with BPDU Guard by default on all access
ports:
Device(config)#
spanning-tree portfast edge bpduguard default
Device(config)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
998
Layer 2/3
spanning-tree portfast default
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
spanning-tree portfast (interface) Enables PortFast on a specific interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
999
Layer 2/3
spanning-tree transmit hold-count
spanning-tree transmit hold-count
To specify the transmit hold count, use the spanning-tree transmit hold-count command in global
configuration mode. To return to the default settings, use the no form of this command.
spanning-tree transmit hold-count value
no spanning-tree transmit hold-count
Syntax Description value Number of bridge protocol data units (BPDUs) that can be sent before pausing for 1 second. The
range is from 1 to 20.
Command Default value is 6
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines This command is supported on all spanning-tree modes.
The transmit hold count determines the number of BPDUs that can be sent before pausing for 1 second.
Note Changing this parameter to a higher value may have a significant impact on CPU utilization, especially in
rapid-Per-VLAN Spanning Tree (PVST) mode. Lowering this parameter could slow convergence in some
scenarios. We recommend that you do not change the value from the default setting.
If you change the value setting, enter the show running-config command to verify the change.
If you delete the command, use the show spanning-tree mst command to verify the deletion.
Examples This example shows how to specify the transmit hold count:
Device(config)# spanning-tree transmit hold-count 8
Device(config)#
Related Commands Command Description
show running-config Displays the status and configuration of the module or Layer 2 VLAN.
show spanning-tree mst Display the information about the MST protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1000
Layer 2/3
spanning-tree uplinkfast
spanning-tree uplinkfast
To enable UplinkFast, use the spanning-tree uplinkfast command in global configuration mode. To disable
UplinkFast, use the no form of this command.
spanning-tree uplinkfast [ max-update-rate packets-per-second ]
no spanning-tree uplinkfast [max-update-rate]
Syntax Description max-update-rate packets-per-second (Optional) Specifies the maximum rate (in packets per second) at
which update packets are sent. The range is from 0 to 32000.
Command Default The defaults are as follows:
• UplinkFast is disabled.
• packets-per-second is 150 packets per second.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Use the spanning-tree uplinkfast max-update-rate command to enable UplinkFast (if it is not already
enabled) and change the rate at which update packets are sent. Use the no form of this command to return to
the default rate.
Examples This example shows how to enable UplinkFast and set the maximum rate to 200 packets per second:
Device(config)#
spanning-tree uplinkfast max-update-rate 200
Device(config)#
Related Commands Command Description
show spanning-tree Displays information about the spanning-tree state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1001
Layer 2/3
spanning-tree vlan
spanning-tree vlan
To configure Spanning Tree Protocol (STP) on a per-virtual LAN (VLAN) basis, use the spanning-tree vlan
command in global configuration mode. To return to the default settings, use the no form of this command.
spanning-tree vlan vlan-id [{ forward-time seconds | hello-time seconds | max-age seconds | priority
priority | root [{ primary | secondary }] }]
no spanning-tree vlan vlan-id [{ forward-time | hello-time | max-age | priority | root }]
Syntax Description vlan id VLAN identification number. The range is from 1 to 4094.
forward-time seconds (Optional) Sets the STP forward delay time. The range is from 4 to 30 seconds.
hello-time seconds (Optional) Specifies the duration, in seconds, between the generation of configuration
messages by the root switch. The range is from 1 to 10 seconds.
max-age seconds (Optional) Sets the maximum number of seconds the information in a bridge packet
data unit (BPDU) is valid. the range is from 6 to 40 seconds.
priority priority (Optional) Sets the STP bridge priority. the range is from 0 to 65535.
root primary (Optional) Forces this switch to be the root bridge.
root secondary (Optional) Specifies this switch to act as the root switch should the primary root
fail.
Command Default The defaults are:
• forward-time: 15 seconds
• hello-time: 2 seconds
• max-age: 20 seconds
• priority: The default with IEEE STP enabled is 32768; the default with STP enabled is 128.
• root : No STP root
When you issue the no spanning-tree vlan vlan_id command, the following parameters are reset to their
defaults:
• priority: The default with IEEE STP enabled is 32768; the default with STP enabled is 128.
• hello-time: 2 seconds
• forward-time: 15 seconds
• max-age: 20 seconds
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1002
Layer 2/3
spanning-tree vlan
Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines
Caution • When disabling spanning tree on a VLAN using the no spanning-tree vlan vlan-id command, ensure
that all switches and bridges in the VLAN have spanning tree disabled. You cannot disable spanning
tree on some switches and bridges in a VLAN and leave it enabled on other switches and bridges in the
same VLAN because switches and bridges with spanning tree enabled have incomplete information about
the physical topology of the network.
• We do not recommend disabling spanning tree, even in a topology that is free of physical loops. Spanning
tree is a safeguard against misconfigurations and cabling errors. Do not disable spanning tree in a VLAN
without ensuring that there are no physical loops present in the VLAN.
When you set the max-age seconds parameter, if a bridge does not hear bridge protocol data units (BPDUs)
from the root bridge within the specified interval, it assumes that the network has changed and recomputes
the spanning-tree topology.
The spanning-tree root primary command alters this switch’s bridge priority to 8192. If you enter the
spanning-tree root primary command and the switch does not become the root switch, then the bridge
priority is changed to 100 less than the bridge priority of the current bridge. If the switch still does not become
the root, an error results.
The spanning-tree root secondary command alters this switch’s bridge priority to 16384. If the root switch
should fail, this switch becomes the next root switch.
Use the spanning-tree root commands on backbone switches only.
The spanning-tree etherchannel guard misconfig command detects two types of errors: misconfiguration
and misconnection errors. A misconfiguration error is an error between the port-channel and an individual
port. A misconnection error is an error between a switch that is channeling more ports and a switch that is not
using enough Spanning Tree Protocol (STP) Bridge Protocol Data Units (BPDUs) to detect the error. In this
case, the switch will only error disable an EtherChannel if the switch is a nonroot switch.
Examples The following example shows how to enable spanning tree on VLAN 200:
Device(config)# spanning-tree vlan 200
The following example shows how to configure the switch as the root switch for VLAN 10 with a
network diameter of 4:
Device(config)# spanning-tree vlan 10 root primary diameter 4
The following example shows how to configure the switch as the secondary root switch for VLAN
10 with a network diameter of 4:
Device(config)# spanning-tree vlan 10 root secondary diameter 4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1003
Layer 2/3
spanning-tree vlan
Related Commands Command Description
spanning-tree cost Sets the path cost of the interface for STP calculations.
spanning-tree etherchannel guard Displays an error message when a loop due to a channel
misconfig misconfiguration is detected
spanning-tree port-priority Sets an interface priority when two bridges tie for position as
the root bridge.
spanning-tree uplinkfast Enables the UplinkFast feature.
show spanning-tree Displays spanning-tree information for the specified
spanning-tree instances.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1004
Layer 2/3
switchport
switchport
To put an interface that is in Layer 3 mode into Layer 2 mode for Layer 2 configuration, use the switchport
command in interface configuration mode. To put an interface in Layer 3 mode, use the no form of this
command.
switchport
no switchport
Command Default By default, all interfaces are in Layer 2 mode.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the no switchport command (without parameters) to set the interface to the routed-interface status and
to erase all Layer 2 configurations. You must use this command before assigning an IP address to a routed
port.
Entering the no switchport command shuts the port down and then reenables it, which might generate messages
on the device to which the port is connected.
When you put an interface that is in Layer 2 mode into Layer 3 mode (or the reverse), the previous configuration
information related to the affected interface might be lost, and the interface is returned to its default
configuration.
Note If an interface is configured as a Layer 3 interface, you must first enter the switchport command to configure
the interface as a Layer 2 port. Then you can enter the switchport access vlan and switchport mode commands.
The switchport command is not used on platforms that do not support Cisco-routed ports. All physical ports
on such platforms are assumed to be Layer 2-switched interfaces.
You can verify the port status of an interface by entering the show running-config privileged EXEC command.
Examples This example shows how to cause an interface to cease operating as a Layer 2 port and become a
Cisco-routed port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# no switchport
This example shows how to cause the port interface to cease operating as a Cisco-routed port and
convert to a Layer 2 switched interface:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1005
Layer 2/3
switchport access vlan
switchport access vlan
To configure a port as a static-access port, use the switchport access vlan command in interface configuration
mode. To reset the access mode to the default VLAN mode for the device, use the no form of this command.
switchport access vlan {vlan-id }
no switchport access vlan
Syntax Description vlan-id VLAN ID of the access mode VLAN; the range is 1 to 4094.
Command Default The default access VLAN and trunk interface native VLAN is a default VLAN corresponding to the platform
or interface hardware.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The port must be in access mode before the switchport access vlan command can take effect.
If the switchport mode is set to access vlan vlan-id, the port operates as a member of the specified VLAN.
An access port can be assigned to only one VLAN.
The no switchport access command resets the access mode VLAN to the appropriate default VLAN for the
device.
Examples This example shows how to change a switched port interface that is operating in access mode to
operate in VLAN 2 instead of the default VLAN:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport access vlan 2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1006
Layer 2/3
switchport mode
switchport mode
To configure the VLAN membership mode of a port, use the switchport mode command in interface
configuration mode. To reset the mode to the appropriate default for the device, use the no form of this
command.
switchport mode {access | dynamic | {auto | desirable} | trunk}
noswitchport mode {access | dynamic | {auto | desirable} | trunk}
Syntax Description access Sets the port to access mode (either static-access or dynamic-access depending on the
setting of the switchport access vlan interface configuration command). The port is
set to access unconditionally and operates as a nontrunking, single VLAN interface that
sends and receives nonencapsulated (non-tagged) frames. An access port can be assigned
to only one VLAN.
dynamic auto Sets the port trunking mode dynamic parameter to auto to specify that the interface
convert the link to a trunk link. This is the default switchport mode.
dynamic Sets the port trunking mode dynamic parameter to desirable to specify that the interface
desirable actively attempt to convert the link to a trunk link.
trunk Sets the port to trunk unconditionally. The port is a trunking VLAN Layer 2 interface.
The port sends and receives encapsulated (tagged) frames that identify the VLAN of
origination. A trunk is a point-to-point link between two switches or between a switch
and a router.
Command Default The default mode is dynamic auto.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A configuration that uses the access,or trunk keywords takes effect only when you configure the port in the
appropriate mode by using the switchport mode command. The static-access and trunk configuration are
saved, but only one configuration is active at a time.
When you enter access mode, the interface changes to permanent nontrunking mode and negotiates to convert
the link into a nontrunk link even if the neighboring interface does not agree to the change.
When you enter trunk mode, the interface changes to permanent trunking mode and negotiates to convert
the link into a trunk link even if the interface connecting to it does not agree to the change.
When you enter dynamic auto mode, the interface converts the link to a trunk link if the neighboring interface
is set to trunk or desirable mode.
When you enter dynamic desirable mode, the interface becomes a trunk interface if the neighboring interface
is set to trunk, desirable, or auto mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1007
Layer 2/3
switchport mode
To autonegotiate trunking, the interfaces must be in the same VLAN Trunking Protocol (VTP) domain. Trunk
negotiation is managed by the Dynamic Trunking Protocol (DTP), which is a point-to-point protocol. However,
some internetworking devices might forward DTP frames improperly, which could cause misconfigurations.
To avoid this problem, configure interfaces connected to devices that do not support DTP to not forward DTP
frames, which turns off DTP.
• If you do not intend to trunk across those links, use the switchport mode access command in interface
configuration mode to disable trunking.
• To enable trunking to a device that does not support DTP, use the switchport mode trunk and switchport
nonegotiate commands in interface configuration mode to cause the interface to become a trunk but to
not generate DTP frames.
Access ports and trunk ports are mutually exclusive.
The IEEE 802.1x feature interacts with switchport modes in these ways:
• If you try to enable IEEE 802.1x on a trunk port, an error message appears, and IEEE 802.1x is not
enabled. If you try to change the mode of an IEEE 802.1x-enabled port to trunk, the port mode is not
changed.
• If you try to enable IEEE 802.1x on a port set to dynamic auto or dynamic desirable, an error message
appears, and IEEE 802.1x is not enabled. If you try to change the mode of an IEEE 802.1x-enabled port
to dynamic auto or dynamic desirable, the port mode is not changed.
• If you try to enable IEEE 802.1x on a dynamic-access (VLAN Query Protocol [VQP]) port, an error
message appears, and IEEE 802.1x is not enabled. If you try to change an IEEE 802.1x-enabled port to
dynamic VLAN assignment, an error message appears, and the VLAN configuration is not changed.
You can verify your settings by entering the show interfaces interface-id switchport command in privileged
EXEC mode and examining information in the Administrative Mode and Operational Mode rows.
Examples This example shows how to configure a port for access mode:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport mode access
This example shows how set the port to dynamic desirable mode:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport mode dynamic desirable
This example shows how to configure a port for trunk mode:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport mode trunk
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1008
Layer 2/3
switchport nonegotiate
switchport nonegotiate
To specify that Dynamic Trunking Protocol (DTP) negotiation packets are not sent on the Layer 2 interface,
use the switchport nonegotiate command in interface configuration mode. Use the no form of this command
to return to the default setting.
switchport nonegotiate
no switchport nonegotiate
Command Default The default is to use DTP negotiation to learn the trunking status.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The no switchport nonegotiate command removes nonegotiate status.
This command is valid only when the interface switchport mode is access or trunk (configured by using the
switchport mode access or the switchport mode trunk interface configuration command). This command
returns an error if you attempt to execute it in dynamic (auto or desirable) mode.
Internetworking devices that do not support DTP might forward DTP frames improperly and cause
misconfigurations. To avoid this problem, turn off DTP by using the switchport nonegotiate command to
configure the interfaces connected to devices that do not support DTP to not forward DTP frames.
When you enter the switchport nonegotiate command, DTP negotiation packets are not sent on the interface.
The device does or does not trunk according to the mode parameter: access or trunk.
• If you do not intend to trunk across those links, use the switchport mode access interface configuration
command to disable trunking.
• To enable trunking on a device that does not support DTP, use the switchport mode trunk and switchport
nonegotiate interface configuration commands to cause the interface to become a trunk but to not generate
DTP frames.
This example shows how to cause a port to refrain from negotiating trunking mode and to act as a
trunk or access port (depending on the mode set):
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet2/0/1
Device(config-if)# switchport nonegotiate
You can verify your setting by entering the show interfaces interface-id switchport command in
privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1009
Layer 2/3
switchport trunk
switchport trunk
To set the trunk characteristics when the interface is in trunking mode, use the switchport trunk command
in interface configuration mode. To reset a trunking characteristic to the default, use the no form of this
command.
switchport trunk {allowed vlan vlan-list | native vlan vlan-id | pruning vlan vlan-list}
no switchport trunk {allowed vlan | native vlan | pruning vlan}
Syntax Description allowed vlan vlan-list Sets the list of allowed VLANs that can receive and send traffic on this interface
in tagged format when in trunking mode. See the Usage Guidelines for the vlan-list
choices.
native vlan vlan-id Sets the native VLAN for sending and receiving untagged traffic when the interface
is in IEEE 802.1Q trunking mode. The range is 1 to 4094.
pruning vlan vlan-list Sets the list of VLANs that are eligible for VTP pruning when in trunking mode.
See the Usage Guidelines for the vlan-list choices.
Command Default VLAN 1 is the default native VLAN ID on the port.
The default for all VLAN lists is to include all VLANs.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The vlan-list format is all | none | [add | remove | except] vlan-atom [,vlan-atom...]:
• all specifies all VLANs from 1 to 4094. This is the default. This keyword is not allowed on commands
that do not permit all VLANs in the list to be set at the same time.
• none specifies an empty list. This keyword is not allowed on commands that require certain VLANs to
be set or at least one VLAN to be set.
• add adds the defined list of VLANs to those currently set instead of replacing the list. Valid IDs are from
1 to 1005; extended-range VLANs (VLAN IDs greater than 1005) are valid in some cases.
Note You can add extended-range VLANs to the allowed VLAN list, but not to the
pruning-eligible VLAN list.
Separate nonconsecutive VLAN IDs with a comma; use a hyphen to designate a range of IDs.
• remove removes the defined list of VLANs from those currently set instead of replacing the list. Valid
IDs are from 1 to 1005; extended-range VLAN IDs are valid in some cases.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1010
Layer 2/3
switchport trunk
Note You can remove extended-range VLANs from the allowed VLAN list, but you
cannot remove them from the pruning-eligible list.
• except lists the VLANs that should be calculated by inverting the defined list of VLANs. (VLANs are
added except the ones specified.) Valid IDs are from 1 to 1005. Separate nonconsecutive VLAN IDs
with a comma; use a hyphen to designate a range of IDs.
• vlan-atom is either a single VLAN number from 1 to 4094 or a continuous range of VLANs described
by two VLAN numbers, the lesser one first, separated by a hyphen.
Native VLANs:
• All untagged traffic received on an IEEE 802.1Q trunk port is forwarded with the native VLAN configured
for the port.
• If a packet has a VLAN ID that is the same as the sending-port native VLAN ID, the packet is sent
without a tag; otherwise, the switch sends the packet with a tag.
• The no form of the native vlan command resets the native mode VLAN to the appropriate default VLAN
for the device.
Allowed VLAN:
• To reduce the risk of spanning-tree loops or storms, you can disable VLAN 1 on any individual VLAN
trunk port by removing VLAN 1 from the allowed list. When you remove VLAN 1 from a trunk port,
the interface continues to send and receive management traffic, for example, Cisco Discovery Protocol
(CDP), Port Aggregation Protocol (PAgP), Link Aggregation Control Protocol (LACP), Dynamic
Trunking Protocol (DTP), and VLAN Trunking Protocol (VTP) in VLAN 1.
• The no form of the allowed vlan command resets the list to the default list, which allows all VLANs.
Trunk pruning:
• The pruning-eligible list applies only to trunk ports.
• Each trunk port has its own eligibility list.
• If you do not want a VLAN to be pruned, remove it from the pruning-eligible list. VLANs that are
pruning-ineligible receive flooded traffic.
• VLAN 1, VLANs 1002 to 1005, and extended-range VLANs (VLANs 1006 to 4094) cannot be pruned.
This example shows how to configure VLAN 3 as the default for the port to send all untagged traffic:
Device> enable
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# switchport trunk native vlan 3
This example shows how to add VLANs 1, 2, 5, and 6 to the allowed list:
Device> enable
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# switchport trunk allowed vlan add 1,2,5,6
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1011
Layer 2/3
switchport trunk
This example shows how to remove VLANs 3 and 10 to 15 from the pruning-eligible list:
Device> enable
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# switchport trunk pruning vlan remove 3,10-15
You can verify your settings by entering the show interfaces interface-id switchport privileged
EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1012
Layer 2/3
switchport voice vlan
switchport voice vlan
To configure voice VLAN on the port, use the switchport voice vlan command in interface configuration
mode. To return to the default setting, use the no form of this command.
switchport voice vlan {vlan-id | dot1p | none | untagged | name vlan_name}
no switchport voice vlan
Syntax Description vlan-id The VLAN to be used for voice traffic. The range is 1 to 4094. By default, the IP phone
forwards the voice traffic with an IEEE 802.1Q priority of 5.
dot1p Configures the telephone to use IEEE 802.1p priority tagging and uses VLAN 0 (the
native VLAN). By default, the Cisco IP phone forwards the voice traffic with an IEEE
802.1p priority of 5.
none Does not instruct the IP telephone about the voice VLAN. The telephone uses the
configuration from the telephone key pad.
untagged Configures the telephone to send untagged voice traffic. This is the default for the
telephone.
name vlan_name (Optional) Specifies the VLAN name to be used for voice traffic. You can enter up to
128 characters.
Command Default The default is not to automatically configure the telephone (none).
The telephone default is not to tag frames.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You should configure voice VLAN on Layer 2 access ports.
You must enable Cisco Discovery Protocol (CDP) on the switch port connected to the Cisco IP phone for the
device to send configuration information to the phone. CDP is enabled by default globally and on the interface.
When you enter a VLAN ID, the IP phone forwards voice traffic in IEEE 802.1Q frames, tagged with the
specified VLAN ID. The device puts IEEE 802.1Q voice traffic in the voice VLAN.
When you select dot1p, none, or untagged, the device puts the indicated voice traffic in the access VLAN.
In all configurations, the voice traffic carries a Layer 2 IP precedence value. The default is 5 for voice traffic.
When you enable port security on an interface that is also configured with a voice VLAN, set the maximum
allowed secure addresses on the port to 2. When the port is connected to a Cisco IP phone, the IP phone
requires one MAC address. The Cisco IP phone address is learned on the voice VLAN, but not on the access
VLAN. If you connect a single PC to the Cisco IP phone, no additional MAC addresses are required. If you
connect more than one PC to the Cisco IP phone, you must configure enough secure addresses to allow one
for each PC and one for the Cisco IP phone.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1013
Layer 2/3
switchport voice vlan
If any type of port security is enabled on the access VLAN, dynamic port security is automatically enabled
on the voice VLAN.
You cannot configure static secure MAC addresses in the voice VLAN.
A voice-VLAN port cannot be a private-VLAN port.
The Port Fast feature is automatically enabled when voice VLAN is configured. When you disable voice
VLAN, the Port Fast feature is not automatically disabled.
This example show how to first populate the VLAN database by associating a VLAN ID with a
VLAN name, and then configure the VLAN (using the name) on an interface, in the access mode:
You can also verify your configuration by entering the show interfaces interface-id switchport in
privileged EXEC command and examining information in the Voice VLAN: row.
Part 1 - Making the entry in the VLAN database:
Device> enable
Device# configure terminal
Device(config)# vlan 55
Device(config-vlan)# name test
Device(config-vlan)# end
Part 2 - Checking the VLAN database:
Device> enable
Device# show vlan id 55
VLAN Name Status Ports
---- -------------------------------- --------- -------------------------------
55 test active
VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
---- ----- ------ ---- ----- ------ -------- --- -------- ------ ------
55 enet 100055 1500 - - - - - 0 0
Remote SPAN VLAN
----------------
Disabled
Primary Secondary Type Ports
------- --------- ----------------- ------------------------------------------
Part 3- Assigning VLAN to the interface by using the name of the VLAN:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet3/1/1
Device(config-if)# switchport mode access
Device(config-if)# switchport voice vlan name test
Device(config-if)# end
Device#
Part 4 - Verifying configuration:
Device> enable
Device# show running-config
interface gigabitethernet3/1/1
Building configuration...
Current configuration : 113 bytes
!
interface GigabitEthernet3/1/1
switchport voice vlan 55
switchport mode access
Switch#
Part 5 - Also can be verified in interface switchport:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1014
Layer 2/3
switchport voice vlan
Device> enable
Device# show interface GigabitEthernet3/1/1 switchport
Name: Gi3/1/1
Switchport: Enabled
Administrative Mode: static access
Operational Mode: static access
Administrative Trunking Encapsulation: dot1q
Operational Trunking Encapsulation: native
Negotiation of Trunking: Off
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 1 (default)
Administrative Native VLAN tagging: enabled
Voice VLAN: 55 (test)
Administrative private-vlan host-association: none
Administrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: none
Administrative private-vlan trunk Native VLAN tagging: enabled
Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: none
Administrative private-vlan trunk associations: none
Administrative private-vlan trunk mappings: none
Operational private-vlan: none
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled
Capture VLANs Allowed: ALL
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1015
Layer 2/3
transport unicast ipv4 local loopback
transport unicast ipv4 local loopback
To configure a unicast IPv4 connection from a loopback interface, use the transport unicast ipv4 local
loopback command in property configuration mode.
transport unicast ipv4 local loopback value
Syntax Description value Loopback interface number. The maximum number
of sessions supported is 127.
Command Default None
Command Modes Property configuration (config-property)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Configure the PTP property name using the ptp property command before configuring a unicast IPv4
connection from a loopback interface.
Examples The following example shows how to configure a unicast IPv4 connection from a loopback interface:
Device> enable
Device# configure terminal
Device(config)# ptp property cisco1
Device(config-property)# transport unicast ipv4 local loopback 0
Device(config-property-transport)# peer ip 192.0.2.1
Device(config-property-transport)# end
Related Commands Command Description
peer Connects to a peer PTP-aware device.
ptp dot1as extend property Extends IEEE 802.1AS profile to a PTP-property name
ptp property Sets the PTP-property name.
source ip interface (Optional) Configures the source IP interface.
show platform software fed active ptp Displays the PTP connection details and events of the specified
interface loopback loopback interface.
show ptp port loopback Displays PTP configurations of a loopback interface.
show ptp transport properties Displays PTP profile and its properties.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1016
Layer 2/3
udld
udld
To enable aggressive or normal mode in the UniDirectional Link Detection (UDLD) and to set the configurable
message timer time, use the udld command in global configuration mode. To disable aggressive or normal
mode UDLD on all fiber-optic ports, use the no form of the command.
udld {aggressive | enable | message time message-timer-interval}
no udld {aggressive | enable | message}
Syntax Description aggressive Enables UDLD in aggressive mode on all fiber-optic interfaces.
enable Enables UDLD in normal mode on all fiber-optic interfaces.
message time Configures the period of time between UDLD probe messages on ports
message-timer-interval that are in the advertisement phase and are determined to be bidirectional.
The range is 1 to 90 seconds. The default is 15 seconds.
Command Default UDLD is disabled on all interfaces.
The message timer is set at 15 seconds.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines UDLD supports two modes of operation: normal (the default) and aggressive. In normal mode, UDLD detects
unidirectional links due to misconnected interfaces on fiber-optic connections. In aggressive mode, UDLD
also detects unidirectional links due to one-way traffic on fiber-optic and twisted-pair links and due to
misconnected interfaces on fiber-optic links.
If you change the message time between probe packets, you are making a compromise between the detection
speed and the CPU load. By decreasing the time, you can make the detection-response faster but increase the
load on the CPU.
This command affects fiber-optic interfaces only. Use the udld interface configuration command to enable
UDLD on other interface types.
You can use these commands to reset an interface shut down by UDLD:
• The udld reset privileged EXEC command to reset all interfaces shut down by UDLD.
• The shutdown and no shutdown interface configuration commands.
• The no udld enable global configuration command followed by the udld {aggressive | enable} global
configuration command to reenable UDLD globally.
• The no udld port interface configuration command followed by the udld port or udld port aggressive
interface configuration command to reenable UDLD on the specified interface.
• The errdisable recovery cause udld and errdisable recovery interval interval global configuration
commands to automatically recover from the UDLD error-disabled state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1017
Layer 2/3
udld
This example shows how to enable UDLD on all fiber-optic interfaces:
Device> enable
Device# configure terminal
Device(config)# udld enable
You can verify your setting by entering the show udld command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1018
Layer 2/3
udld port
udld port
To enable UniDirectional Link Detection (UDLD) on an individual interface or to prevent a fiber-optic interface
from being enabled by the udld command in global configuration mode, use the udld port command in
interface configuration mode. To return to the udld command setting in global configuration mode or to
disable UDLD if entered for a nonfiber-optic port, use the no form of this command.
udld port [aggressive]
no udld port [aggressive]
Syntax Description aggressive (Optional) Enables UDLD in aggressive mode on the specified interface.
Command Default On fiber-optic interfaces, UDLD is disabled and fiber-optic interfaces enable UDLD according to the state of
the udld enable or udld aggressive command global configuration mode.
On nonfiber-optic interfaces, UDLD is disabled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A UDLD-capable port cannot detect a unidirectional link if it is connected to a UDLD-incapable port of
another device.
UDLD supports two modes of operation: normal (the default) and aggressive. In normal mode, UDLD detects
unidirectional links due to misconnected interfaces on fiber-optic connections. In aggressive mode, UDLD
also detects unidirectional links due to one-way traffic on fiber-optic and twisted-pair links and due to
misconnected interfaces on fiber-optic links.
To enable UDLD in normal mode, use the udld port command in interface configuration mode. To enable
UDLD in aggressive mode, use the udld port aggressive command in interface configuration mode.
Use the no udld port command on fiber-optic ports to return control of UDLD to the udld enable global
configuration command or to disable UDLD on nonfiber-optic ports.
Use the udld port aggressive command on fiber-optic ports to override the setting of the udld enable or udld
aggressive command in global configuration mode. Use the no form on fiber-optic ports to remove this setting
and to return control of UDLD enabling to the udld command in global configuration mode or to disable
UDLD on nonfiber-optic ports.
You can use these commands to reset an interface shut down by UDLD:
• The udld reset command in privileged EXEC mode resets all interfaces shut down by UDLD.
• The shutdown and no shutdown command in interface configuration mode.
• The no udld enable command in global configuration mode, followed by the udld {aggressive | enable}
command in global configuration mode reenables UDLD globally.
• The no udld port command in interface configuration mode, followed by the udld port or udld port
aggressive command in interface configuration mode reenables UDLD on the specified interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1019
Layer 2/3
udld port
• The errdisable recovery cause udld and errdisable recovery interval interval commands in global
configuration mode automatically recover from the UDLD error-disabled state.
This example shows how to enable UDLD on an port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet6/0/1
Device(config-if)# udld port
This example shows how to disable UDLD on a fiber-optic interface despite the setting of the udld
command in global configuration mode:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet6/0/1
Device(config-if)# no udld port
You can verify your settings by entering the show running-config or the show udld interface
command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1020
Layer 2/3
udld reset
udld reset
To reset all interfaces disabled by UniDirectional Link Detection (UDLD) and permit traffic to begin passing
through them again (though other features, such as spanning tree, Port Aggregation Protocol (PAgP), and
Dynamic Trunking Protocol (DTP) still have their normal effects, if enabled), use the udld reset command
in privileged EXEC mode.
udld reset
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If the interface configuration is still enabled for UDLD, these ports begin to run UDLD again and are disabled
for the same reason if the problem has not been corrected.
This example shows how to reset all interfaces disabled by UDLD:
Device> enable
Device# udld reset
1 ports shutdown by UDLD were reset.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1021
Layer 2/3
vlan dot1q tag native
vlan dot1q tag native
To enable tagging of native VLAN frames on all IEEE 802.1Q trunk ports, use the vlan dot1q tag native
command in global configuration mode. To return to the default setting, use the no form of this command.
vlan dot1q tag native
no vlan dot1q tag native
Syntax Description This command has no arguments or keywords.
Command Default The IEEE 802.1Q native VLAN tagging is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines When enabled, native VLAN packets going out of all IEEE 802.1Q trunk ports are tagged.
When disabled, native VLAN packets going out of all IEEE 802.1Q trunk ports are not tagged.
You can use this command with the IEEE 802.1Q tunneling feature. This feature operates on an edge device
of a service-provider network and expands VLAN space by using a VLAN-in-VLAN hierarchy and tagging
the tagged packets. You must use IEEE 802.1Q trunk ports for sending packets to the service-provider network.
However, packets going through the core of the service-provider network might also be carried on IEEE
802.1Q trunks. If the native VLANs of an IEEE 802.1Q trunks match the native VLAN of a tunneling port
on the same device, traffic on the native VLAN is not tagged on the sending trunk port. This command ensures
that native VLAN packets on all IEEE 802.1Q trunk ports are tagged.
For more information about IEEE 802.1Q tunneling, see the software configuration guide for this release.
This example shows how to enable IEEE 802.1Q tagging on native VLAN frames:
Device> enable
Device# configure terminal
Device(config)# vlan dot1q tag native
Device(config)# end
You can verify your settings by entering the show vlan dot1q tag native privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1022
Layer 2/3
vtp mode
vtp mode
To configure the VLAN Trunking Protocol (VTP) device mode, use thevtp mode command. To revert to the
default server mode, use the no form of this command.
vtp mode {client | off |transparent}
no vtp mode
Syntax Description client Specifies the device as a client.
off Specifies the device mode as off.
server Specifies the device as a server.
transparent Specifies the device mode as transparent.
Command Default Server.
Command History Release Modification
Cisco IOS XE Fuji 16.8.1a This command was
introduced.
Command Modes Global configuration mode.
Usage Guidelines VLAN Trunking Protocol (VTP) is a Cisco Proprietary Layer 2 messaging protocol used to distribute the
VLAN configuration information across multiple devices within a VTP domain. Without VTP, you must
configure VLANs in each device in the network. Using VTP, you configure VLANs on a VTP server and
then distribute the configuration to other VTP devices in the VTP domain.
In VTP transparent mode, you can configure VLANs (add, delete, or modify) and private VLANs. VTP
transparent switches do not participate in VTP. A VTP transparent switch does not advertise its VLAN
configuration and does not synchronize its VLAN configuration based on received advertisements. The VTP
configuration revision number is always set to zero (0). Transparent switches do forward VTP advertisements
that they receive out their trunk ports in VTP version 2.
A VTP device mode can be one of the following:
• server —You can create, modify, and delete VLANs and specify other configuration parameters, such
as VTP version, for the entire VTP domain. VTP servers advertise their VLAN configuration to other
switches in the same VTP domain and synchronize their VLAN configuration with other switches based
on advertisements received over trunk links. VTP server is the default mode.
Note You can configure VLANs 1 to 1005. VLANs 1002 to 1005 are reserved for
token ring in VTP version 2.
• client —VTP clients behave the same way as VTP servers, but you cannot create, change, or delete
VLANs on a VTP client.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1023
Layer 2/3
vtp mode
• transparent —You can configure VLANs (add, delete, or modify) and private VLANs. VTP transparent
switches do not participate in VTP. A VTP transparent switch does not advertise its VLAN configuration
and does not synchronize its VLAN configuration based on received advertisements. Because of this,
the VTP configuration revision number is always set to zero (0). Transparent switches do forward VTP
advertisements that they receive out their trunk ports in VTP version 2.
• off —In the above three described modes, VTP advertisements are received and transmitted as soon as
the switch enters the management domain state. In the VTP off mode, switches behave the same as in
VTP transparent mode with the exception that VTP advertisements are not forwarded. You can use this
VTP device to monitor the VLANs.
Note If you use the no vtp mode command to remove a VTP device, the device will
be configured as a VTP server. Use the vtp mode off command to remove a VTP
device.
Example
This example shows how to configure a VTP device in transparent mode and add VLANs 2, 3, and
4:
Device> enable
Device(config)#vtp mode transparent
Device(config)# vlan 2-4
Example
This example shows how to remove a device configured as a VTP device:
Device> enable
Device(config)# vtp mode off
Example
This example shows how to configure a VTP device as a VTP server and adds VLANs 2 and 3:
Device> enable
Device# vtp mode server
Device(config)# vlan 2,3
Example
This example shows how to configure a VTP device as a client:
Device> enable
Device# vtp mode client
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1024
PA R T VII
Multiprotocol Label Switching
• MPLS Commands, on page 1027
MPLS Commands
• autodiscovery, on page 1029
• backup peer, on page 1031
• encapsulation mpls, on page 1032
• ip multicast mrinfo-filter, on page 1033
• ip multicast-routing, on page 1034
• l2 vfi autodiscovery, on page 1035
• l2 vfi manual, on page 1036
• l2vpn vfi context , on page 1038
• l2vpn xconnect context, on page 1039
• label mode , on page 1040
• load-balance, on page 1041
• mdt log-reuse, on page 1043
• mdt default, on page 1044
• mdt data, on page 1046
• member (l2vpn vfi), on page 1048
• member pseudowire, on page 1049
• mpls label range, on page 1051
• mpls label protocol (interface configuration), on page 1054
• mpls label protocol (global configuration), on page 1055
• mpls ldp logging neighbor-changes, on page 1056
• mpls ip (interface configuration), on page 1057
• mpls ip (global configuration), on page 1058
• mpls ip default-route, on page 1059
• neighbor (MPLS), on page 1060
• show ip pim mdt send, on page 1061
• show ip pim mdt receive, on page 1062
• show ip pim mdt history, on page 1064
• show ip pim mdt bgp, on page 1065
• show mpls label range, on page 1066
• show mpls ldp bindings, on page 1067
• show mpls ldp discovery, on page 1069
• show mpls ldp neighbor, on page 1071
• show mpls forwarding-table, on page 1072
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1027
Multiprotocol Label Switching
• show mpls static binding, on page 1080
• show mpls static crossconnect, on page 1082
• mpls static binding ipv4, on page 1083
• show platform hardware fed (TCAM utilization), on page 1085
• show platform software fed switch l2vpn, on page 1088
• show platform software fed switch mpls, on page 1090
• show platform software l2vpn switch, on page 1092
• source template type pseudowire, on page 1094
• tunnel destination, on page 1095
• tunnel mpls-ip-only, on page 1096
• tunnel source, on page 1097
• xconnect, on page 1099
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1028
Multiprotocol Label Switching
autodiscovery
autodiscovery
To designate a Layer 2 virtual forwarding interface (VFI) as having Border Gateway Protocol (BGP) or Label
Distribution Protocol (LDP) autodiscovered pseudowire members, use the autodiscovery command in Layer
2 VFI configuration mode. To disable autodiscovery, use the no form of this command.
autodiscovery bgp signaling {bgp | ldp}[{template template-name}]
no autodiscovery bgp signaling {bgp | ldp}[{template template-name}]
Syntax Description bgp Specifies that BGP should be used for signaling and autodiscovery.
ldp Specifies that LDP should be used for signaling.
template template-name Specifies the template to be used for autodiscovered pseudowires.
Command Default Layer 2 VFI autodiscovery is disabled.
Command Modes Layer 2 VFI configuration (config-vfi)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines Layer 2 VFI autodiscovery enables each VPLS provider edge (PE) device to discover other PE devices that
are part of the same VPLS domain. VPLS autodiscovery also automatically detects when PE devices are added
to or removed from the VPLS domain.
The bgp keyword specifies that BGP should be used for signaling and autodiscovery, accordance with RFC
4761.
The ldp keyword specifies that LDP should be used for signaling. BGP will be used for autodiscovery.
Use of the autodiscovery command places the device into Layer 2 VPN VFI autodiscovery configuration
mode (config-vfi-autodiscovery).
Examples The following example shows how to enable Layer 2 VFI as having BGP autodiscovered pseudowire
members and specify that LDP signaling should be used for autodiscovery:
Device> enable
Devide# configure terminal
Device(config)# l2vpn vfi context vfi1
Device(config-vfi)# vpn id 100
Device(config-vfi)# autodiscovery bgp signaling ldp
Device(config-vfi-autodiscovery)#
Related Commands Command Description
l2 vfi autodiscovery Enables the VPLS PE device to automatically discover
other PE devices that are part of the same VPLS
domain.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1029
Multiprotocol Label Switching
autodiscovery
Command Description
vpn id Sets or updates a VPN ID on a VPLS instance.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1030
Multiprotocol Label Switching
backup peer
backup peer
To specify a redundant peer for a pseudowire virtual circuit (VC), use the backup peer command in interface
configuration mode or Xconnect configuration mode. To remove the redundant peer, use the no form of this
command.
backup peer peer-router-ip-addr vcid [pw-class pw-class-name] [priority value]
no backup peer peer-router-ip-addr vcid
Syntax Description peer-router-ip-addr IP address of the remote peer.
vcid 32-bit identifier of the VC between the devices at each end of the layer control channel.
pw-class (Optional) Specifies the pseudowire type. If this is not specified, the pseudowire type
is inherited from the parent Xconnect.
pw-class-name (Optional) Name of the pseudowire that you created while establishing the pseudowire
class.
priority value (Optional) Specifies the priority of the backup pseudowire in instances where multiple
backup pseudowires exist. The range is from 1 to 10. The default is 1.
Command Default No redundant peer is established.
Command Modes Interface configuration (config-if)
Xconnect configuration (config-if-xconn)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The combination of the peer-router-ip-addr and vcid arguments must be unique on the device.
Examples The following example shows how to configure a Multiprotocol Label Switching (MPLS) Xconnect
with one redundant peer:
Device(config)# interface GigabitEthernet1/0/44
Device(config-if)# xconnect 10.0.0.1 100 encapsulation mpls
Device(config-if-xconn)# backup peer 10.0.0.2 200
Related Commands Command Description
xconnect Binds an attachment circuit to a pseudowire for Xconnect service, and enters Xconnect
configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1031
Multiprotocol Label Switching
encapsulation mpls
encapsulation mpls
To specify Multiprotocol Label Switching (MPLS) as the data encapsulation method, use the encapsulation
mpls command in interface configuration mode. To remove the encapsulation type, use the no form of this
command.
encapsulation mpls
no encapsulation mpls
Syntax Description This command has no arguments or keywords.
Command Default The command is enabled by default.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following example shows how to configure MPLS as the data encapsulation method for a
pseudowire interface:
Device> enable
Device# configure terminal
Device(config)# interface pseudowire 100
Device(config-if)# encapsulation mpls
Related Commands Command Description
interface pseudowire Specifies the pseudowire interface.
xconnect Binds an attachment circuit to a pseudowire for Xconnect service and enters Xconnect
configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1032
Multiprotocol Label Switching
ip multicast mrinfo-filter
ip multicast mrinfo-filter
To filter multicast router information (mrinfo) request packets, use the ip multicast mrinfo-filtercommand
in global configuration mode. To remove the filter on mrinfo requests, use the no form of this command.
ip multicast [vrf vrf-name] mrinfo-filter access-list
no ip multicast [vrf vrf-name] mrinfo-filter
Syntax Description vrf (Optional) Supports the multicast VPN routing and forwarding (VRF) instance.
vrf-name (Optional) Name assigned to the VRF.
access-list IP standard numbered or named access list that determines which networks or hosts can query
the local multicast device with the mrinfo command.
Command Default No default behavior or values
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ip multicast mrinfo-filtercommand filters the mrinfo request packets from all of the sources denied by
the specified access list. That is, if the access list denies a source, that source's mrinfo requests are filtered.
mrinfo requests from any sources permitted by the ACL are allowed to proceed.
Examples The following example shows how to filter mrinfo request packets from all hosts on network
192.168.1.1 while allowing requests from any other hosts:
ip multicast mrinfo-filter 51
access-list 51 deny 192.168.1.1
access list 51 permit any
Related Commands Command Description
mrinfo Queries a multicast device about which neighboring multicast devices are peering with it.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1033
Multiprotocol Label Switching
ip multicast-routing
ip multicast-routing
To enable IP multicast routing, use the ip multicast-routing command in global configuration mode. To
disable IP multicast routing, use the no form of this command.
ip multicast-routing [vrf vrf-name]
no ip multicast-routing [vrf vrf-name]
Syntax Description vrf vrf-name (Optional) Enables IP multicast routing for the Multicast VPN routing and forwarding
(MVRF) instance specified for the vrf-name argument.
Command Default IP multicast routing is disabled.
Command Modes Global configuration (config).
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When IP multicast routing is disabled, the Cisco IOS software does not forward any multicast packets.
Note For IP multicast, after enabling IP multicast routing, PIM must be configured on all interfaces. Disabling IP
multicast routing does not remove PIM; PIM still must be explicitly removed from the interface configurations.
Examples The following example shows how to enable IP multicast routing:
Device(config)# ip multicast-routing
The following example shows how to enable IP multicast routing on a specific VRF:
Device(config)# ip multicast-routing vrf vrf1
The following example shows how to disable IP multicast routing:
Device(config)# no ip multicast-routing
Related Commands Command Description
ip pim Enables PIM on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1034
Multiprotocol Label Switching
l2 vfi autodiscovery
l2 vfi autodiscovery
To enable the Virtual Private LAN Service (VPLS) provider edge (PE) device to automatically discover other
PE devices that are part of the same VPLS domain, use the l2 vfi autodiscovery command in global
configuration mode. To disable VPLS autodiscovery, use the no form of this command.
l2 vfi vfi-name autodiscovery
no l2 vfi vfi-name autodiscovery
Syntax Description vfi-name Specifies the name of the virtual forwarding instance. The virtual forwarding
instance (VFI) identifies a group of pseudowires that are associated with a
virtual switching instance (VSI).
Command Default Layer 2 VFI autodiscovery is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines VPLS autodiscovery enables each VPLS PE device to discover other PE devices that are part of the same
VPLS domain. VPLS autodiscovery also automatically detects when PE devices are added to or removed
from the VPLS domain.
Examples The following example enables VPLS Autodiscovery on a PE device:
Device> enable
Device# configure terminal
Device(config)# l2 vfi vfi2 autodiscovery
Related Commands Command Description
l2 vfi manual Manually creates a Layer 2 VFI.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1035
Multiprotocol Label Switching
l2 vfi manual
l2 vfi manual
To create a Layer 2 virtual forwarding instance (VFI) and enter Layer 2 VFI manual configuration mode, use
the l2 vfi manual command in global configuration mode. To remove the Layer 2 VFI, use the no form of
this command.
l2 vfi name manual
no l2 vfi name manual
Syntax Description name Name of a new or existing Layer 2 VFI.
Command Default The Layer 2 VFI is not configured.
Command Modes Global configuration (config)
Command History Release Modifica
Cisco IOS XE Everest 16.6.1 This com
introduc
Usage Guidelines A VFI is a collection of data structures used by the data plane, software-based or hardware-based, to forward
packets to one or more virtual circuits (VC). It is populated and updated by both the control plane and the
data plane and also serves as the data structure interface between the control plane and the data plane.
Within the Layer 2 VFI manual configuration mode, you can configure the following parameters:
• VPN ID of a Virtual Private LAN Service (VPLS) domain
• Addresses of other PE devices in this domain
• Type of tunnel signaling and encapsulation mechanism for each peer
Within the Layer 2 VFI manual configuration mode, the following commands are available:
• vpn id vpn-id
• [no] neighbor remote-router-id {encapsulation mpls | pw-class pw-name| no-split-horizon}
Examples This example shows how to create a Layer 2 VFI, enter Layer 2 VFI manual configuration mode,
and configure a VPN ID:
Device> enable
Device# configure terminal
Device(config)# l2 vfi vfitest1 manual
Device(config-vfi)# vpn id 303
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1036
Multiprotocol Label Switching
l2 vfi manual
Related Commands Command Description
vpn id Configures a VPN ID in RFC 2685 format. You can change the value
of the VPN ID only after its configuration, and you cannot remove
it.
neighbor Specifies the type of tunnel signaling and encapsulation mechanism
for each peer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1037
Multiprotocol Label Switching
l2vpn vfi context
l2vpn vfi context
To establish a Layer 2 VPN virtual forwarding interface (VFI) between two or more separate networks, use
the l2vpn vfi context command in global configuration mode. To disable the connection, use the no form of
this command.
l2vpn vfi context name
no l2vpn vfi context name
Syntax Description name Name of the VFI context.
Command Default Layer 2 VPN VFIs are not established.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines The l2vpn vfi context command is used as part of the protocol-CLI mode for configuring Virtual Private
LAN Service (VPLS). This command establishes a VFI for specifying core-facing pseudowires in a VPLS.
The VFI represents an emulated LAN or a VPLS forwarder from the VPLS architectural model when using
an emulated LAN interface.
Examples The following example shows how to establish an Layer 2 VPN VFI context:
Device> enable
Device# configure terminal
Device(config)# l2vpn vfi context vfi1
Related Commands Command Description
l2 vfi Establishes an Layer 2 VFI.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1038
Multiprotocol Label Switching
l2vpn xconnect context
l2vpn xconnect context
To create a Layer 2 VPN (L2VPN) cross-connect context and enter Xconnect configuration mode, use the
l2vpn xconnect context command in global configuration mode. To remove the connection, use the no form
of this command.
l2vpn xconnect context context-name
no l2vpn xconnect context context-name
Syntax Description context-name Name of the cross-connect context.
Command Default L2VPN cross connections are not created.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines Use the l2vpn xconnect context command to define a cross-connect context that specifies the two members
in a Virtual Private Wire Service (VPWS), that is, attachment circuit to pseudowire, pseudowire-to-pseudowire
(multisegment pseudowire), or attachment circuit-to-attachment circuit (local connection). The type of members
specified, that is, attachment circuit interface or pseudowire, automatically define the type of L2VPN service.
Examples The following example shows how to establish an L2VPN cross-connect context:
Device> enable
Device# configure terminal
Device(config)# l2vpn xconnect context con1
Device(config-xconnect)# interworking ip
Related Commands Command Description
interworking Enables L2VPN interworking and specifies the type of traffic that can be sent over the
pseudowire.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1039
Multiprotocol Label Switching
label mode
label mode
To configure the IPv6 Explicit Null Label, use the label mode command in the address family configuration
mode. To disable the IPv6 Explicit Null Label, use the no form of the command.
label mode { explicit-null | all-explicit-null }
no label mode
Syntax Description explicit-null Configures IPv6 Explicit Null Label for directly
connected IPv6 prefixes sent to BGP labelled unicast
neighbors.
all-explicit-null Configures IPv6 Explicit Null Label for all IPv6
prefixes sent to BGP labelled unciast neighbors.
Command Default IPv6 Explicit Null Label is not configured by default.
Command Modes Address family configuration mode (config-router-af)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.1 This command was introduced.
The following example shows how to configure the IPv6 explicit-null label.
Device(config)# router bgp 1
Device(config-router)# address-family ipv6
Device(config-router-af)#label mode explicit-null
Device(config-router-af)# neighbor 33.33.33.33 activate
Device(config-router-af)# neighbor 33.33.33.33 send-label
The following example shows how to configure the IPv6 all-explicit-null label
Device(config)# router bgp 1
Device(config-router)# address-family ipv6
Device(config-router-af)#label mode all-explicit-null
Device(config-router-af)# neighbor 33.33.33.33 activate
Device(config-router-af)# neighbor 33.33.33.33 send-label
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1040
Multiprotocol Label Switching
load-balance
load-balance
To set the load-distribution method for pseudowire, use the load-balance command in interface configuration
mode. To reset the load-balancing mechanism to the default setting, use the no form of this command.
load-balance {flow [{ethernet [dst-mac | src-dst-mac | src-mac] | ip [dst-ip | src-dst-ip | src-ip] }] |
flow-label {both | receive | transmit}[static [advertise]]}
no load-balance {flow | flow-label}
Syntax Description flow Enables flow-based load balancing for pseudowire.
ethernet Specifies Ethernet pseudowire flow classification.
dst-mac Specifies load distribution based on the destination host MAC address.
src-dst-mac Specifies load distribution based on the source and destination host MAC address.
src-mac Specifies load distribution based on the source MAC address.
ip Specifies IP pseudowire flow classification.
dst-ip Specifies load distribution based on the destination host IP address.
src-dst-ip Specifies load distribution based on the source and destination host IP address.
src-ip Specifies load distribution based on the source host IP address.
flow-label Enables flow-aware transport of pseudowire.
both Enables flow-aware transport of pseudowire in both directions.
receive Enables flow-aware transport of pseudowire in the receiving direction.
transmit Enables flow-aware transport of pseudowire in the transmitting direction.
static Enables flow labels even if not signaled by the remote peer.
advertise Sends flow label sub type, length, value (sub-TLV).
Command Default The command is disabled by default.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This example shows how to set flow-based load balancing for pseudowire in the context of a specified
IP address:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1041
Multiprotocol Label Switching
load-balance
Device> enable
Device# configure terminal
Device(config)# interface pseudowire 17
Device(config-if)# load-balance flow ip 192.168.2.25
Related Commands Command Description
interface pseudowire Specifies the pseudowire interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1042
Multiprotocol Label Switching
mdt log-reuse
mdt log-reuse
To enable the recording of data multicast distribution tree (MDT) reuse, use the mdt log-reusecommand in
VRF configuration or in VRF address family configuration mode. To disable this function, use the no form
of this command.
mdt log-reuse
no mdt log-reuse
Syntax Description This command has no arguments or keywords.
Command Default The command is disabled.
Command Modes VRF address family configuration (config-vrf-af)
VRF configuration (config-vrf)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The mdt log-reuse command generates a syslog message whenever a data MDT is reused.
You can access the mdt log-reusecommand by using the ip vrf global configuration command. You can also
access the mdt log-reuse command by using the vrf definition global configuration command followed by
the address-family ipv4 VRF configuration command.
Examples The following example shows how to enable MDT log reuse:
mdt log-reuse
Related Commands Command Description
mdt data Configures the multicast group address range for data MDT groups.
mdt default Configures a default MDT group for a VPN VRF.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1043
Multiprotocol Label Switching
mdt default
mdt default
To configure a default multicast distribution tree (MDT) group for a Virtual Private Network (VPN) routing
and forwarding (VRF) instance, use the mdt default command in VRF configuration or VRF address family
configuration mode. To disable this function, use the no form of this command.
mdt defaultgroup-address
no mdt defaultgroup-address
Syntax Description group-address IP address of the default MDT group. This address serves as an identifier for the community
in that provider edge (PE) devices configured with the same group address become members
of the group, allowing them to receive packets sent by each other.
Command Default The command is disabled.
Command Modes VRF address family configuration (config-vrf-af)
VRF configuration (config-vrf)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The default MDT group must be the same group configured on all PE devices that belong to the same VPN.
If Source Specific Multicast (SSM) is used as the protocol for the default MDT, the source IP address will be
the address used to source the Border Gateway Protocol (BGP) sessions.
A tunnel interface is created as a result of this command. By default, the destination address of the tunnel
header is the group-address argument.
You can access the mdt default command by using the ip vrf global configuration command. You can also
access the mdt default command by using the vrf definition global configuration command followed by the
address-family ipv4 VRF configuration command.
Examples In the following example, Protocol Independent Multicast (PIM) SSM is configured in the backbone.
Therefore, the default and data MDT groups are configured within the SSM range of IP addresses.
Inside the VPN, PIM sparse mode (PIM-SM) is configured and only Auto-RP announcements are
accepted.
ip vrf vrf1
rd 1000:1
mdt default 236.1.1.1
mdt data 228.0.0.0 0.0.0.127 threshold 50
mdt data threshold 50
route-target export 1000:1
route-target import 1000:1
!
!
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1044
Multiprotocol Label Switching
mdt default
Related Commands Command Description
mdt data Configures the multicast group address range for data MDT groups.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1045
Multiprotocol Label Switching
mdt data
mdt data
To specify a range of addresses to be used in the data multicast distribution tree (MDT) pool, use the mdt
data command in VRF configuration or VRF address family configuration mode. To disable this function,
use the no form of this command.
mdt data threshold kb/s
no mdt data threshold kb/s
Syntax Description threshold kb/s (Optional) Defines the bandwidth threshold value in kilobits per second (kb/s). The range
is from 1 to 4294967.
Command Default A data MDT pool is not configured.
Command Modes VRF address family configuration (config-vrf-af)
VRF configuration (config-vrf)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines A data MDT can include a maximum of 256 multicast groups per MVPN. Multicast groups used to create the
data MDT are dynamically chosen from a pool of configured IP addresses.
Use the mdt data command to specify a range of addresses to be used in the data MDT pool. The threshold
is specified in kb/s. Using the optional list keyword and access-list argument, you can define the (S, G) MVPN
entries to be used in a data MDT pool, which would further limit the creation of a data MDT pool to the
particular (S, G) MVPN entries defined in the access list specified for the access-listargument.
You can access the mdt datacommand by using the ip vrf global configuration command. You can also
access the mdt datacommand by using the vrf definitionglobal configuration command followed by the
address-family ipv4VRF configuration command.
Examples The following example shows how to configure the range of group addresses for the MDT data pool.
A threshold of 500 kb/s has been set, which means that if a multicast stream exceeds 1 kb/s, then a
data MDT is created.
ip vrf vrf1
rd 1000:1
route-target export 10:27
route-target import 10:27
mdt default 236.1.1.1
mdt data 228.0.0.0 0.0.0.127 threshold 500 list 101
!
.
.
.
!
ip pim ssm default
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1046
Multiprotocol Label Switching
mdt data
ip pim vrf vrf1 accept-rp auto-rp
!
Related Commands Command Description
mdt default Configures a default MDT group for a VPN VRF.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1047
Multiprotocol Label Switching
member (l2vpn vfi)
member (l2vpn vfi)
To specify the devices that form a point-to-point Layer 2 VPN virtual forwarding interface (VFI) connection,
use the member command in Layer 2 VFI configuration mode. To disconnect the devices, use the no form
of this command.
member {ip-address [{vc-id}]{encapsulation mpls | template name} | pseudowire pw-int-number [ip-address
[{vc-id }]{encapsulation mpls | template name}]}
no member {ip-address [{vc-id }]{encapsulation mpls | template name} | pseudowire pw-int-number
[ip-address [{vc-id}]{encapsulation mpls | template name}]}
Syntax Description ip-address IP address of the VFI neighbor.
vc-id (Optional) Virtual circuit (VC) identifier.
encapsulation mpls Specifies Multiprotocol Label Switching (MPLS)
as the encapsulation type.
template name Specifies the template name.
pseudowire pw-int-number Specifies the pseudowire interface number.
Command Default Devices that form a point-to-point Layer 2 VPN VFI connection are not specified.
Command Modes
Layer 2 VFI configuration (config-vfi)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines This instance of the member command is used as part of the protocol-CLI mode for configuring Virtual
Private LAN Service (VPLS).
Examples The following example shows how to configure an Layer 2 VPN VFI connection as part of the
protocol-CLI mode for configuring Virtual Private LAN Service (VPLS). :
Device> enable
Device# configure terminal
Device(config)# l2vpn vfi context vfi1
Device(config-vfi)# member 10.10.10.10 1 encapsulation mpls
Related Commands Command Description
neighbor (VPLS) Specifies the type of tunnel signaling and encapsulation
mechanism for each VPLS peer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1048
Multiprotocol Label Switching
member pseudowire
member pseudowire
To specify a pseudowire interface that forms a Layer 2 VPN (L2VPN) cross connect, use the member
pseudowire command in Xconnect configuration mode. To disconnect the pseudowire interface, use the no
form of this command.
member pseudowire interface-number [ip-address vc-id {encapsulation mpls | template template-name}]
[group group-name [priority number]]
no member pseudowire interface-number
Syntax Description interface-number Interface number.
ip-address IP address of the peer.
vcid The virtual circuit (VC) ID. The range is from 1 to 4294967295.
encapsulation mpls Specifies Multiprotocol Label Switching (MPLS) as the data encapsulation method.
template template-name (Optional) Specifies the template to be used for encapsulation and protocol
configuration. The maximum size is 32 characters.
group group-name (Optional) Specifies the cross-connect member redundancy group name.
priority number (Optional) Specifies the cross-connect member priority. The range is from 0 to
16. The highest priority is 0. The lowest priority is 16.
Command Default Devices that form an L2VPN cross connect are not specified.
Command Modes Xconnect configuration (config-xconnect)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The member command specifies the two members of the Virtual Private Wired Service (VPWS), multisegment
pseudowire or local connect services. For VPWS, one member is an attachment circuit and the other member
is a pseudowire interface. For a multisegment pseudowire, both members are pseudowire interfaces. For local
connect, both members are active interfaces.
When both the pseudowire interface and the peer information are specified, an interface is dynamically created
by using the interface-number argument specified in the pseudowire command.
Configure the group name to specify which of the two possible groups a member belongs to.
Configure a priority for each member so that the active members can be chosen based on priority when there
are multiple redundant members. The default priority for a member is 0 (highest).
There can only be two groups, with a maximum of four members in one group and only one member in the
other group (the lone member is for active redundancy and the other three are for backup redundancy). If a
group name is not specified, only two members can be configured in the L2VPN cross-connect context.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1049
Multiprotocol Label Switching
member pseudowire
Examples The following example shows how to specify pseudowire as the attachment circuit type:
Device> enable
Device# configure terminal
Device(config)# l2vpn xconnect context con1
Device(config-xconnect)# member pseudowire 17
Related Commands Command Description
l2vpn xconnect Creates a Layer 2 VPN (L2VPN) cross-connect context.
context
xconnect Binds an attachment circuit to a pseudowire for Xconnect service, and enters
Xconnect configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1050
Multiprotocol Label Switching
mpls label range
mpls label range
To configure the range of local labels available for use with Multiprotocol Label Switching (MPLS) applications
on packet interfaces, use the mpls label range command in global configuration mode. To revert to the
platform defaults, use the no form of this command.
mpls label range minimum-value maximum-value [static minimum-static-value maximum-static-value]
no mpls label range
Syntax Description minimum-value The value of the smallest label allowed in the label space. The default is 16.
maximum-value The value of the largest label allowed in the label space. The default is
platform-dependent.
static (Optional) Reserves a block of local labels for static label assignments. If you omit
the static keyword and the minimum-static-value maximum-static-value arguments,
no labels are reserved for static assignment.
minimum-static-value (Optional) The minimum value for static label assignments. There is no default
value.
maximum-static-value (Optional) The maximum value for static label assignments. There is no default
value.
Command Default The platform’s default values are used.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The labels 0 through 15 are reserved by the IETF (see RFC 3032, MPLS Label Stack Encoding, for details)
and cannot be included in the range specified in the mpls label range command. If you enter a 0 in the
command, you will get a message that indicates that the command is an unrecognized command.
The label range defined by the mpls label range command is used by all MPLS applications that allocate
local labels (for dynamic label switching, MPLS traffic engineering, MPLS Virtual Private Networks (VPNs),
and so on).
You can use label distribution protocols, such as Label Distribution Protocol (LDP), to reserve a generic range
of labels from 16 through 1048575 for dynamic assignment.
You specify the optional static keyword, to reserve labels for static assignment. The MPLS Static Labels
feature requires that you configure a range of labels for static assignment. You can configure static bindings
only from the current static range. If the static range is not configured or is exhausted, then you cannot configure
static bindings.
The range of label values is 16 to 4096. The maximum value defaults to 4096. You can split for static label
space between say 16 to 100 and for dynamic label space between 101 to 4096.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1051
Multiprotocol Label Switching
mpls label range
The upper and lower minimum static label values are displayed in the help line.
Examples The following example displays the help lines when you configure the dynamic label with a minimum
value of 16 and a maximum value of 100:
Device(config)# mpls label range 16 100 static ?
<100> Upper Minimum static label value
<16> Lower Minimum static label value
Reserved Label Range --> 0 to 15
Available Label Range --> 16 to 4096
Static Label Range --> 16 to 100
Dynamic Label Range --> 101 to 4096
The following example shows how to configure a static range from 16 to 100. If the lower minimum
static label space is not available, the lower minimum is not displayed in the help line.
Device(config)# mpls label range 16 100 static ?
<16-100> static label value range
The following example shows how to configure the size of the local label space. In this example, the
minimum static value is set to 200, and the maximum static value is set to 4000.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# mpls label range 200 4000
Device(config)#
If you had specified a new range that overlaps the current range (for example, the new range of the
minimum static value set to 16 and the maximum static value set to 1000), then the new range takes
effect immediately.
The following example show how to configure a dynamic local label space with a minimum static
value set to 100 and the maximum static value set to 1000 and a static label space with a minimum
static value set to 16 and a maximum static value set to 99:
Device(config)# mpls label range 100 1000 static 16 99
Device(config)#
In the following output, the show mpls label range command, executed after a reload, shows that
the configured range is now in effect:
Device# show mpls label range
Downstream label pool: Min/Max label: 100/1000
Range for static labels: Min/Max/Number: 16/99
The following example shows how to restore the label range to its default value:
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# no mpls label range
Device(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1052
Multiprotocol Label Switching
mpls label range
Related Commands Command Description
show mpls label range Displays the range of the MPLS local label space.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1053
Multiprotocol Label Switching
mpls label protocol (interface configuration)
mpls label protocol (interface configuration)
To specify the label distribution protocol for an interface, use the mpls label protocol command in interface
configuration mode. To remove the label distribution protocol from the interface, use the no form of this
command.
mpls label protocol ldp
no mpls label protocol ldp
Syntax Description ldp Specifies that the label distribution protocol (LDP) is to be used on the interface.
Command Default If no protocol is explicitly configured for an interface, the label distribution protocol that was configured for
the platform is used. To set the platform label distribution protocol, use the global mpls label protocol
command.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines To successfully establish a session for label distribution for a link connecting two label switch routers (LSRs),
the link interfaces on the LSRs must be configured to use the same label distribution protocol. If there are
multiple links connecting two LSRs, all of the link interfaces connecting the two LSRs must be configured
to use the same protocol.
Examples The following example shows how to establish LDP as the label distribution protocol for the interface:
Device(config-if)# mpls label protocol ldp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1054
Multiprotocol Label Switching
mpls label protocol (global configuration)
mpls label protocol (global configuration)
To specify the Label Distribution Protocol (LDP) for a platform, use the mpls label protocol command in
global configuration mode. To restore the default LDP, use the no form of this command.
mpls label protocol ldp
no mpls label protocol ldp
Syntax Description ldp Specifies that LDP is the default label distribution protocol.
Command Default LDP is the default label distribution protocol.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines If neither the global mpls label protocol ldp command nor the interface mpls label protocol ldp command is
used, all label distribution sessions use LDP.
Examples The following command establishes LDP as the label distribution protocol for the platform:
Device(config)# mpls label protocol ldp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1055
Multiprotocol Label Switching
mpls ldp logging neighbor-changes
mpls ldp logging neighbor-changes
To generate system error logging (syslog) messages when Label Distribution Protocol (LDP) sessions go
down, use the mpls ldp logging neighbor-changes command in global configuration mode. To disable
generating syslog messages, use the no form of this command.
mpls ldp logging neighbor-changes
no mpls ldp logging neighbor-changes
Syntax Description This command has no arguments or keywords.
Command Default Logging is enabled by default.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines Use the mpls ldp logging neighbor-changes command to generate syslog messages when an LDP session
goes down. The command also provides VRF information about the LDP neighbor and the reason for the
LDP session going down. Some of the reasons for an LDP session going down are the following:
• An LDP was disabled globally by configuration.
• An LDP was disabled on an interface.
Examples The following example generates syslog messages when LDP sessions go down:
Device> enable
Device# configure terminal
Device(config)# mpls ldp logging neighbor-changes
The following output shows the log entries when an LDP session with neighbor 192.168.1.100:0
goes down and comes up. The session went down because the discovery hold timer expired. The
VRF table identifier for the neighbor is 1.
2d00h: %LDP-5-NBRCHG: LDP Neighbor 192.168.1.100:0 (1) is DOWN (Disc hold timer expired)
2d00h: %LDP-5-NBRCHG: LDP Neighbor 192.168.1.100:0 (1) is UP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1056
Multiprotocol Label Switching
mpls ip (interface configuration)
mpls ip (interface configuration)
To enable Multiprotocol Label Switching (MPLS) forwarding of IPv4 and IPv6 packets along normally routed
paths for a particular interface, use the mpls ip command in interface configuration mode. To disable this
configuration, use the no form of this command.
mpls ip
no mpls ip
Syntax Description This command has no arguments or keywords.
Command Default MPLS forwarding of IPv4 and IPv6 packets along normally routed paths for the interface is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines MPLS forwarding of IPv4 and IPv6 packets along normally routed paths is sometimes called dynamic label
switching. If dynamic label switching has been enabled for the platform when this command is issued on an
interface, label distribution for the interface begins with the periodic transmission of neighbor discovery Hello
messages on the interface. When the outgoing label for a destination routed through the interface is known,
packets for the destination are labeled with that outgoing label and forwarded through the interface.
The no form of this command causes packets routed out through the interface to be sent unlabeled; this form
of the command also terminates label distribution for the interface. However, the no form of the command
does not affect the sending of labeled packets through any link-state packet (LSP) tunnels that might use the
interface.
Examples The following example shows how to enable label switching on the specified Ethernet interface:
Device(config)# configure terminal
Device(config-if)# interface TenGigabitEthernet1/0/3
Device(config-if)# mpls ip
The following example shows that label switching is enabled on the specified vlan interface (SVI)
on a Cisco Catalyst switch:
Device(config)# configure terminal
Device(config-if)# interface vlan 1
Device(config-if)# mpls ip
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1057
Multiprotocol Label Switching
mpls ip (global configuration)
mpls ip (global configuration)
To enable Multiprotocol Label Switching (MPLS) forwarding of IPv4 and IPv6 packets along normally routed
paths for the platform, use the mpls ip command in global configuration mode. To disable this feature, use
the no form of this command.
mpls ip
no mpls ip
Syntax Description This command has no arguments or keywords.
Command Default Label switching of IPv4 and IPv6 packets along normally routed paths is enabled for the platform.
Command Modes
Global configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines MPLS forwarding of IPv4 and IPv6 packets along normally routed paths (sometimes called dynamic label
switching) is enabled by this command. For a given interface to perform dynamic label switching, this switching
function must be enabled for the interface and for the platform.
The no form of this command stops dynamic label switching for all platform interfaces regardless of the
interface configuration; it also stops distribution of labels for dynamic label switching. However, the no form
of this command does not affect the sending of labeled packets through label switch path (LSP) tunnels.
Examples The following example shows that dynamic label switching is disabled for the platform, and all label
distribution is terminated for the platform:
Device(config)# no mpls ip
Related Commands Command Description
mpls ip (interface configuration) Enables MPLS forwarding of IPv4 and IPv6 packets along normally
routed paths for the associated interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1058
Multiprotocol Label Switching
mpls ip default-route
mpls ip default-route
To enable the distribution of labels associated with the IP default route, use the mpls ip default-route command
in global configuration mode.
mpls ip default-route
Syntax Description This command has no arguments or keywords.
Command Default No distribution of labels for the IP default route.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Dynamic label switching (that is, distribution of labels based on routing protocols) must be enabled before
you can use the mpls ip default-route command.
Examples The following example shows how to enable the distribution of labels associated with the IP default
route:
Device# configure terminal
Device(config)# mpls ip
Device(config)# mpls ip default-route
Related Commands Command Description
mpls ip (global configuration) Enables MPLS forwarding of IPv4 packets along normally routed paths
for the platform.
mpls ip (interface configuration) Enables MPLS forwarding of IPv4 packets along normally routed paths
for a particular interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1059
Multiprotocol Label Switching
neighbor (MPLS)
neighbor (MPLS)
To specify the peer IP address and virtual circuit (VC) ID value of a Layer 2 VPN (L2VPN) pseudowire, use
the neighbor command in interface configuration mode. To remove the peer IP address and VC ID value of
an L2VPN pseudowire, use the no form of this command.
neighbor peer-address vcid-value
no neighbor
Syntax Description peer-address IP address of the provider edge (PE) peer.
vcid-value VC ID value. The range is from 1 to 4294967295.
Command Default Peer address and VC ID value of a pseudowire are not specified.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines You must configure the neighbor command for the pseudowire to be functional.
Examples The following example shows how to specify a peer IP address of 10.1.2.3 and a VC ID value of
100:
Device> enable
Device# configure terminal
Device(config)# interface pseudowire 100
Device(config-if)# neighbor 10.1.2.3 100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1060
Multiprotocol Label Switching
show ip pim mdt send
show ip pim mdt send
To display the data multicast distribution tree (MDT) groups in use, use the show ip pim mdt send command
in privileged EXEC mode.
show ip pim vrf vrf-name mdt send
Syntax Description vrf vrf-name Displays the data MDT groups in use by the Multicast VPN (MVPN) routing and forwarding
(MVRF) instance specified for the vrf-name argument.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to show the data MDT groups in use by a specified MVRF.
Examples The following is sample output from the show ip pim mdt send command:
Device# show ip pim vrf vpn8 mdt send
MDT-data send list for VRF:vpn8
(source, group) MDT-data group ref_count
(10.100.8.10, 225.1.8.1) 232.2.8.0 1
(10.100.8.10, 225.1.8.2) 232.2.8.1 1
(10.100.8.10, 225.1.8.3) 232.2.8.2 1
(10.100.8.10, 225.1.8.4) 232.2.8.3 1
(10.100.8.10, 225.1.8.5) 232.2.8.4 1
(10.100.8.10, 225.1.8.6) 232.2.8.5 1
(10.100.8.10, 225.1.8.7) 232.2.8.6 1
(10.100.8.10, 225.1.8.8) 232.2.8.7 1
(10.100.8.10, 225.1.8.9) 232.2.8.8 1
(10.100.8.10, 225.1.8.10) 232.2.8.9 1
The table below describes the significant fields shown in the display.
Table 126: show ip pim mdt send Field Descriptions
Field Description
source, group Source and group addresses that this router has switched over to data MDTs.
MDT-data group Multicast address over which these data MDTs are being sent.
ref_count Number of (S, G) pairs that are reusing this data MDT.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1061
Multiprotocol Label Switching
show ip pim mdt receive
show ip pim mdt receive
To display the data multicast distribution tree (MDT) group mappings received from other provider edge (PE)
routers, use the show ip pim mdt receivecommand in privileged EXEC mode.
show ip pim vrf vrf-name mdt receive [detail]
Syntax Description vrf vrf-name Displays the data MDT group mappings for the Multicast VPN (MVPN) routing and
forwarding (MVRF) instance specified for the vrf-name argument.
detail (Optional) Provides a detailed description of the data MDT advertisements received.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines When a router wants to switch over from the default MDT to a data MDT, it advertises the VRF source, the
group pair, and the global multicast address over which the traffic will be sent. If the remote router wants to
receive this data, then it will join this global address multicast group.
Examples The following is sample output from the show ip pim mdt receivecommand using the detail keyword
for further information:
Device# show ip pim vrf vpn8 mdt receive detail
Joined MDT-data groups for VRF:vpn8
group:172.16.8.0 source:10.0.0.100 ref_count:13
(10.101.8.10, 225.1.8.1), 1d13h/00:03:28/00:02:26, OIF count:1, flags:TY
(10.102.8.10, 225.1.8.1), 1d13h/00:03:28/00:02:27, OIF count:1, flags:TY
The table below describes the significant fields shown in the display.
Table 127: show ip pim mdt receive Field Descriptions
Field Description
group:172.16.8.0 Group that caused the data MDT to be built.
source:10.0.0.100 VRF source that caused the data MDT to be built.
ref_count:13 Number of (S, G) pairs that are reusing this data MDT.
OIF count:1 Number of interfaces out of which this multicast data is being forwarded.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1062
Multiprotocol Label Switching
show ip pim mdt receive
Field Description
flags: Information about the entry.
• A--candidate Multicast Source Discovery Protocol (MSDP)
advertisement
• B--bidirectional group
• D--dense
• C--connected
• F--register flag
• I--received source-specific host report
• J--join shortest path source tree (SPT)
• L--local
• M--MSDP created entry
• P--pruned
• R--RP bit set
• S--sparse
• s--Source Specific Multicast (SSM) group
• T--SPT bit set
• X--proxy join timer running
• U--URL Rendezvous Directory (URD)
• Y--joined MDT data group
• y--sending to MDT data group
• Z--multicast tunnel
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1063
Multiprotocol Label Switching
show ip pim mdt history
show ip pim mdt history
To display information about the history of data multicast distribution tree (MDT) groups that have been
reused, use the show ip pim mdt historycommand in privileged EXEC mode.
show ip pim vrf vrf-name mdt history interval minutes
Syntax Description vrf vrf-name Displays the history of data MDT groups that have been reused for the Multicast VPN
(MVPN) routing and forwarding (MVRF) instance specified for the vrf-name argument.
interval minutes Specifies the interval (in minutes) for which to display information about the history
of data MDT groups that have been reused. The range is from 1 to 71512 minutes (7
weeks).
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The output of the show ip pim mdt history command displays the history of reused MDT data groups for
the interval specified with the interval keyword and minutes argument. The interval is from the past to the
present, that is, from the time specified for the minutes argument to the time at which the command is issued.
Examples The following is sample output from the show ip pim mdt historycommand:
Device# show ip pim vrf vrf1 mdt history interval 20
MDT-data send history for VRF - vrf1 for the past 20 minutes
MDT-data group Number of reuse
10.9.9.8 3
10.9.9.9 2
The table below describes the significant fields shown in the display.
Table 128: show ip pim mdt history Field Descriptions
Field Description
MDT-data group The MDT data group for which information is being shown.
Number of reuse The number of data MDTs that have been reused in this group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1064
Multiprotocol Label Switching
show ip pim mdt bgp
show ip pim mdt bgp
To show details about the Border Gateway Protocol (BGP) advertisement of the route distinguisher (RD) for
the multicast distribution tree (MDT) default group, use the show ip pim mdt bgp command in user EXEC or
privileged EXEC mode.
show ip pim [vrf vrf-name] mdt bgp
Syntax Description vrf vrf-name (Optional) Displays information about the BGP advertisement of the RD for the MDT
default group associated with Multicast Virtual Private Network (MVPN) routing and
forwarding (MVRF) instance specified for the vrf-name argument.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to show detailed BGP advertisement of the RD for the MDT default group.
Examples The following is sample output from the show ip pim mdt bgpcommand:
Device# show ip pim mdt bgp
MDT-default group 232.2.1.4
rid:10.1.1.1 next_hop:10.1.1.1
The table below describes the significant fields shown in the display.
Table 129: show ip pim mdt bgp Field Descriptions
Field Description
MDT-default group The MDT default groups that have been advertised to this router.
rid:10.1.1.1 The BGP router ID of the advertising router.
next_hop:10.1.1.1 The BGP next hop address that was contained in the advertisement.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1065
Multiprotocol Label Switching
show mpls label range
show mpls label range
To display the range of local labels available for use on packet interfaces, use the show show mpls label
range command in privileged EXEC mode.
show mpls label range
Syntax Description This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You can use the mpls label range command to configure a range for local labels that is different from the
default range. The show mpls label range command displays both the label range currently in use and the
label range that will be in use following the next switch reload.
Examples In the following example, the use of the show mpls label range command is shown before and after
the mpls label range command is used to configure a label range that does not overlap the starting
label range:
Device# show mpls label range
Downstream label pool: Min/Max label: 16/100
Device# configure terminal
Device(config)# mpls label range 101 4000
Device(config)# exit
Device# show mpls label range
Downstream label pool: Min/Max label: 101/4000
Related Commands Command Description
mpls label range Configures a range of values for use as local labels.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1066
Multiprotocol Label Switching
show mpls ldp bindings
show mpls ldp bindings
To display the contents of Label Information Base (LIB), use the show mpls ldp bindings command.
show mpls ldp bindings[all|vrf vrf-name][brief][summary]
Syntax Description all Displays all Label Distribution Protocol (LDP) configured VRFs.
vrf vrf-name Displays information for the specified VRF.
brief Displays concise information about specified LDP-enabled interface.
summary Displays information for LDP discovery.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Examples The following is a sample output of the show mpls ldp bindings brief command:
Device# show mpls ldp bindings brief
Fri Mar 9 17:39:27.358 UTCs
Prefix Local Advertised Remote Bindings
Label (peers) (peers)
------------------ --------- ---------- ---------------
0.0.0.0/0 ImpNull 2 0
1.1.1.1/32 ImpNull 2 2
1.2.3.0/24 - 0 2
3.3.3.3/32 24054 2 2
4.4.4.4/32 24050 2 2
5.5.5.5/32 24051 2 2
5.7.0.0/16 ImpNull 2 0
5.8.0.0/16 - 0 2
5.11.0.0/16 24002 2 0
6.6.6.6/32 24055 2 2
10.5.1.0/24 ImpNull 2 0
10.105.0.0/16 24003 2 0
11.11.11.0/24 ImpNull 2 0
12.12.12.2/32 ImpNull 2 0
14.0.0.0/16 - 0 2
20.20.20.0/24 ImpNull 2 2
30.30.30.0/24 ImpNull 2 2
56.2.1.0/24 ImpNull 2 0
86.0.0.1/32 ImpNull 2 0
100.0.0.0/16 ImpNull 2 0
100.0.0.1/32 ImpNull 2 0
110.1.1.1/32 - 0 2
120.1.1.1/32 - 0 2
202.153.0.0/16 24005 2 0
202.153.144.25/32 24004 2 2
The following is a sample output of the show mpls ldp bindings summary command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1067
Multiprotocol Label Switching
show mpls ldp bindings
Device# show mpls ldp bindings summary
Fri Mar 9 17:39:22.572 UTC
LIB Summary:
Total Prefix : 25
Revision No : Current:92, Advertised:92
Local Bindings : 20
NULL : 12 (implicit:12, explicit:0)
Non-NULL: 8 (lowest:24002, highest:24055)
Remote Bindings: 26
Related Commands Command Description
show mpls ldp Displays the status of LDP discovery process
discovery
show mpls ldp neighbor Displays the status of LDP sessions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1068
Multiprotocol Label Switching
show mpls ldp discovery
show mpls ldp discovery
To display the status of Label Distribution Protocol (LDP) discovery process, use the show mpls ldp discovery
command.
show mpls ldp discovery[all|vrf vrf-name][brief][summary]
Syntax Description all Displays all LDP-configured VRFs.
vrf vrf-name Displays information for the specified VRF.
brief Displays concise information about specified LDP-enabled interface.
summary Displays information for LDP discovery.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Examples The following is a sample output of the show mpls ldp discovery brief command:
Device# show mpls ldp discovery brief
Fri Mar 9 17:39:00.536 UTC
Local LDP Identifier: 1.1.1.1:0
Discovery Source VRF Name Peer LDP Id Holdtime Session
-------------------- -------------------- -------------------- -------- -------
Te0/1/1/10 default 4.4.4.4:0 15 Y
Te0/1/1/12 default 3.3.3.3:0 15 Y
Tgt:87.0.0.1 default - - N
The following is a sample output of the show mpls ldp discovery summary command:
Device# show mpls ldp discovery summary
Fri Mar 9 17:38:55.977 UTC
LDP Identifier: 1.1.1.1:0
Interfaces:
Configured: 2
Enabled : 2
Discovery:
Hello xmit: 3 (2 link, 1 targeted)
Hello recv: 2 (2 link)
Hello Errors Received:
Bad Source Address: 0
Bad Hello PDU: 0
Bad Xport Address: 0
Same Router ID: 0
Wrong Router ID: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1069
Multiprotocol Label Switching
show mpls ldp discovery
Related Commands Command Description
show mpls ldp bindings Displays the contents of Label Information Base (LIB).
show mpls ldp neighbor Displays the status of LDP sessions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1070
Multiprotocol Label Switching
show mpls ldp neighbor
show mpls ldp neighbor
To display the status of Label Distribution Protocol (LDP) sessions, use the show mpls ldp neighbor command.
show mpls ldp neighbor[all|vrf vrf-name][brief][summary]
Syntax Description all Displays all LDP-configured VRFs.
vrf vrf-name Displays information for the specified VRF.
brief Displays concise information about specified LDP-enabled interface.
summary Displays information for LDP discovery.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Examples The following is a sample output of the show mpls ldp neighbor brief command:
Device# show mpls ldp neighbor brief
Fri Mar 9 17:38:11.890 UTC
Peer GR NSR Up Time Discovery Addresses Labels
----------------- -- --- ---------- ---------- ---------- ------------
4.4.4.4:0 N N 2d02h 1 6 13
3.3.3.3:0 N N 2d02h 1 7 13
The following is a sample output of the show mpls ldp neighbor summary command:
Device# show mpls ldp neighbor summary
Fri Mar 9 17:38:55.977 UTC
VRF vrf1
Local LDP Identifier: 16.0.0.3:0
Sessions: 2 operational
1 directly connected
0 graceful restart
Related Commands Command Description
show mpls ldp bindings Displays the contents of Label Information Base (LIB).
show mpls ldp discovery Displays the status of LDP discovery process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1071
Multiprotocol Label Switching
show mpls forwarding-table
show mpls forwarding-table
To display the contents of the Multiprotocol Label Switching (MPLS) Label Forwarding Information Base
(LFIB), use the show mpls forwarding-table command in user EXEC or privileged EXEC mode.
Note When a local label is present, the forwarding entry for IP imposition will not be showed; if you want to see
the IP imposition information, use show ip cef.
show mpls forwarding-table [{network {masklength} | interface interface | labels label [dash label]
| lcatm atm atm-interface-number | next-hop address | lsp-tunnel [tunnel-id]}] [vrf vrf-name] [detail
slot slot-number]
network (Optional) Destination network number.
mask IP address of the destination mask whose entry is to be shown.
length Number of bits in the mask of the destination.
interface interface (Optional) Displays entries with the outgoing interface specified.
labels label-label (Optional) Displays entries with the local labels specified.
lcatm atm atm-interface-number Displays ATM entries with the specified Label Controlled Asynchronous
Transfer Mode (LCATM).
next-hop address (Optional) Displays only entries with the specified neighbor as the next
hop.
lsp-tunnel (Optional) Displays only entries with the specified label switched path
(LSP) tunnel, or with all LSP tunnel entries.
tunnel-id (Optional) Specifies the LSP tunnel for which to display entries.
vrf vrf-name (Optional) Displays entries with the specified VPN routing and forwarding
(VRF) instance.
detail (Optional) Displays information in long form (includes length of
encapsulation, length of MAC string, maximum transmission unit [MTU],
and all labels).
slot slot-number (Optional) Specifies the slot number, which is always 0.
Command Modes
User EXEC (>)
Privileged EXEC (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1072
Multiprotocol Label Switching
show mpls forwarding-table
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples The following is sample output from the show mpls forwarding-table command:
Device# show mpls forwarding-table
Local Outgoing Prefix Bytes label Outgoing Next Hop
Label Label or VC or Tunnel Id switched interface
26 No Label 10.253.0.0/16 0 Et4/0/0 10.27.32.4
28 1/33 10.15.0.0/16 0 AT0/0.1 point2point
29 Pop Label 10.91.0.0/16 0 Hs5/0 point2point
1/36 10.91.0.0/16 0 AT0/0.1 point2point
30 32 10.250.0.97/32 0 Et4/0/2 10.92.0.7
32 10.250.0.97/32 0 Hs5/0 point2point
34 26 10.77.0.0/24 0 Et4/0/2 10.92.0.7
26 10.77.0.0/24 0 Hs5/0 point2point
35 No Label[T] 10.100.100.101/32 0 Tu301 point2point
36 Pop Label 10.1.0.0/16 0 Hs5/0 point2point
1/37 10.1.0.0/16 0 AT0/0.1 point2point
[T] Forwarding through a TSP tunnel.
View additional labeling info with the 'detail' option
The following is sample output from the show mpls forwarding-table command when the IPv6
Provider Edge Router over MPLS feature is configured to allow IPv6 traffic to be transported across
an IPv4 MPLS backbone. The labels are aggregated because there are several prefixes for one local
label, and the prefix column contains “IPv6” instead of a target prefix.
Device# show mpls forwarding-table
Local Outgoing Prefix Bytes label Outgoing Next Hop
Label Label or VC or Tunnel Id switched interface
16 Aggregate IPv6 0
17 Aggregate IPv6 0
18 Aggregate IPv6 0
19 Pop Label 192.168.99.64/30 0 Se0/0 point2point
20 Pop Label 192.168.99.70/32 0 Se0/0 point2point
21 Pop Label 192.168.99.200/32 0 Se0/0 point2point
22 Aggregate IPv6 5424
23 Aggregate IPv6 3576
24 Aggregate IPv6 2600
The following is sample output from the show mpls forwarding-table detail command. If the MPLS
EXP level is used as a selection criterion for packet forwarding, a bundle adjacency exp (vcd) field
is included in the display. This field includes the EXP value and the corresponding virtual circuit
descriptor (VCD) in parentheses. The line in the output that reads “No output feature configured”
indicates that the MPLS egress NetFlow accounting feature is not enabled on the outgoing interface
for this prefix.
Device# show mpls forwarding-table detail
Local Outgoing Prefix Bytes label Outgoing Next Hop
label label or VC or Tunnel Id switched interface
16 Pop label 10.0.0.6/32 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/12, MTU=4474, label Stack{}
00010000AAAA030000008847
No output feature configured
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1073
Multiprotocol Label Switching
show mpls forwarding-table
17 18 10.0.0.9/32 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/16, MTU=4470, label Stack{18}
00010000AAAA030000008847 00012000
No output feature configured
18 19 10.0.0.10/32 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/16, MTU=4470, label Stack{19}
00010000AAAA030000008847 00013000
No output feature configured
19 17 10.0.0.0/8 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/16, MTU=4470, label Stack{17}
00010000AAAA030000008847 00011000
No output feature configured
20 20 10.0.0.0/8 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/16, MTU=4470, label Stack{20}
00010000AAAA030000008847 00014000
No output feature configured
21 Pop label 10.0.0.0/24 0 AT1/0.1 point2point
Bundle adjacency exp(vcd)
0(1) 1(1) 2(1) 3(1) 4(1) 5(1) 6(1) 7(1)
MAC/Encaps=12/12, MTU=4474, label Stack{}
00010000AAAA030000008847
No output feature configured
22 Pop label 10.0.0.4/32 0 Et2/3 10.0.0.4
MAC/Encaps=14/14, MTU=1504, label Stack{}
000427AD10430005DDFE043B8847
No output feature configured
The following is sample output from the show mpls forwarding-table detail command. In this
example, the MPLS egress NetFlow accounting feature is enabled on the first three prefixes, as
indicated by the line in the output that reads “Feature Quick flag set.”
Device# show mpls forwarding-table detail
Local Outgoing Prefix Bytes label Outgoing Next Hop
label label or VC or Tunnel Id switched interface
16 Aggregate 10.0.0.0/8[V] 0
MAC/Encaps=0/0, MTU=0, label Stack{}
VPN route: vpn1
Feature Quick flag set
Per-packet load-sharing, slots: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
17 No label 10.0.0.0/8[V] 0 Et0/0/2 10.0.0.1
MAC/Encaps=0/0, MTU=1500, label Stack{}
VPN route: vpn1
Feature Quick flag set
Per-packet load-sharing, slots: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
18 No label 10.42.42.42/32[V] 4185 Et0/0/2 10.0.0.1
MAC/Encaps=0/0, MTU=1500, label Stack{}
VPN route: vpn1
Feature Quick flag set
Per-packet load-sharing, slots: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
19 2/33 10.41.41.41/32 0 AT1/0/0.1 point2point
MAC/Encaps=4/8, MTU=4470, label Stack{2/33(vcd=2)}
00028847 00002000
No output feature configured
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1074
Multiprotocol Label Switching
show mpls forwarding-table
The table below describes the significant fields shown in the displays.
Table 130: show mpls forwarding-table Field Descriptions
Field Description
Local label Label assigned by this device.
Outgoing Label or VC Label assigned by the next hop or the virtual path identifier (VPI)/virtual
channel identifier (VCI) used to get to next hop. The entries in this column
Note This field is not
are the following:
supported on the
Cisco 10000 • [T]--Forwarding is through an LSP tunnel.
series routers.
• No Label--There is no label for the destination from the next hop or
label switching is not enabled on the outgoing interface.
• Pop Label--The next hop advertised an implicit NULL label for the
destination and the device removed the top label.
• Aggregate--There are several prefixes for one local label. This entry
is used when IPv6 is configured on edge devices to transport IPv6
traffic over an IPv4 MPLS network.
Prefix or Tunnel Id Address or tunnel to which packets with this label are sent.
Note If IPv6 is configured on edge devices to transport IPv6 traffic
over an IPv4 MPLS network, “IPv6” is displayed here.
• [V]--The corresponding prefix is in a VRF.
Bytes label switched Number of bytes switched with this incoming label. This includes the
outgoing label and Layer 2 header.
Outgoing interface Interface through which packets with this label are sent.
Next Hop IP address of the neighbor that assigned the outgoing label.
Bundle adjacency exp(vcd) Bundle adjacency information. Includes the MPLS EXP value and the
corresponding VCD.
MAC/Encaps Length in bytes of the Layer 2 header and length in bytes of the packet
encapsulation, including the Layer 2 header and label header.
MTU MTU of the labeled packet.
label Stack All the outgoing labels. If the outgoing interface is transmission convergence
(TC)-ATM, the VCD is also shown.
Note TC-ATM is not supported on Cisco 10000 series routers.
00010000AAAA030000008847 The actual encapsulation in hexadecimal form. A space is shown between
00013000 Layer 2 and the label header.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1075
Multiprotocol Label Switching
show mpls forwarding-table
Explicit-Null Label Example
The following is sample output, including the explicit-null label = 0 (commented in bold), for the
show mpls forwarding-table command on a CSC-PE device:
Device# show mpls forwarding-table
Local Outgoing Prefix Bytes label Outgoing Next Hop
label label or VC or Tunnel Id switched interface
17 Pop label 10.10.0.0/32 0 Et2/0 10.10.0.1
18 Pop label 10.10.10.0/24 0 Et2/0 10.10.0.1
19 Aggregate 10.10.20.0/24[V] 0
20 Pop label 10.10.200.1/32[V] 0 Et2/1 10.10.10.1
21 Aggregate 10.10.1.1/32[V] 0
22 0 192.168.101.101/32[V] \
0 Et2/1 192.168.101.101
23 0 192.168.101.100/32[V] \
0 Et2/1 192.168.101.100
25 0 192.168.102.125/32[V] 0 Et2/1 192.168.102.125 !outlabel
value 0
The table below describes the significant fields shown in the display.
Table 131: show mpls forwarding-table Field Descriptions
Field Description
Local label Label assigned by this device.
Outgoing label or VC Label assigned by the next hop or VPI/VCI used to get to the next hop. The entries
in this column are the following:
• [T]--Forwarding is through an LSP tunnel.
• No label--There is no label for the destination from the next hop or that label
switching is not enabled on the outgoing interface.
• Pop label--The next hop advertised an implicit NULL label for the destination
and that this device popped the top label.
• Aggregate--There are several prefixes for one local label. This entry is used
when IPv6 is configured on edge devices to transport IPv6 traffic over an IPv4
MPLS network.
• 0--The explicit null label value = 0.
Prefix or Tunnel Id Address or tunnel to which packets with this label are sent.
Note If IPv6 is configured on edge devices to transport IPv6 traffic over an
IPv4 MPLS network, IPv6 is displayed here.
• [V]--Means that the corresponding prefix is in a VRF.
Bytes label switched Number of bytes switched with this incoming label. This includes the outgoing label
and Layer 2 header.
Outgoing interface Interface through which packets with this label are sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1076
Multiprotocol Label Switching
show mpls forwarding-table
Field Description
Next Hop IP address of the neighbor that assigned the outgoing label.
Cisco IOS Software Modularity: MPLS Layer 3 VPNs Example
The following is sample output from the show mpls forwarding-table command:
Device# show mpls forwarding-table
Local Outgoing Prefix Bytes Label Outgoing Next Hop
Label Label or Tunnel Id Switched interface
16 Pop Label IPv4 VRF[V] 62951000 aggregate/v1
17 [H] No Label 10.1.1.0/24 0 AT1/0/0.1 point2point
No Label 10.1.1.0/24 0 PO3/1/0 point2point
[T] No Label 10.1.1.0/24 0 Tu1 point2point
18 [HT] Pop Label 10.0.0.3/32 0 Tu1 point2point
19 [H] No Label 10.0.0.0/8 0 AT1/0/0.1 point2point
No Label 10.0.0.0/8 0 PO3/1/0 point2point
20 [H] No Label 10.0.0.0/8 0 AT1/0/0.1 point2point
No Label 10.0.0.0/8 0 PO3/1/0 point2point
21 [H] No Label 10.0.0.1/32 812 AT1/0/0.1 point2point
No Label 10.0.0.1/32 0 PO3/1/0 point2point
22 [H] No Label 10.1.14.0/24 0 AT1/0/0.1 point2point
No Label 10.1.14.0/24 0 PO3/1/0 point2point
23 [HT] 16 172.1.1.0/24[V] 0 Tu1 point2point
24 [HT] 24 10.0.0.1/32[V] 0 Tu1 point2point
25 [H] No Label 10.0.0.0/8[V] 0 AT1/1/0.1 point2point
26 [HT] 16 10.0.0.3/32[V] 0 Tu1 point2point
27 No Label 10.0.0.1/32[V] 0 AT1/1/0.1 point2point
[T] Forwarding through a TSP tunnel.
View additional labelling info with the 'detail' option
[H] Local label is being held down temporarily.
The table below describes the Local Label fields relating to the Cisco IOS Software Modularity:
MPLS Layer 3 VPNs feature.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1077
Multiprotocol Label Switching
show mpls forwarding-table
Table 132: show mpls forwarding-table Field Descriptions
Field Description
Local Label Label assigned by this device.
• [H]--Local labels are in holddown, which means that the application that requested the
labels no longer needs them and stops advertising them to its labeling peers.
The label’s forwarding-table entry is deleted after a short, application-specific time.
If any application starts advertising a held-down label to its labeling peers, the label could come
out of holddown.
Note [H] is not shown if labels are held down globally.
A label enters global holddown after a stateful switchover or a restart of certain processes in
a Cisco IOS modularity environment.
• [T]--The label is forwarded through an LSP tunnel.
Note Although [T] is still a property of the outgoing interface, it is shown in the Local
Label column.
• [HT]--Both conditions apply.
L2VPN Inter-AS Option B: Example
The following is sample output from the show mpls forwarding-table interface command. In this
example, the pseudowire identifier (that is, 4096) is displayed in the Prefix or Tunnel Id column.
The show mpls l2transport vc detail command can be used to obtain more information about the
specific pseudowire displayed.
Device# show mpls forwarding-table
Local Outgoing Prefix Bytes Label Outgoing Next Hop
Label Label or Tunnel Id Switched interface
1011 No Label l2ckt(4096) 0 none point2point
The table below describes the fields shown in the display.
Table 133: show mpls forwarding-table interface Field Descriptions
Field Description
Local Label Label assigned by this device.
Outgoing Label Label assigned by the next hop or virtual path identifier (VPI)/virtual channel identifier
(VCI) used to get to the next hop.
Prefix or Tunnel Id Address or tunnel to which packets with this label are going.
Bytes Label Switched Number of bytes switched with this incoming label. This includes the outgoing label
and Layer 2 header.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1078
Multiprotocol Label Switching
show mpls forwarding-table
Field Description
Outgoing interface Interface through which packets with this label are sent.
Next Hop IP address of the neighbor that assigned the outgoing label.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1079
Multiprotocol Label Switching
show mpls static binding
show mpls static binding
To display Multiprotocol Label Switching (MPLS) static label bindings, use the show mpls static binding
command in privileged EXEC mode.
show mpls static binding[{ipv4[{vrf vrf-name}]}][{prefix{mask-lengthmask}}][{local | remote}][{nexthop
address}]
Syntax Description ipv4 (Optional) Displays IPv4 static label bindings.
vrf vrf-name (Optional) The static label bindings for a specified VPN routing and
forwarding instance.
prefix {mask-length | mask} (Optional) Labels for a specific prefix.
local (Optional) Displays the incoming (local) static label bindings.
remote (Optional) Displays the outgoing (remote) static label bindings.
nexthop address (Optional) Displays the label bindings for prefixes with outgoing labels for
which the specified next hop is to be displayed.
Command Modes
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines If you do not specify any optional arguments, the show mpls static binding command displays information
about all static label bindings. Or the information can be limited to any of the following:
• Bindings for a specific prefix or mask
• Local (incoming) labels
• Remote (outgoing) labels
• Outgoing labels for a specific next hop router
Examples In the following output, the show mpls static binding ipv4 command with no optional arguments
displays all static label bindings:
Device# show mpls static binding ipv4
10.0.0.0/8: Incoming label: none;
Outgoing labels:
10.13.0.8 explicit-null
10.0.0.0/8: Incoming label: 55 (in LIB)
Outgoing labels:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1080
Multiprotocol Label Switching
show mpls static binding
10.0.0.66 2607
10.66.0.0/16: Incoming label: 17 (in LIB)
Outgoing labels: None
In the following output, the show mpls static binding ipv4 command displays remote (outgoing)
statically assigned labels only:
Device# show mpls static binding ipv4 remote
10.0.0.0/8:
Outgoing labels:
10.13.0.8 explicit-null
10.0.0.0/8:
Outgoing labels:
10.0.0.66 2607
In the following output, the show mpls static binding ipv4 command displays local (incoming)
statically assigned labels only:
Device# show mpls static binding ipv4 local
10.0.0.0/8: Incoming label: 55 (in LIB)
10.66.0.0/16: Incoming label: 17 (in LIB)
In the following output, theshow mpls static binding ipv4 command displays statically assigned
labels for prefix 10.0.0.0 / 8 only:
Device# show mpls static binding ipv4 10.0.0.0/8
10.0.0.0/8: Incoming label: 55 (in LIB)
Outgoing labels:
10.0.0.66 2607
In the following output, the show mpls static binding ipv4 command displays prefixes with statically
assigned outgoing labels for next hop 10.0.0.66:
Device# show mpls static binding ipv4 10.0.0.0 8 nexthop 10.0.0.66
10.0.0.0/8: Incoming label: 55 (in LIB)
Outgoing labels:
10.0.0.66 2607
The following output, the show mpls static binding ipv4 vrf command displays static label bindings
for a VPN routing and forwarding instance vpn100:
Device# show mpls static binding ipv4 vrf vpn100
192.168.2.2/32: (vrf: vpn100) Incoming label: 100020
Outgoing labels: None
192.168.0.29/32: Incoming label: 100003 (in LIB)
Outgoing labels: None
Related Commands Command Description
mpls static binding ipv4 Binds an IPv4 prefix or mask to a local or remote label.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1081
Multiprotocol Label Switching
show mpls static crossconnect
show mpls static crossconnect
To display statically configured Label Forwarding Information Database (LFIB) entries, use the show mpls
static crossconnect command in privileged EXEC mode.
show mpls static crossconnect [low label [high label]]
Syntax Description low label high label (Optional) The statically configured LFIB entries.
Command Modes
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines If you do not specify any label arguments, then all the configured static cross-connects are displayed.
Examples The following sample output from the show mpls static crossconnect command shows the local
and remote labels:
Device# show mpls static crossconnect
Local Outgoing Outgoing Next Hop
label label interface
45 46 pos5/0 point2point
The table below describes the significant fields shown in the display.
Table 134: show mpls static crossconnect Field Descriptions
Field Description
Local label Label assigned by this router.
Outgoing label Label assigned by the next hop.
Outgoing interface Interface through which packets with this label are sent.
Next Hop IP address of the next hop router’s interface that is connected to this router’s outgoing
interface.
Related Commands Command Description
mpls static crossconnect Configures an LFIB entry for the specified incoming label and outgoing interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1082
Multiprotocol Label Switching
mpls static binding ipv4
mpls static binding ipv4
To bind a prefix to a local or remote label, use the mpls static binding ipv4 command in global configuration
mode. To remove the binding between the prefix and label, use the no form of this command.
mpls static binding ipv4 prefix mask {label | input label | output nexthop {explicit-null |
implicit-nulllabel}}
no mpls static binding ipv4 prefix mask {label | input label | output nexthop {explicit-null |
implicit-nulllabel}}
prefix mask Specifies the prefix and mask to bind to a label. (When you do not use the
input or output keyword, the specified label is an incoming label.)
Note Without the arguments, the no form of the command removes
all static bindings.
label Binds a prefix or a mask to a local (incoming) label. (When you do not use
the input or output keyword, the specified label is an incoming label.)
input label Binds the specified label to the prefix and mask as a local (incoming) label.
output nexthop explicit-null Binds the Internet Engineering Task Force (IETF) Multiprotocol Label
Switching (MPLS) IPv4 explicit null label (0) as a remote (outgoing) label.
output nexthop implicit-null Binds the IETF MPLS implicit null label (3) as a remote (outgoing) label.
output nexthop label Binds the specified label to the prefix/mask as a remote (outgoing) label.
Command Default Prefixes are not bound to local or remote labels.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The mpls static binding ipv4 command pushes bindings into Label Distribution Protocol (LDP). LDP then
needs to match the binding with a route in the Routing Information Base (RIB) or Forwarding Information
Base (FIB) before installing forwarding information.
The mpls static binding ipv4 command installs the specified bindings into the LDP Label Information Base
(LIB). LDP will install the binding labels for forwarding use if or when the binding prefix or mask matches
a known route.
Static label bindings are not supported for local prefixes, which are connected networks, summarized routes,
default routes, and supernets. These prefixes use implicit-null or explicit-null as the local label.
If you do not specify the input or the output keyword, input (local label) is assumed.
For the no form of the command:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1083
Multiprotocol Label Switching
mpls static binding ipv4
• If you specify the command name without any keywords or arguments, all static bindings are removed.
• Specifying the prefix and mask but no label parameters removes all static bindings for that prefix or
mask.
Examples In the following example, the mpls static binding ipv4 command configures a static prefix and label
binding before the label range is reconfigured to define a range for static assignment. The output of
the command indicates that the binding has been accepted, but cannot be used for MPLS forwarding
until you configure a range of labels for static assignment that includes that label.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# mpls static binding ipv4 10.0.0.0 255.0.0.0 55
% Specified label 55 for 10.0.0.0/8 out of configured
% range for static labels. Cannot be used for forwarding until
% range is extended.
Router(config)# end
The following mpls static binding ipv4 commands configure input and output labels for several
prefixes:
Device(config)# mpls static binding ipv4 10.0.0.0 255.0.0.0 55
Device(config)# mpls static binding ipv4 10.0.0.0 255.0.0.0 output 10.0.0.66 2607
Device(config)# mpls static binding ipv4 10.66.0.0 255.255.0.0 input 17
Device(config)# mpls static binding ipv4 10.66.0.0 255.255.0.0 output 10.13.0.8 explicit-null
Device(config)# end
The following show mpls static binding ipv4 command displays the configured bindings:
Device# show mpls static binding ipv4
10.0.0.0/8: Incoming label: 55
Outgoing labels:
10.0.0.66 2607
10.66.0.0/24: Incoming label: 17
Outgoing labels:
10.13.0.8 explicit-null
Related Commands Command Description
show mpls forwarding-table Displays labels currently being used for MPLS forwarding.
show mpls label range Displays statically configured label bindings.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1084
Multiprotocol Label Switching
show platform hardware fed (TCAM utilization)
show platform hardware fed (TCAM utilization)
To display Ternary Content Addressable Memory (TCAM) utilization information, use the show platform
hardware fed switch command in privileged EXEC mode.
show platform hardware fed switch{switch_number|active|standby} fwd-asic resource tcam
utilization[asic_number|detail]
Syntax Description switch{switch_number|active|standby} Selects the switch which you want to display
information.
• switch_number—ID of the switch.
• active—Displays information related to
the active switch.
• standby—Displays information relating
to standby switch.
fwd-asic Displays ASIC information for each ASIC.
resource Displays all ASIC resources.
tcam Displays TCAM resource information.
utilization[asic_number|detail] Displays the current Content Addressable
Memory (CAM) utilization.
• asic_number—ASIC number. The range
is from 0 to 7.
• detail—Displays detailed CAM
utilization information. This option is
available if the service internal command
is configured on the device.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Amsterdam 17.2.1 The command output was enhanced to display TCAM utilization
categorised by IPv4, IPv6, MPLS and other protocols.
Usage Guidelines The output displayed is for each ASIC on the device which includes the sum of two cores of the ASIC.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1085
Multiprotocol Label Switching
show platform hardware fed (TCAM utilization)
Example
The following is sample output from the show platform hardware fed switch active fwd-asic
resource tcam utilization command:
Device> enable
Device# show platform software fed switch active fwd-asic resource tcam utilization
Codes: EM - Exact_Match, I - Input, O - Output, IO - Input & Output, NA - Not Applicable
CAM Utilization for ASIC [0]
Table Subtype Dir Max Used %Used V4 V6 MPLS Other
------------------------------------------------------------------------------------------------
Mac Address Table EM I 81920 23 0% 0 0 0 23
Mac Address Table TCAM I 768 21 2% 0 0 0 21
L3 Multicast EM I 16384 0 0% 0 0 0 0
L3 Multicast TCAM I 768 35 4% 3 32 0 0
L2 Multicast TCAM I 2304 7 0% 3 4 0 0
IP Route Table EM/LPM I 114688 18 0% 18 0 0 0
IP Route Table TCAM I 1536 13 0% 10 3 0 0
QOS ACL Ipv4 TCAM I 5632 15 0% 15 0 0 0
QOS ACL Non Ipv4 TCAM I 2560 30 1% 0 20 0 10
QOS ACL Ipv4 TCAM O 6144 13 0% 13 0 0 0
QOS ACL Non Ipv4 TCAM O 2048 27 1% 0 18 0 9
Security ACL Ipv4 TCAM I 7168 12 0% 12 0 0 0
Security ACL Non
Ipv4 TCAM I 5120 76 1% 0 36 0 40
Security ACL Ipv4 TCAM O 7168 13 0% 13 0 0 0
Security ACL Non
Ipv4 TCAM O 8192 27 0% 0 22 0 5
Netflow ACL TCAM I 1024 6 0% 2 2 0 2
PBR ACL TCAM I 3072 22 0% 16 6 0 0
Netflow ACL TCAM O 1024 6 0% 2 2 0 2
Flow SPAN ACL TCAM I 512 5 0% 1 2 0 2
Flow SPAN ACL TCAM O 512 8 1% 2 4 0 2
Control Plane TCAM I 1024 256 25% 110 104 0 42
Tunnel Termination TCAM I 2816 26 0% 10 16 0 0
Lisp Inst Mapping TCAM I 1024 1 0% 0 0 0 1
CTS Cell Matrix/VPN
Label EM O 32768 0 0% 0 0 0 0
CTS Cell Matrix/VPN
Label TCAM O 768 1 0% 0 0 0 1
Client Table EM I 8192 0 0% 0 0 0 0
Client Table TCAM I 512 0 0% 0 0 0 0
Input Group LE TCAM I 1024 0 0% 0 0 0 0
Output Group LE TCAM O 1024 0 0% 0 0 0 0
Macsec SPD TCAM I 256 2 0% 0 0 0 2
CAM Utilization for ASIC [1]
Table Subtype Dir Max Used %Used V4 V6 MPLS Other
------------------------------------------------------------------------------------------------------
Mac Address Table EM I 81920 23 0% 0 0 0 23
Mac Address Table TCAM I 768 21 2% 0 0 0 21
L3 Multicast EM I 16384 0 0% 0 0 0 0
L3 Multicast TCAM I 768 35 4% 3 32 0 0
L2 Multicast TCAM I 2304 7 0% 3 4 0 0
IP Route Table EM/LPM I 114688 18 0% 18 0 0 0
IP Route Table TCAM I 1536 13 0% 10 3 0 0
QOS ACL Ipv4 TCAM I 5632 15 0% 15 0 0 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1086
Multiprotocol Label Switching
show platform hardware fed (TCAM utilization)
QOS ACL Non Ipv4 TCAM I 2560 30 1% 0 20 0 10
QOS ACL Ipv4 TCAM O 6144 12 0% 12 0 0 0
QOS ACL Non Ipv4 TCAM O 2048 24 1% 0 16 0 8
Security ACL Ipv4 TCAM I 7168 12 0% 12 0 0 0
Security ACL Non
Ipv4 TCAM I 5120 76 1% 0 36 0 40
Security ACL Ipv4 TCAM O 7168 13 0% 13 0 0 0
Security ACL Non
Ipv4 TCAM O 8192 27 0% 0 22 0 5
Netflow ACL TCAM I 1024 6 0% 2 2 0 2
PBR ACL TCAM I 3072 22 0% 16 6 0 0
Netflow ACL TCAM O 1024 6 0% 2 2 0 2
Flow SPAN ACL TCAM I 512 5 0% 1 2 0 2
Flow SPAN ACL TCAM O 512 8 1% 2 4 0 2
Control Plane TCAM I 1024 256 25% 110 104 0 42
Tunnel Termination TCAM I 2816 26 0% 10 16 0 0
Lisp Inst Mapping TCAM I 1024 1 0% 0 0 0 1
CTS Cell Matrix/VPN
Label EM O 32768 0 0% 0 0 0 0
CTS Cell Matrix/VPN
Label TCAM O 768 1 0% 0 0 0 1
Client Table EM I 8192 0 0% 0 0 0 0
Client Table TCAM I 512 0 0% 0 0 0 0
Input Group LE TCAM I 1024 0 0% 0 0 0 0
Output Group LE TCAM O 1024 0 0% 0 0 0 0
Macsec SPD TCAM I 256 2 0% 0 0 0 2
Table 135: show platform hardware fed (TCAM utilization) Field Descriptions
Field Description
Table Displays the feature configured on the device.
Subtype Displays resource type.
Dir Displays direction of traffic.
Max Displays maximum number of entries allocated.
Used Displays number of entries used.
%Used Displays percentage of entries used.
V4 Displays number of entries used by IPv4 protocol.
V6 Displays number of entries used by IPv6 protocol.
MPLS Displays number of entries used by MPLS protocol.
Other Displays number of entries used by other protocols.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1087
Multiprotocol Label Switching
show platform software fed switch l2vpn
show platform software fed switch l2vpn
To display device-specific software information, use the show platform software fed switch command.
show platform software fed switch {switch number | active | standby} l2vpn {atom-disposition |
atom-imposition | summary | vfi-segment | xconnect}
Note This topic elaborates on only the Layer 2 VPN-specific (L2VPN-specific) options available with the show
platform software fed switch l2vpn command.
Syntax Description switch {switch Specifies the device for which you want to display information.
number | active |
• switch number: Switch ID. Displays information about the specified switch.
standby}
• active: Displays information about the active switch.
• standby: Displays information about the standby switch, if available.
l2vpn Displays L2VPN information. Choose one of the following options:
• atom-disposition: Displays L2VPN atom disposition information.
• atom-imposition: Displays L2VPN atom imposition information.
• summary: Displays L2VPN summary.
• vfi-segment: Displays L2VPN Virtual Forwarder Interface (VFI) segment
information.
• xconnect: Displays L2VPN Xconnect information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following is a sample output of the show platform software fed switch l2vpn command:
Device# show platform software fed switch 1 l2vpn atom-disposition all
Number of disp entries:25
ATOM_DISP:6682 ac_ifhdl:4325527 xconid:0 dot1q_etype:0
disp_flags:0x111 pdflags:0 hw_handle:0x4b010118
disp flags (FED) in detail CW_IN_USE VCCV L2L
AAL: id:1258357016 , port_id:4325527, adj_flags:0x4 pw_id:1074 ref_cnt:1
adj_flags in detail: PORT MODE VC CW Enabled
port_hdl:0x5c01020f, dot1q:0 , is_vfi_seg;1 vfi_seg_hdl:0 stats_valid:1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1088
Multiprotocol Label Switching
show platform software fed switch l2vpn
drop_adj_flag:0 unsupported_feature:0
sih:0x7f1c6ce84b58(18438) di_id:23713 rih:0x7f1c6ce845a8(5154)
ATOM_DISP:12654 ac_ifhdl:311 xconid:1104 dot1q_etype:0
disp_flags:0x211 pdflags:0 hw_handle:0xad000139
disp flags (FED) in detail CW_IN_USE VCCV ETHERNET_ITW
AAL: id:2902458681 , port_id:311, adj_flags:0xc pw_id:54 ref_cnt:1
adj_flags in detail: TYPE5 VC CW Enabled
port_hdl:0xe1000254, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:0 unsupported_feature:0
sih:0x7f1c6a6b5078(17152) di_id:24265 rih:0x7f1c6a6b4ac8(3678)
ATOM_DISP:17319 ac_ifhdl:1248 xconid:3500 dot1q_etype:0
disp_flags:0x211 pdflags:0 hw_handle:0x8c000185
disp flags (FED) in detail CW_IN_USE VCCV ETHERNET_ITW
AAL: id:2348810629 , port_id:1248, adj_flags:0xc pw_id:991 ref_cnt:1
adj_flags in detail: TYPE5 VC CW Enabled
port_hdl:0x8d0101fd, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:0 unsupported_feature:0
sih:0x7f1c6ad17288(16884) di_id:24265 rih:0x7f1c6ad16d48(518)
ATOM_DISP:17325 ac_ifhdl:1249 xconid:3201 dot1q_etype:0
disp_flags:0x211 pdflags:0 hw_handle:0xdd000184
disp flags (FED) in detail CW_IN_USE VCCV ETHERNET_ITW
AAL: id:3707765124 , port_id:1249, adj_flags:0xc pw_id:993 ref_cnt:1
adj_flags in detail: TYPE5 VC CW Enabled
port_hdl:0x10101fe, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:0 unsupported_feature:0
sih:0x7f1c6ad1cb58(16885) di_id:24265 rih:0x7f1c6ad17858(520)
ATOM_DISP:17330 ac_ifhdl:1249 xconid:3201 dot1q_etype:0
disp_flags:0x1211 pdflags:0 hw_handle:0x37000183
disp flags (FED) in detail CW_IN_USE VCCV ETHERNET_ITW PW_STANDBY
AAL: id:922747267 , port_id:1249, adj_flags:0xc pw_id:994 ref_cnt:1
adj_flags in detail: TYPE5 VC CW Enabled
port_hdl:0x10101fe, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:1 unsupported_feature:0
sih:0x7f1c6b88f0e8(16886) di_id:3212 rih:0x7f1c6ad1d798(522)
ATOM_DISP:17335 ac_ifhdl:1250 xconid:3202 dot1q_etype:0
disp_flags:0x411 pdflags:0 hw_handle:0xb1000182
disp flags (FED) in detail CW_IN_USE VCCV VLAN_ITW
AAL: id:2969567618 , port_id:1250, adj_flags:0x5 pw_id:995 ref_cnt:1
adj_flags in detail: TYPE4 VC/PORT MODE CW Enabled
port_hdl:0x500101ff, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:0 unsupported_feature:0
sih:0x7f1c6b893b38(16887) di_id:24265 rih:0x7f1c6b893588(526)
ATOM_DISP:17340 ac_ifhdl:1250 xconid:3202 dot1q_etype:0
disp_flags:0x1411 pdflags:0 hw_handle:0x3e000181
disp flags (FED) in detail CW_IN_USE VCCV VLAN_ITW PW_STANDBY
AAL: id:1040187777 , port_id:1250, adj_flags:0x5 pw_id:996 ref_cnt:1
adj_flags in detail: TYPE4 VC/PORT MODE CW Enabled
port_hdl:0x500101ff, dot1q:0 , is_vfi_seg;0 vfi_seg_hdl:0 stats_valid:1
drop_adj_flag:1 unsupported_feature:0
sih:0x7f1c6bd6b7d8(16888) di_id:3212 rih:0x7f1c6bd6b298(528)
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1089
Multiprotocol Label Switching
show platform software fed switch mpls
show platform software fed switch mpls
To display device-specific software information, use the show platform software fed switch command.
show platform software fed switch {switch number | active | standby } mpls {eos | forwarding |
label_oce | lookup | summary}
Note This topic elaborates only the Multiprotocol Label Switching-specific options available with the show platform
software fed switch mpls command.
Syntax Description switch {switch number | Specifies the device for which you want to display information.
active | standby}
• switch number: Switch ID. Displays information about the specified
switch.
• active: Displays information about the active switch.
• standby: Displays information about the standby switch, if available.
mpls Displays MPLS information. Choose one of the following options:
• eos: Displays MPLS end of stack (EOS) information.
• forwarding: Displays MPLS forwarding information.
• label_oce: Displays MPLS label output chain element (OCE)
information.
• lookup: Displays MPLS lookup information.
• summary: Displays the summary of the MPLS configuration.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following is a sample output of the show platform software fed switch mpls command:
Device# show platform software fed switch 1 mpls summary
Number of lentries: 2024
# of create/modify/delete msgs: 3595/15390/1571
LENTRY create paused: 0
LENTRY Number of create paused: 0
LENTRY Number of add after create paused: 3595
LENTRY Number of out-of-resource: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1090
Multiprotocol Label Switching
show platform software fed switch mpls
Number of lable oce entries: 4015
# of create/modify/delete msgs: 21165/2993/17150
# of unsupported_recursive_lbls: 0
# of AAL mpls adj deleted and recreated: 0
# of AAL local mpls adj deleted and recreated: 0
# of changes from mpls-adj -> mpls-local-adj: 0
# of changes from local-mpls-adj -> mpls-adj: 0
# of out label changes in lbl_oce 0
# of collapsed oce 0
# of unsuppoted_nh 0
Number of EOS oce entries: 1991
# of create/modify/delete msgs: 6303/7/4312
Number of ECR bwalk apply skipped: 0
Number of ECR entries: ipv4/ipv6: 22/0
# of create/modify/delete msgs: 5196/1/5174
# of ECR nested backwalks ignore:0
ECR OOR Retry queue size:0
AAL L3 ECR summary:
# of ecr add/modify/delete ::6/4/3
# of modify from level-1 to level-2:0
# of modify from level-2 to level-1:0
# of ecr delete errs::0
# of ecr create skip refcnt::0
# of ecr modify inuse: 1 nochange:3 inplace:0
MPLS Summary: Info at AAL layers:
General info:
Number of Physical ASICs:2
Number of ASIC Instances:4
num_modify_stack_in_use: 0
num_modify_ri_in_use: 0
Feature IDs:{l2_fid:57 mpls_fid:152 vpws_fid:153 vpls_fid:154}
MAX values from selected SDM template:
MAX label entries: 45056
MAX LSPA entries: 32768
MAX L3VPN VRF(rc:0): 1024
MAX L3VPN Routes PerVrF Mode(rc:0): 209920
MAX L3VPN Routes PerPrefix Mode(rc:0): 32768
MAX ADJ stats counters: 49152
Resource sharing info:
SI: 1133/131072
RI: 4943/98304
Well Known Index: 8024/2048
Tcam: 4962/245760
lv1_ecr: 0/64
lv2_ecr: 3/256
lspa: 0/32769
label_stack_id: 26/65537
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1091
Multiprotocol Label Switching
show platform software l2vpn switch
show platform software l2vpn switch
To display the software information of Layer 2 VPN (L2VPN), use the show platform software l2vpn switch
command.
show platform software fed switch {switch number | active | standby}{F0 | F1 | R0 | R1 | RP |
{active | standby}}{atom | disposition | imposition | internal}
Syntax Description switch {switch number The device for which you want to display information.
| active | standby}
• switch number: Switch ID. Displays information for the specified switch.
• active: Displays information for the active switch.
• standby: Displays information for the standby switch, if available.
F0 Displays information about the Embedded Service Processor (ESP) slot 0.
F1 Displays information about the ESP slot 1.
R0 Displays information about the Route Processor (RP) slot 0.
R1 Displays information about the RP slot 1.
RP Displays information about the RP. Choose one of the following options:
• active: Displays information about the active RP.
• standby: Displays information about the standby RP.
atom Displays information about the Any Transport over MPLS (AToM) cross-connect
table.
disposition Displays information about the disposition output chain element (OCE).
imposition Displays information about the imposition OCE.
internal Displays information about AToM's internal state and statistics.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following is a sample output of the show platform software l2vpn switch command:
Device# show platform software l2vpn switch 1 R0 atom
Number of xconnect entries: 24
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1092
Multiprotocol Label Switching
show platform software l2vpn switch
AToM Cross-Connect xid 0x137, ifnumber 0x137
AC VLAN(IW:ETHERNET) -> Imp 0x316d(ATOM_IMP), OM handle: 0x3480fb3268
VLAN Info: outVlan id: 1104, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e0, ifnumber 0x4e0
AC VLAN(IW:ETHERNET) -> Imp 0x43a6(ATOM_IMP), OM handle: 0x348118f120
VLAN Info: outVlan id: 3500, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e1, ifnumber 0x4e1
AC VLAN(IW:ETHERNET) -> Imp 0x43ac(ATOM_IMP), OM handle: 0x348118f348
VLAN Info: outVlan id: 3201, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e1, ifnumber 0x4e1
AC VLAN(IW:ETHERNET) -> Imp 0x43b1(ATOM_IMP), OM handle: 0x348118f570
VLAN Info: outVlan id: 3201, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e2, ifnumber 0x4e2
AC VLAN(IW:VLAN) -> Imp 0x43b6(ATOM_IMP), OM handle: 0x348118f798
VLAN Info: outVlan id: 3202, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e2, ifnumber 0x4e2
AC VLAN(IW:VLAN) -> Imp 0x43bb(ATOM_IMP), OM handle: 0x348118f9c0
VLAN Info: outVlan id: 3202, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e3, ifnumber 0x4e3
AC VLAN(IW:VLAN) -> Imp 0x43c0(ATOM_IMP), OM handle: 0x348118fbe8
VLAN Info: outVlan id: 3203, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e3, ifnumber 0x4e3
AC VLAN(IW:VLAN) -> Imp 0x43c5(ATOM_IMP), OM handle: 0x348118fe10
VLAN Info: outVlan id: 3203, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
AToM Cross-Connect xid 0x4e4, ifnumber 0x4e4
AC VLAN(IW:ETHERNET) -> Imp 0x43ca(ATOM_IMP), OM handle: 0x3481189e20
VLAN Info: outVlan id: 3204, inVlan id: 0, outEther: 0x8100, peerVlan id: 0, dot1qAny: 0
.
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1093
Multiprotocol Label Switching
source template type pseudowire
source template type pseudowire
To configure the name of a source template of type pseudowire, use the source template type pseudowire
command in interface configuration mode. To remove a source template of type pseudowire, use the no form
of this command.
source template type pseudowire template-name
no source template type pseudowire
Syntax Description template-name The name of source template of type pseudowire.
Command Default A source template of type pseudowire is not configured.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines The source template type pseudowire command applies a source template of type pseudowire that consists
of configuration settings used by all pseudowires bound to the template.
Examples The following example shows how to configure the source template of type pseudowire named
ether-pw:
Device> enable
Device# configure terminal
Device(config)# interface pseudowire 100
Device(config-if)# source template type pseudowire ether-pw
Related Commands Command Description
xconnect Binds an attachment circuit to a pseudowire and configures an
AToM static pseudowire.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1094
Multiprotocol Label Switching
tunnel destination
tunnel destination
To specify the destination for a tunnel interface, use the tunnel destination command in interface configuration
mode. To remove the destination, use the no form of this command.
tunnel destination {host-name ip-address ipv6-address | dynamic}
no tunnel destination
Syntax Description host-name Name of the host destination.
ip-address IP address of the host destination expressed in dotted decimal notation.
ipv6-address IPv6 address of the host destination expressed in IPv6 address format.
dynamic Applies the tunnel destination address dynamically to the tunnel interface.
Command Default No tunnel interface destination is specified.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Gibraltar 16.11.1 This command was introduced.
Usage Guidelines You cannot configure two tunnels to use the same encapsulation mode with exactly the same source and
destination addresses. The workaround is to create a loopback interface and configure the packet source off
of the loopback interface.
Examples The following example shows how to configure the logical Layer 3 GRE tunnel interface tunnel 2
in a global or non-VRF environment:
Device> enable
Device# configure terminal
Device(config)# interface tunnel 2
Device(config-if)# ip address 100.1.1.1 255.255.255.0
Device(config-if)# tunnel source 10.10.10.1
Device(config-if)# tunnel destination 10.10.10.2
Device(config-if)# tunnel mode gre ip
Device(config-if)# end
The following example shows how to configure the logical Layer 3 GRE tunnel interface tunnel 2
in a VRF environment. Use the vrf definition vrf-name and the vrf forwarding vrf-name commands
to configure and apply VRF.
Device> enable
Device# configure terminal
Device(config)# interface tunnel 2
Device(config-if)# ip address 100.1.1.1 255.255.255.0
Device(config-if)# tunnel source 10.10.10.1
Device(config-if)# tunnel destination 10.10.10.2
Device(config-if)# tunnel mode gre ip
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1095
Multiprotocol Label Switching
tunnel mpls-ip-only
tunnel mpls-ip-only
To copy the Do Not Fragment bit of the inner IP header from the payload into the IP header of the tunnel
packet, use the tunnel mpls-ip-only command in the interface configuration mode. To undo the copy operation,
use the no form of this command.
tunnel mpls-ip-only
no tunnel mpls-ip-only
Syntax Description This command has no arguments or keywords.
Command Default Disabled
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines If the Do Not Fragment bit is not set, the payload is fragmented when the IP packet exceeds the MTU set for
the interface. When you enable the tunnel mpls-ip-only command, the tunnel path-mtu-discovery
automatically gets enabled due to the dependency.
Examples The following example shows how to enable this command:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/1/3
Device(config-if)# tunnel mpls-ip-only
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1096
Multiprotocol Label Switching
tunnel source
tunnel source
To set the source address for a tunnel interface, use the tunnel source command in interface configuration
mode. To remove the source address, use the no form of this command.
tunnel source {ip-address | ipv6-address | interface-type interface-number | dynamic}
no tunnel source
Syntax Description ip-address Source IP address of the packets in the tunnel.
ipv6-address Source IPv6 address of the packets in the tunnel.
interface-type Interface type.
interface-number Port, connector, or interface card number. The numbers are assigned at the factory at the
time of installation or when added to a system. This number can be displayed with the
show interfaces command.
dynamic Applies the tunnel source address dynamically to the tunnel interface.
Command Default No tunnel interface source address is set.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Gibraltar 16.11.1 This command was introduced.
Usage Guidelines The source address is either an explicitly defined IP address or the IP address assigned to specified interface.
You cannot have two tunnels using the same encapsulation mode with exactly the same source and destination
addresses. The workaround is to create a loopback interface and source packets from the loopback interface.
Examples The following example shows how to configure the logical Layer 3 GRE tunnel interface tunnel 2
in a global or non-VRF environment:
Device> enable
Device# configure terminal
Device(config)# interface tunnel 2
Device(config-if)# ip address 100.1.1.1 255.255.255.0
Device(config-if)# tunnel source 10.10.10.1
Device(config-if)# tunnel destination 10.10.10.2
Device(config-if)# tunnel mode gre ip
Device(config-if)# end
The following example shows how to configure the logical Layer 3 GRE tunnel interface tunnel 2
in a VRF environment. Use the vrf definition vrf-name and the vrf forwarding vrf-name commands
to configure and apply VRF.
Device> enable
Device# configure terminal
Device(config)# interface tunnel 2
Device(config-if)# ip address 100.1.1.1 255.255.255.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1097
Multiprotocol Label Switching
tunnel source
Device(config-if)# tunnel source 10.10.10.1
Device(config-if)# tunnel destination 10.10.10.2
Device(config-if)# tunnel mode gre ip
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1098
Multiprotocol Label Switching
xconnect
xconnect
To bind an attachment circuit to a pseudowire, and to configure an Any Transport over MPLS (AToM) static
pseudowire, use the xconnect command in interface configuration mode. To restore the default values, use
the no form of this command.
xconnect peer-ip-address vc-id encapsulation mpls [pw-type]
no xconnect peer-ip-address vc-id encapsulation mpls [pw-type]
Syntax Description peer-ip-address IP address of the remote provider edge (PE) peer. The remote router ID can be any
IP address, as long as it is reachable.
vc-id The 32-bit identifier of the virtual circuit (VC) between PE devices.
encapsulation mpls Specifies Multiprotocol Label Switching (MPLS) as the tunneling method.
pw-type (Optional) Pseudowire type. You can specify one of the following types:
• 4: Specifies Ethernet VLAN.
• 5: Specifies Ethernet port.
Command Default The attachment circuit is not bound to the pseudowire.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Usage Guidelines The use of the xconnect command and the interface configuration mode bridge-group command is not
supported on the same physical interface.
The combination of the peer-ip-address and vcid arguments must be unique on the device. Each Xconnect
configuration must have a unique combination of peer-ip-address and vcid configuration.
The same vcid value that identifies the attachment circuit must be configured using the xconnect command
on the local and remote PE device. The VC ID creates the binding between a pseudowire and an attachment
circuit.
Examples The following example shows how to enter Xconnect configuration mode and bind the attachment
circuit to a pseudowire VC:
Device# configure terminal
Device(config)# interface TenGigabitEthernet1/0/36
Device(config-if)# no ip address
Device(config-if)# xconnect 10.1.10.1 962 encapsulation mpls
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1099
Multiprotocol Label Switching
xconnect
Related Commands Command Description
encapsulation mpls Specifies MPLS as the data encapsulation method.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1100
PA R T VIII
Network Management
• Network Management Commands, on page 1103
Network Management Commands
• active-timeout, on page 1107
• cache, on page 1108
• clear flow exporter, on page 1110
• clear flow monitor, on page 1111
• clear platform software fed switch swc connection, on page 1113
• clear platform software fed switch swc statistics, on page 1114
• clear snmp stats hosts, on page 1115
• collect, on page 1116
• collect counter, on page 1117
• collect flow sampler, on page 1118
• collect interface, on page 1119
• collect ipv4 destination, on page 1120
• collect ipv6 destination, on page 1121
• collect ipv4 source, on page 1122
• collect ipv6 source, on page 1124
• collect timestamp absolute, on page 1126
• collect transport tcp flags, on page 1127
• collect routing next-hop address, on page 1128
• datalink flow monitor, on page 1129
• debug flow exporter, on page 1130
• debug flow monitor, on page 1131
• debug flow record, on page 1132
• debug sampler, on page 1133
• description, on page 1134
• description (ERSPAN), on page 1135
• destination (ERSPAN), on page 1136
• destination, on page 1141
• dscp, on page 1142
• et-analytics, on page 1143
• et-analytics enable, on page 1144
• event manager applet, on page 1145
• export-protocol netflow-v9, on page 1148
• export-protocol netflow-v5, on page 1149
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1103
Network Management
• exporter, on page 1150
• fconfigure, on page 1151
• filter (ERSPAN), on page 1152
• flow exporter, on page 1154
• flow monitor, on page 1155
• flow record, on page 1156
• header-type, on page 1157
• inactive time, on page 1158
• ip flow-export destination, on page 1159
• ip wccp, on page 1160
• ip flow monitor, on page 1162
• ipv6 flow monitor, on page 1164
• ipv6 deny echo reply, on page 1166
• match datalink ethertype, on page 1167
• match datalink mac, on page 1168
• match datalink vlan, on page 1169
• match device-type, on page 1170
• match flow cts, on page 1171
• match flow direction, on page 1172
• match interface, on page 1173
• match ipv4, on page 1174
• match ipv4 destination address, on page 1175
• match ipv4 source address, on page 1176
• match ipv4 ttl, on page 1177
• match ipv6, on page 1178
• match ipv6 destination address, on page 1179
• match ipv6 hop-limit, on page 1180
• match ipv6 source address, on page 1181
• map platform-type, on page 1182
• match transport, on page 1183
• match transport icmp ipv4, on page 1184
• match transport icmp ipv6, on page 1185
• match platform-type, on page 1186
• mode random 1 out-of, on page 1187
• monitor capture (interface/control plane), on page 1188
• monitor capture buffer, on page 1190
• monitor capture clear, on page 1191
• monitor capture export, on page 1192
• monitor capture file, on page 1193
• monitor capture limit, on page 1195
• monitor capture match, on page 1196
• monitor capture pktlen-range , on page 1197
• monitor capture start, on page 1198
• monitor capture stop, on page 1199
• monitor session, on page 1200
• monitor session destination, on page 1202
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1104
Network Management
• monitor session filter, on page 1206
• monitor session source, on page 1208
• monitor session type, on page 1210
• option, on page 1212
• record, on page 1214
• sensor-name (stealthwatch-cloud-monitor), on page 1215
• service-key (stealthwatch-cloud-monitor), on page 1216
• show flow monitor etta-mon cache, on page 1217
• sampler, on page 1218
• show capability feature monitor, on page 1219
• show class-map type control subscriber, on page 1220
• show flow exporter, on page 1221
• show flow interface, on page 1223
• show flow monitor, on page 1225
• show flow record, on page 1227
• show ip sla statistics, on page 1228
• show monitor, on page 1230
• show monitor capture, on page 1232
• show monitor session, on page 1234
• show parameter-map type subscriber attribute-to-service, on page 1236
• show platform software et-analytics, on page 1237
• show platform software fed switch active fnf et-analytics-flow-dump, on page 1238
• show platform software fed switch ip wccp, on page 1239
• show platform software fed switch swc connection, on page 1241
• show platform software fed switch swc statistics, on page 1243
• show platform software swspan , on page 1245
• show sampler, on page 1247
• show snmp stats, on page 1249
• show stealth-watch-cloud detail, on page 1251
• shutdown (monitor session), on page 1252
• snmp ifmib ifindex persist, on page 1253
• snmp-server community, on page 1254
• snmp-server enable traps, on page 1256
• snmp-server enable traps bridge, on page 1259
• snmp-server enable traps bulkstat, on page 1260
• snmp-server enable traps call-home, on page 1261
• snmp-server enable traps cef, on page 1262
• snmp-server enable traps cpu, on page 1263
• snmp-server enable traps envmon, on page 1264
• snmp-server enable traps errdisable, on page 1265
• snmp-server enable traps flash, on page 1266
• snmp-server enable traps isis, on page 1267
• snmp-server enable traps license, on page 1268
• snmp-server enable traps mac-notification, on page 1269
• snmp-server enable traps ospf, on page 1270
• snmp-server enable traps pim, on page 1271
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1105
Network Management
• snmp-server enable traps port-security, on page 1272
• snmp-server enable traps power-ethernet, on page 1273
• snmp-server enable traps snmp, on page 1274
• snmp-server enable traps stackwise, on page 1275
• snmp-server enable traps storm-control, on page 1277
• snmp-server enable traps stpx, on page 1278
• snmp-server enable traps transceiver, on page 1279
• snmp-server enable traps vrfmib, on page 1280
• snmp-server enable traps vstack, on page 1281
• snmp-server engineID, on page 1282
• snmp-server group, on page 1283
• snmp-server host, on page 1287
• snmp-server manager, on page 1292
• snmp-server user, on page 1293
• snmp-server view, on page 1297
• source, on page 1299
• source (ERSPAN), on page 1301
• socket, on page 1302
• stealthwatch-cloud-monitor, on page 1303
• switchport mode access, on page 1304
• switchport voice vlan, on page 1305
• ttl, on page 1306
• transport, on page 1307
• template data timeout, on page 1308
• udp peek, on page 1309
• url (stealthwatch-cloud-monitor), on page 1310
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1106
Network Management
active-timeout
active-timeout
To configure et-analytics active timer value, use the active-timeout secondscommand in the et-analytics
configuration mode.
To reset the timer settings to the default, use the no form of the command.
active-timeout seconds
no active-timeout seconds
Syntax Description active-timeout Configures the active-timeout
value.
seconds Sets the active-timeout value in
seconds. The supported range is
from 1 to 604800, and the default
value is 30 minutes.
Command Modes et-analytics configuration (config-et-analytics)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.x This command was introduced.
Usage Guidelines Prior to the Cisco IOS XE Bengaluru 17.6.x release, the active-timeout value was set to 1800 seconds, by
default. However, starting from Cisco IOS XE Bengaluru 17.6.x, you can configure the active-timeout value.
Example:
The following example shows how to configure an active-timeout of 300 seconds:
Device>enable
Device#configure terminal
Device(config)# et-analytics
Device(config-et-analytics)# active-timeout 300
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1107
Network Management
cache
cache
To configure a flow cache parameter for a flow monitor, use the cache command in flow monitor configuration
mode. To remove a flow cache parameter for a flow monitor, use the no form of this command.
cache {timeout {active | inactive | rate-limit | update} seconds | type normal}
no cache {timeout {active | inactive | rate-limit | update} | type}
Syntax Description timeout Specifies the flow timeout.
active Specifies the active flow timeout.
inactive Specifies the inactive flow timeout.
update Specifies the update timeout for a permanent flow cache.
seconds The timeout value in seconds. The range is 30 to 604800 (7 days)
for a normal flow cache. For a permanent flow cache the range is 1
to 604800 (7 days).
type Specifies the type of the flow cache.
normal Configures a normal cache type. The entries in the flow cache will
be aged out according to the timeout active seconds and timeout
inactive seconds settings. This is the default cache type.
Command Default The default flow monitor flow cache parameters are used.
The following flow cache parameters for a flow monitor are enabled:
• Cache type: normal
• Active flow timeout: 1800 seconds
Command Modes Flow monitor configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Each flow monitor has a cache that it uses to store all the flows it monitors. Each cache has various configurable
elements, such as the time that a flow is allowed to remain in it. When a flow times out, it is removed from
the cache and sent to any exporters that are configured for the corresponding flow monitor.
The cache timeout active command controls the aging behavior of the normal type of cache. If a flow has
been active for a long time, it is usually desirable to age it out (starting a new flow for any subsequent packets
in the flow). This age out process allows the monitoring application that is receiving the exports to remain up
to date. By default, this timeout is 1800 seconds (30 minutes), but it can be adjusted according to system
requirements. A larger value ensures that long-lived flows are accounted for in a single flow record; a smaller
value results in a shorter delay between starting a new long-lived flow and exporting some data for it. When
you change the active flow timeout, the new timeout value takes effect immediately.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1108
Network Management
cache
The cache timeout inactive command also controls the aging behavior of the normal type of cache. If a flow
has not seen any activity for a specified amount of time, that flow will be aged out. By default, this timeout
is 15 seconds, but this value can be adjusted depending on the type of traffic expected. If a large number of
short-lived flows is consuming many cache entries, reducing the inactive timeout can reduce this overhead.
If a large number of flows frequently get aged out before they have finished collecting their data, increasing
this timeout can result in better flow correlation. When you change the inactive flow timeout, the new timeout
value takes effect immediately.
The cache timeout update command controls the periodic updates sent by the permanent type of cache. This
behavior is similar to the active timeout, except that it does not result in the removal of the cache entry from
the cache. By default, this timer value is 1800 seconds (30 minutes).
The cache type normal command specifies the normal cache type. This is the default cache type. The entries
in the cache will be aged out according to the timeout active seconds and timeout inactive seconds settings.
When a cache entry is aged out, it is removed from the cache and exported via any exporters configured for
the monitor associated with the cache.
To return a cache to its default settings, use the default cache flow monitor configuration command.
Note When a cache becomes full, new flows will not be monitored.
The following example shows how to configure the active timeout for the flow monitor cache:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# cache timeout active 4800
The following example shows how to configure the inactive timer for the flow monitor cache:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# cache timeout inactive 30
The following example shows how to configure the permanent cache update timeout:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# cache timeout update 5000
The following example shows how to configure a normal cache:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# cache type normal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1109
Network Management
clear flow exporter
clear flow exporter
To clear the statistics for a Flexible Netflow flow exporter, use the clear flow exporter command in privileged
EXEC mode.
clear flow exporter [[name] exporter-name] statistics
Syntax Description name (Optional) Specifies the name of a flow exporter.
exporter-name (Optional) Name of a flow exporter that was previously configured.
statistics Clears the flow exporter statistics.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The clear flow exporter command removes all statistics from the flow exporter. These statistics will not be
exported and the data gathered in the cache will be lost.
You can view the flow exporter statistics by using the show flow exporter statistics privileged EXEC
command.
Examples The following example clears the statistics for all of the flow exporters configured on the device:
Device# clear flow exporter statistics
The following example clears the statistics for the flow exporter named FLOW-EXPORTER-1:
Device# clear flow exporter FLOW-EXPORTER-1 statistics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1110
Network Management
clear flow monitor
clear flow monitor
To clear a flow monitor cache or flow monitor statistics and to force the export of the data in the flow monitor
cache, use the clear flow monitor command in privileged EXEC mode.
clear flow monitor [name] monitor-name [{[cache] force-export | statistics}]
Syntax Description name Specifies the name of a flow monitor.
monitor-name Name of a flow monitor that was previously configured.
cache (Optional) Clears the flow monitor cache information.
force-export (Optional) Forces the export of the flow monitor cache statistics.
statistics (Optional) Clears the flow monitor statistics.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The clear flow monitor cache command removes all entries from the flow monitor cache. These entries will
not be exported and the data gathered in the cache will be lost.
Note The statistics for the cleared cache entries are maintained.
The clear flow monitor force-export command removes all entries from the flow monitor cache and exports
them using all flow exporters assigned to the flow monitor. This action can result in a short-term increase in
CPU usage. Use this command with caution.
The clear flow monitor statistics command clears the statistics for this flow monitor.
Note The current entries statistic will not be cleared by the clear flow monitor statistics command because this is
an indicator of how many entries are in the cache and the cache is not cleared with this command.
You can view the flow monitor statistics by using the show flow monitor statistics privileged EXEC command.
Examples The following example clears the statistics and cache entries for the flow monitor named
FLOW-MONITOR-1:
Device# clear flow monitor name FLOW-MONITOR-1
The following example clears the statistics and cache entries for the flow monitor named
FLOW-MONITOR-1 and forces an export:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1111
Network Management
clear flow monitor
Device# clear flow monitor name FLOW-MONITOR-1 force-export
The following example clears the cache for the flow monitor named FLOW-MONITOR-1 and forces
an export:
Device# clear flow monitor name FLOW-MONITOR-1 cache force-export
The following example clears the statistics for the flow monitor named FLOW-MONITOR-1:
Device# clear flow monitor name FLOW-MONITOR-1 statistics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1112
Network Management
clear platform software fed switch swc connection
clear platform software fed switch swc connection
To clear the connection details and events of the Stealthwatch Cloud integration, use the clear platform
software fed switch switch-number swc connection command in privileged EXEC mode.
clear platform software fed switch { switch-number | active } swc connection
Syntax Description switch {switch-number | active } Device for which you want to clear information.
• switch_num: Switch ID.
• active: Clears information for the active
switch.
swc connection Clears the connection details and events.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the clear platform software fed switch active swc connection
command:
Device> enable
Device# clear platform software fed switch active swc connection
Related Commands Command Description
clear platform software fed switch {switch-number Clears the statistical information of the Stealthwatch
|active }swc statistics Cloud integration.
show platform software fed switch {switch-number Displays the connection details and events of the
|active }swc connection Stealthwatch Cloud integration.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1113
Network Management
clear platform software fed switch swc statistics
clear platform software fed switch swc statistics
To clear the statistical information of the Stealthwatch Cloud integration, use the clear platform software
fed switch switch-number swc statistics command in privileged EXEC mode.
clear platform software fed switch { switch-number | active } swc statistics
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the clear platform software fed switch active swc statistics
command:
Device> enable
Device# clear platform software fed switch active swc statistics
Related Commands Command Description
clear platform software fed switch {switch-number Clears the connection details and events of the
|active } swc connection Stealthwatch Cloud integration.
show platform software fed switch {switch-number Displays the statistical information of the Stealthwatch
|active } swc statistics Cloud integration.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1114
Network Management
clear snmp stats hosts
clear snmp stats hosts
To clear the NMS IP address, the number of times an NMS polls the agent, and the timestamp of polling, use
the clear snmp stats hosts command in privileged EXEC mode.
clear snmp stats hosts
Syntax Description This command has no arguments or keywords.
Command Default The details of the SNMP managers polled to the SNMP agent is stored in the system.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was
introduced.
Usage Guidelines Use the clear snmp stats hosts command to delete all the entries polled to the SNMP agent.
The following is sample output of the clear snmp stats hosts command.
Device# clear snmp stats hosts
Request Count Last Timestamp Address
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1115
Network Management
collect
collect
To configure non-key fields for the flow monitor record and to enable capturing the values in the fields for
the flow created with the record, use the collect command in flow record configuration mode.
collect {counter | interface | timestamp | transport}
Syntax Description counter Configures the number of bytes or packets in a flow as a non-key field for a flow record. For
more information, see collect counter.
interface Configures the input and output interface name as a non-key field for a flow record. For more
information, see collect interface.
timestamp Configures the absolute time of the first seen or last seen packet in a flow as a non-key field
for a flow record. For more information, see collect timestamp absolute.
transport Enables the collecting of transport TCP flags from a flow record. For more information, see
collect transport tcp flags.
Command Default Non-key fields are not configured for the flow monitor record.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The values in non-key fields are added to flows to provide additional information about the traffic in the flows.
A change in the value of a non-key field does not create a new flow. In most cases, the values for non-key
fields are taken from only the first packet in the flow.
The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
Note Although it is visible in the command-line help string, the flow username keyword is not supported.
The following example configures the total number of bytes in the flows as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect counter bytes long
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1116
Network Management
collect counter
collect counter
To configure the number of bytes or packets in a flow as a non-key field for a flow record, use the collect
counter command in flow record configuration mode. To disable the use of the number of bytes or packets
in a flow (counters) as a non-key field for a flow record, use the no form of this command.
Command Default The number of bytes or packets in a flow is not configured as a non-key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To return this command to its default settings, use the no collect counter or default collect counter flow
record configuration command.
The following example configures the total number of bytes in the flows as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)#collect counter bytes long
The following example configures the total number of packets from the flows as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect counter packets long
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1117
Network Management
collect flow sampler
collect flow sampler
To configure a flow sampler ID as a non-key field for the record, use the collect flow sampler command in
flow record configuration mode. To disable the use of the flow sampler ID number as a non-key field for a
flow record, use the no form of this command.
collect flow sampler
no collect flow sampler
Syntax Description This command has no arguments or keywords.
Command Default The flow sampler is not configured as non-key fields.
Command Modes Flow record configuration (config-flow-record)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Usage Guidelines The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
The collect flow sampler command is useful when more than one flow sampler is being used with different
sampling rates. The non-key field contains the ID of the flow sampler used to monitor the flow.
Examples The following example shows how to configure the ID of the flow sampler that is assigned to the
flow as a non-key field:
Device> enable
Device# confgure terminal
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect flow sampler
Related Commands Command Description
flow exporter Creates a flow exporter
flow record Creates a flow record for Flexible NetFlow.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1118
Network Management
collect interface
collect interface
To configure the input interface name as a non-key field for a flow record, use the collect interface command
in flow record configuration mode. To disable the use of the input interface as a non-key field for a flow
record, use the no form of this command.
collect interface input
no collect interface input
Syntax Description input Configures the input interface name as a non-key field and enables collecting the input interface
from the flows.
Command Default The input interface name is not configured as a non-key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The Flexible NetFlow collect commands are used to configure non-key fields for the flow monitor record and
to enable capturing the values in the fields for the flow created with the record. The values in non-key fields
are added to flows to provide additional information about the traffic in the flows. A change in the value of
a non-key field does not create a new flow. In most cases, the values for non-key fields are taken from only
the first packet in the flow.
To return this command to its default settings, use the no collect interface or default collect interface flow
record configuration command.
The following example configures the input interface as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect interface input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1119
Network Management
collect ipv4 destination
collect ipv4 destination
To configure the IPv4 destination as a non-key field for a flow record, use the collect ipv4 destination
command in flow record configuration mode. To disable the use of an IPv4 destination field as a non-key
field for a flow record, use the no form of this command.
collect ipv4 destination {mask | prefix} [minimum-mask mask]
no collect ipv4 destination {mask | prefix} [minimum-mask mask]
Syntax Description mask Configures the IPv4 destination mask as a non-key field and enables collecting
the value of the IPv4 destination mask from the flows.
prefix Configures the prefix for the IPv4 destination as a non-key field and enables
collecting the value of the IPv4 destination prefix from the flows.
minimum-mask mask (Optional) Specifies the size, in bits, of the minimum mask. Range: 1 to 32.
Command Default The IPv4 destination is not configured as a non-key field.
Command Modes Flow record configuration (config-flow-record)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Usage Guidelines The Flexible NetFlow collect commands are used to configure non-key fields for the flow monitor record and
to enable capturing the values in the fields for the flow created with the record. The values in non-key fields
are added to flows to provide additional information about the traffic in the flows. A change in the value of
a non-key field does not create a new flow. In most cases the values for non-key fields are taken from only
the first packet in the flow.
Examples The following example shows how to configure the IPv4 destination prefix from the flows that have
a prefix of 16 bits as a non-key field:
Device> enable
Device> configure terminal
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect ipv4 destination prefix minimum-mask 16
Related Commands Command Description
flow record Creates a flow record for Flexible NetFlow.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1120
Network Management
collect ipv6 destination
collect ipv6 destination
To configure the IPv6 destination as a non-key field for a flow record, use the collect ipv6 destination
command in flow record configuration mode. To disable the use of an IPv6 destination field as a non-key
field for a flow record, use the no form of this command.
collect ipv6 destination { mask | prefix } [ minimum-mask mask ]
no collect ipv6 destination { mask | prefix } [ minimum-mask mask ]
Syntax Description mask Configures the IPv6 destination mask as a non-key field and enables collecting
the value of the IPv6 destination mask from the flows.
prefix Configures the prefix for the IPv6 destination as a non-key field and enables
collecting the value of the IPv6 destination prefix from the flows.
minimum-mask mask (Optional) Specifies the size, in bits, of the minimum mask. Range: 1 to 32.
Command Default The IPv6 destination is not configured as a non-key field.
Command Modes Flow record configuration (config-flow-record)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Usage Guidelines The Flexible NetFlow collect commands are used to configure non-key fields for the flow monitor record and
to enable capturing the values in the fields for the flow created with the record. The values in non-key fields
are added to flows to provide additional information about the traffic in the flows. A change in the value of
a non-key field does not create a new flow. In most cases the values for non-key fields are taken from only
the first packet in the flow.
Examples The following example shows how to configure the IPv6 destination prefix from the flows that have
a prefix of 16 bits as a non-key field:
Device> enable
Device> configure terminal
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect ipv6 destination prefix minimum-mask 16
Related Commands Command Description
flow record Creates a flow record for Flexible NetFlow.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1121
Network Management
collect ipv4 source
collect ipv4 source
To configure the IPv4 source as a non-key field for a flow record, use the collect ipv4 source command in
flow record configuration mode. To disable the use of the IPv4 source field as a non-key field for a flow
record, use the no form of this command.
collect ipv4 source {mask | prefix} [minimum-mask mask]
no collect ipv4 source {mask | prefix} [minimum-mask mask]
Syntax Description mask Configures the mask for the IPv4 source as a non-key field and enables collecting
the value of the IPv4 source mask from the flows.
prefix Configures the prefix for the IPv4 source as a non-key field and enables collecting
the value of the IPv4 source prefix from the flows.
minimum-mask mask (Optional) Specifies the size, in bits, of the minimum mask. Range: 1 to 32.
Command Default The IPv4 source is not configured as a non-key field.
Command Modes Flow record configuration (config-flow-record)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Usage Guidelines The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
collect ipv4 source prefix minimum-mask
The source prefix is the network part of an IPv4 source. The optional minimum mask allows more information
to be gathered about large networks.
collect ipv4 source mask minimum-mask
The source mask is the number of bits that make up the network part of the source. The optional minimum
mask allows a minimum value to be configured. This command is useful when there is a minimum mask
configured for the source prefix field and the mask is to be used with the prefix. In this case, the values
configured for the minimum mask should be the same for the prefix and mask fields.
Alternatively, if the collector is aware of the minimum mask configuration of the prefix field, the mask field
can be configured without a minimum mask so that the true mask and prefix can be calculated.
Examples The following example shows how to configure the IPv4 source prefix from flows that have a prefix
of 16 bits as a non-key field:
Device> enable
Device# conigure terminal
Device(config)# flow record FLOW-RECORD-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1122
Network Management
collect ipv4 source
Device(config-flow-record)# collect ipv4 source prefix minimum-mask 16
Related Commands Command Description
flow record Creates a flow record for Flexible NetFlow.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1123
Network Management
collect ipv6 source
collect ipv6 source
To configure the IPv6 source as a non-key field for a flow record, use the collect ipv6 source command in
flow record configuration mode. To disable the use of the IPv6 source field as a non-key field for a flow
record, use the no form of this command.
collect ipv6 source { mask | prefix } [ minimum-mask mask ]
no collect ipv6 source { mask | prefix } [ minimum-mask mask ]
Syntax Description mask Configures the mask for the IPv6 source as a non-key field and enables collecting
the value of the IPv6 source mask from the flows.
prefix Configures the prefix for the IPv6 source as a non-key field and enables collecting
the value of the IPv6 source prefix from the flows.
minimum-mask mask (Optional) Specifies the size, in bits, of the minimum mask. Range: 1 to 32.
Command Default The IPv6 source is not configured as a non-key field.
Command Modes Flow record configuration (config-flow-record)
Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Usage Guidelines The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
collect ipv6 source prefix minimum-mask
The source prefix is the network part of an IPv6 source. The optional minimum mask allows more information
to be gathered about large networks.
collect ipv6 source mask minimum-mask
The source mask is the number of bits that make up the network part of the source. The optional minimum
mask allows a minimum value to be configured. This command is useful when there is a minimum mask
configured for the source prefix field and the mask is to be used with the prefix. In this case, the values
configured for the minimum mask should be the same for the prefix and mask fields.
Alternatively, if the collector is aware of the minimum mask configuration of the prefix field, the mask field
can be configured without a minimum mask so that the true mask and prefix can be calculated.
Examples The following example shows how to configure the IPv6 source prefix from flows that have a prefix
of 16 bits as a non-key field:
Device> enable
Device# conigure terminal
Device(config)# flow record FLOW-RECORD-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1124
Network Management
collect ipv6 source
Device(config-flow-record)# collect ipv6 source prefix minimum-mask 16
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1125
Network Management
collect timestamp absolute
collect timestamp absolute
To configure the absolute time of the first seen or last seen packet in a flow as a non-key field for a flow
record, use the collect timestamp absolute command in flow record configuration mode. To disable the use
of the first seen or last seen packet in a flow as a non-key field for a flow record, use the no form of this
command.
collect timestamp absolute {first | last}
no collect timestamp absolute {first | last}
Syntax Description first Configures the absolute time of the first seen packet in a flow as a non-key field and enables collecting
time stamps from the flows.
last Configures the absolute time of the last seen packet in a flow as a non-key field and enables collecting
time stamps from the flows.
Command Default The absolute time field is not configured as a non-key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
The following example configures time stamps based on the absolute time of the first seen packet
in a flow as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect timestamp absolute first
The following example configures time stamps based on the absolute time of the last seen packet in
a flow as a non-key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect timestamp absolute last
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1126
Network Management
collect transport tcp flags
collect transport tcp flags
To enable the collecting of transport TCP flags from a flow, use the collect transport tcp flags command in
flow record configuration mode. To disable the collecting of transport TCP flags from the flow, use the no
form of this command.
collect transport tcp flags
no collect transport tcp flags
Syntax Description This command has no arguments or keywords.
Command Default The transport layer fields are not configured as a non-key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The values of the transport layer fields are taken from all packets in the flow. You cannot specify which TCP
flag to collect. You can only specify to collect transport TCP flags. All TCP flags will be collected with this
command. The following transport TCP flags are collected:
• ack—TCP acknowledgement flag
• cwr—TCP congestion window reduced flag
• ece—TCP ECN echo flag
• fin—TCP finish flag
• psh—TCP push flag
• rst—TCP reset flag
• syn—TCP synchronize flag
• urg—TCP urgent flag
To return this command to its default settings, use the no collect collect transport tcp flags or default collect
collect transport tcp flags flow record configuration command.
The following example collects the TCP flags from a flow:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect transport tcp flags
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1127
Network Management
collect routing next-hop address
collect routing next-hop address
To configure the next-hop address value as a non-key field and enable collecting information regarding the
next hop from the flows, use the collect routing next-hop address command in flow record configuration
mode. To disable the use of one or more of the routing attributes as a non-key field for a flow record, use the
no form of this command.
collect routing next-hop address { ipv4 | ipv6 }
no collect routing next-hop address { ipv4 | ipv6 }
Syntax Description ipv4 Specifies that the next-hop address value is an IPv4 address.
ipv6 Specifies that the next-hop address value is an IPv6 address.
Command Default Next hop address value is not configured as a non-key field.
Command Modes Flow record configuration (config-flow-record)
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Cisco IOS XE Amsterdam 17.3.1 The ipv6 keyword was introduced.
Usage Guidelines The collect commands are used to configure non-key fields for the flow monitor record and to enable capturing
the values in the fields for the flow created with the record. The values in non-key fields are added to flows
to provide additional information about the traffic in the flows. A change in the value of a non-key field does
not create a new flow. In most cases the values for non-key fields are taken from only the first packet in the
flow.
Examples The following example shows how to configure the next-hop address value as a non-key field:
Device> enable
Device# configure terminal
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# collect routing next-hop address ipv4
Related Commands Command Description
flow record Creates a flow record, and enters Flexible NetFlow flow
record configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1128
Network Management
datalink flow monitor
datalink flow monitor
To apply a Flexible NetFlow flow monitor to an interface, use the datalink flow monitor command in interface
configuration mode. To disable a Flexible NetFlow flow monitor, use the no form of this command.
datalink flow monitor monitor-name sampler sampler-name input
no datalink flow monitor monitor-name sampler sampler-name input
Syntax Description monitor-name Name of the flow monitor to apply to the interface.
sampler sampler-name Enables the specified flow sampler for the flow monitor.
input Monitors traffic that the switch receives on the interface.
Command Default A flow monitor is not enabled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Before you apply a flow monitor to an interface with the datalink flow monitor command, you must have
already created the flow monitor using the flow monitor global configuration command and the flow sampler
using the sampler global configuration command.
To enable a flow sampler for the flow monitor, you must have already created the sampler.
Note The datalink flow monitor command only monitors non-IPv4 and non-IPv6 traffic. To monitor IPv4 traffic,
use the ip flow monitor command. To monitor IPv6 traffic, use the ipv6 flow monitor command.
This example shows how to enable Flexible NetFlow datalink monitoring on an interface:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# datalink flow monitor FLOW-MONITOR-1 sampler FLOW-SAMPLER-1 input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1129
Network Management
debug flow exporter
debug flow exporter
To enable debugging output for Flexible Netflow flow exporters, use the debug flow exporter command in
privileged EXEC mode. To disable debugging output, use the no form of this command.
debug flow exporter [[name] exporter-name] [{error | event | packets number}]
no debug flow exporter [[name] exporter-name] [{error | event | packets number}]
Syntax Description name (Optional) Specifies the name of a flow exporter.
exporter-name (Optional) The name of a flow exporter that was previously configured.
error (Optional) Enables debugging for flow exporter errors.
event (Optional) Enables debugging for flow exporter events.
packets (Optional) Enables packet-level debugging for flow exporters.
number (Optional) The number of packets to debug for packet-level debugging of flow exporters.
The range is 1 to 65535.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example indicates that a flow exporter packet has been queued for process send:
Device# debug flow exporter
May 21 21:29:12.603: FLOW EXP: Packet queued for process send
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1130
Network Management
debug flow monitor
debug flow monitor
To enable debugging output for Flexible NetFlow flow monitors, use the debug flow monitor command in
privileged EXEC mode. To disable debugging output, use the no form of this command.
debug flow monitor [{error | [name] monitor-name [{cache [error] | error | packets packets}]}]
no debug flow monitor [{error | [name] monitor-name [{cache [error] | error | packets packets}]}]
Syntax Description error (Optional) Enables debugging for flow monitor errors for all flow monitors or for the
specified flow monitor.
name (Optional) Specifies the name of a flow monitor.
monitor-name (Optional) Name of a flow monitor that was previously configured.
cache (Optional) Enables debugging for the flow monitor cache.
cache error (Optional) Enables debugging for flow monitor cache errors.
packets (Optional) Enables packet-level debugging for flow monitors.
packets (Optional) Number of packets to debug for packet-level debugging of flow monitors. The
range is 1 to 65535.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example shows that the cache for FLOW-MONITOR-1 was deleted:
Device# debug flow monitor FLOW-MONITOR-1 cache
May 21 21:53:02.839: FLOW MON: 'FLOW-MONITOR-1' deleted cache
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1131
Network Management
debug flow record
debug flow record
To enable debugging output for Flexible NetFlow flow records, use the debug flow record command in
privileged EXEC mode. To disable debugging output, use the no form of this command.
debug flow record [{[name] record-name | options {sampler-table} | [{detailed | error}]}]
no debug flow record [{[name] record-name | options {sampler-table} | [{detailed | error}]}]
Syntax Description name (Optional) Specifies the name of a flow record.
record-name (Optional) Name of a user-defined flow record that was previously configured.
options (Optional) Includes information on other flow record options.
sampler-table (Optional) Includes information on the sampler tables.
detailed (Optional) Displays detailed information.
error (Optional) Displays errors only.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example enables debugging for the flow record:
Device# debug flow record FLOW-record-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1132
Network Management
debug sampler
debug sampler
To enable debugging output for Flexible NetFlow samplers, use the debug sampler command in privileged
EXEC mode. To disable debugging output, use the no form of this command.
debug sampler [{detailed | error | [name] sampler-name [{detailed | error | sampling samples}]}]
no debug sampler [{detailed | error | [name] sampler-name [{detailed | error | sampling}]}]
Syntax Description detailed (Optional) Enables detailed debugging for sampler elements.
error (Optional) Enables debugging for sampler errors.
name (Optional) Specifies the name of a sampler.
sampler-name (Optional) Name of a sampler that was previously configured.
sampling samples (Optional) Enables debugging for sampling and specifies the number of samples to
debug.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following sample output shows that the debug process has obtained the ID for the sampler named
SAMPLER-1:
Device# debug sampler detailed
*May 28 04:14:30.883: Sampler: Sampler(SAMPLER-1: flow monitor FLOW-MONITOR-1 (ip,Et1/0,O)
get ID succeeded:1
*May 28 04:14:30.971: Sampler: Sampler(SAMPLER-1: flow monitor FLOW-MONITOR-1 (ip,Et0/0,I)
get ID succeeded:1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1133
Network Management
description
description
To configure a description for a flow monitor, flow exporter, or flow record, use the description command
in the appropriate configuration mode. To remove a description, use the no form of this command.
description description
no description description
Syntax Description description Text string that describes the flow monitor, flow exporter, or flow record.
Command Default The default description for a flow sampler, flow monitor, flow exporter, or flow record is "User defined."
Command Modes The following command modes are supported:
Flow exporter configuration
Flow monitor configuration
Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To return this command to its default setting, use the no description or default description command in the
appropriate configuration mode.
The following example configures a description for a flow monitor:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# description Monitors traffic to 172.16.0.1 255.255.0.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1134
Network Management
description (ERSPAN)
description (ERSPAN)
To describe an Encapsulated Remote Switched Port Analyzer (ERSPAN) source session, use the description
command in ERSPAN monitor source session configuration mode. To remove a description, use the no form
of this command.
description description
no description
Syntax Description description Describes the properties for this session.
Command Default Description is not configured.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The description argument can be up to 240 characters.
Examples The following example shows how to describe an ERSPAN source session:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# description source1
Related Commands Command Description
monitor session type Configures a local ERSPAN source or destination session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1135
Network Management
destination (ERSPAN)
destination (ERSPAN)
To configure an Encapsulated Remote Switched Port Analyzer (ERSPAN) source session destination and
specify destination properties, use the destination command in ERSPAN monitor source session configuration
mode. To remove a destination session, use the no form of this command.
destination
no destination
Syntax Description This command has no arguments or keywords.
Command Default A source session destination is not configured.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Amsterdam 17.1.1 The ipv6 keyword was added in the source session destination configuration
mode, for IPv6 ERSPAN support.
Usage Guidelines ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination
session.
After you enter destination command, the command mode changes from monitor source session configuration
mode (config-mon-erspan-src) to source session destination configuration mode (config-mon-erspan-src-dst).
In this mode, enter a question mark (?) at the system prompt to see the list of commands that are available:
erspan-id erspan-ID Configures the ID used by the destination session to identify the
ERSPAN traffic. Valid values range from 1 to 1023.
exit Exits monitor ERSPAN destination session source property mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1136
Network Management
destination (ERSPAN)
ip { address ipv4-address | Specifies IP properties. You can configure the following options:
dscp dscp-value | ttl ttl-value }
• address ipv4-address: Configures the IP address for the ERSPAN
destination sessions. All ERSPAN source session (maximum 8)
destination IP addresses need not be same.
The ERSPAN source session destination IP address, which is
configured on an interface on the destination switch, is the source
of traffic that an ERSPAN destination session sends to destination
ports. Configure the same address in both the source and
destination sessions.
• dscp dscp-value: Configures the Differentiated Services Code
Point (DSCP) values for packets in the ERSPAN traffic. Valid
values are from 0 to 63.
To remove the dscp values, use the no form of this command.
• ttl ttl-value: Configures the Time to Live (TTL) values for packets
in the ERSPAN traffic. Valid values are from 2 to 255.
To remove the TTL values, use the no form of this command.
ipv6 { address ipv6-address | Specifies IPv6 properties. You can configure the following options:
dscp dscp-value | flow-label |
• address ipv6-address: Configures the IPv6 address for the
ttl ttl-value }
ERSPAN destination sessions. All ERSPAN source session
(maximum 8) destination IPv6 address need not be same.
The ERSPAN source session destination IPv6 address, which is
configured on an interface on the destination switch, is the source
of traffic that an ERSPAN destination session sends to destination
ports. Configure the same address in both the source and
destination sessions.
• dscp dscp-value: Configures the Differentiated Services Code
Point (DSCP) values for packets in the ERSPAN traffic. Valid
values are from 0 to 63.
To remove the dscp values, use the no form of this command.
• flow-label: Configures the flow-label. Valid values are from 0 to
1048575.
• ttl ttl-value: Configures the Time to Live (TTL) values for packets
in the ERSPAN traffic. Valid values are from 2 to 255.
To remove the TTL values, use the no form of this command.
mtu bytes Specifies the maximum transmission unit (MTU) size for ERSPAN
truncation. The default value is 9000 bytes.
origin { ip address ip-address | Configures the source of the ERSPAN traffic. You can enter an IPv4
ipv6 addressipv6-address} address or an IPv6 address.
vrf vrf-id Configures virtual routing and forwarding (VRF) in the destination
session. Enter the VRF ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1137
Network Management
destination (ERSPAN)
ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination
session.
Examples The following examples show how to configure an ERSPAN source session destination, enter the
ERSPAN monitor destination session configuration mode, and configure the various properties.
The following example specifies the destination property ip:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)#ip address 10.1.1.1
Device(config-mon-erspan-src-dst)#
The following example shows how to configure an ERSPAN ID for a destination session:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# erspan-id 3
The following example shows how to configure DSCP value for ERSPAN traffic:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# ip dscp 15
The following example shows how to configure TTL value for ERSPAN traffic:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# ip ttl 32
The following example specifies the destination property ipv6:
Device(config)# monitor session 3 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)#ipv6 address 2001:DB8::1
Device(config-mon-erspan-src-dst)#
The following example shows how to configure DSCP value for ERSPAN traffic IPv6:
Device(config)# monitor session 3 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# ipv6 dscp 10
The following example shows how to configure flow-label value for ERSPAN traffic IPv6:
Device(config)# monitor session 3 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# ipv6 flow-label 6
The following example shows how to configure TTL value for ERSPAN traffic IPv6:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1138
Network Management
destination (ERSPAN)
Device(config)# monitor session 3 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# ipv6 ttl 32
The following example shows how to specify an MTU of 1000 bytes:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# mtu 1000
The following example shows how to configure an IP address for an ERSPAN source session:
Switch(config)# monitor session 2 type erspan-source
Switch(config-mon-erspan-src)# destination
Switch(config-mon-erspan-src-dst)# origin ip address 192.0.2.1
The following example shows how to configure an IPv6 address for an ERSPAN source session:
Switch(config)# monitor session 3 type erspan-source
Switch(config-mon-erspan-src)# destination
Switch(config-mon-erspan-src-dst)# origin ipv6 address 2001:DB8:1::1
The following example shows how to configure VRF in the destination session:
Switch(config)# monitor session 3 type erspan-source
Switch(config-mon-erspan-src)# destination
Switch(config-mon-erspan-src-dst)# vrf vrfexample
The following sample output from the show monitor session all displays different IP addresses for
source session destinations:
Device# show monitor session all
Session 1
---------
Type : ERSPAN Source Session
Status : Admin Disabled
Description : session1
Destination IP Address : 10.1.1.1
Session 2
---------
Type : ERSPAN Source Session
Status : Admin Disabled
Description : session2
Destination IP Address : 192.0.2.1
Session 3
---------
Type : ERSPAN Source Session
Status : Admin Disabled
Description : session3
Destination IP Address : 198.51.100.1
Session 4
---------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1139
Network Management
destination (ERSPAN)
Type : ERSPAN Source Session
Status : Admin Disabled
Description : session4
Destination IP Address : 203.0.113.1
Session 5
---------
Type : ERSPAN Source Session
Status : Admin Disabled
Description : session5
Destination IP Address : 209.165.200.225
Related Commands Command Description
monitorsession type Configures a local ERSPAN source or destination session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1140
Network Management
destination
destination
To configure an export destination for a flow exporter, use the destination command in flow exporter
configuration mode. To remove an export destination for a flow exporter, use the no form of this command.
destination {hostnameip-address}
no destination {hostnameip-address}
Syntax Description hostname Hostname of the device to which you want to send the NetFlow information.
ip-address IPv4 address of the workstation to which you want to send the NetFlow information.
Command Default An export destination is not configured.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Each flow exporter can have only one destination address or hostname.
When you configure a hostname instead of the IP address for the device, the hostname is resolved immediately
and the IPv4 address is stored in the running configuration. If the hostname-to-IP-address mapping that was
used for the original Domain Name System (DNS) name resolution changes dynamically on the DNS server,
the device does not detect this, and the exported data continues to be sent to the original IP address, resulting
in a loss of data.
To return this command to its default setting, use the no destination or default destination command in flow
exporter configuration mode.
The following example shows how to configure the networking device to export the Flexible NetFlow
cache entry to a destination system:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# destination 10.0.0.4
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1141
Network Management
dscp
dscp
To configure a differentiated services code point (DSCP) value for flow exporter datagrams, use the dscp
command in flow exporter configuration mode. To remove a DSCP value for flow exporter datagrams, use
the no form of this command.
dscp dscp
no dscp dscp
Syntax Description dscp DSCP to be used in the DSCP field in exported datagrams. The range is 0 to 63. The default is 0.
Command Default The differentiated services code point (DSCP) value is 0.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To return this command to its default setting, use the no dscp or default dscp flow exporter configuration
command.
The following example sets 22 as the value of the DSCP field in exported datagrams:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# dscp 22
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1142
Network Management
et-analytics
et-analytics
To enter the global et-analytics configuration mode, use the et-analytics command in the global configuration
mode.
et-analytics
Syntax Description et-analytics Enter the global et-analytics
configuration mode.
Command Default Disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to enter the et-analytics configuration mode:
Device>enable
Device#configure terminal
Device(config)# et-analytics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1143
Network Management
et-analytics enable
et-analytics enable
To enable et-analytics configuration on a particular interface, use the et-analytics enablecommand in the
interface configuration mode. To disable et-analytics, use the no form of the command.
et-analytics enable
no et-analytics enable
Syntax Description et-analytics enable Enables et-analytics on a particular
interface..
Command Default Disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to enable et-analytics on interface GigabitEthernet1/0/2.:
Device>enable
Device#configure terminal
Device(config)# interface gi1/0/2
Device(config-if)# et-analytics enable
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1144
Network Management
event manager applet
event manager applet
To register an applet with the Embedded Event Manager (EEM) and to enter applet configuration mode, use
the event manager applet command in global configuration mode. To unregister the applet, use the no form
of this command.
event manager applet applet-name [authorization bypass] [class class-options] [trap]
no event manager applet applet-name [authorization bypass] [class class-options] [trap]
Syntax Description applet-name Name of the applet file.
authorization (Optional) Specifies AAA authorization type for applet.
bypass (Optional) Specifies EEM AAA authorization type bypass.
class (Optional) Specifies the EEM policy class.
class-options (Optional) The EEM policy class. You can specify either one of the following:
• class-letter-- Letter from A to Z that identifies each policy class. You can specify any
one class-letter.
• default --Specifies the policies registered with the default class.
trap (Optional) Generates a Simple Network Management Protocol (SNMP) trap when the
policy is triggered.
Command Default No EEM applets are registered.
Command Modes
Global configuration (config)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines An EEM applet is a concise method for defining event screening criteria and the actions to be taken when
that event occurs.
Only one event configuration command is allowed within an applet configuration. When applet configuration
submode is exited and no event command is present, a warning is displayed stating that no event is associated
with this applet. If no event is specified, this applet is not considered registered and the applet is not displayed.
When no action is associated with this applet, events are still triggered but no actions are performed. Multiple
action applet configuration commands are allowed within an applet configuration. Use the show event manager
policy registered command to display a list of registered applets.
Before modifying an EEM applet, use the no form of this command to unregister the applet because the
existing applet is not replaced until you exit applet configuration mode. While you are in applet configuration
mode modifying the applet, the existing applet may be executing. When you exit applet configuration mode,
the old applet is unregistered and the new version is registered.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1145
Network Management
event manager applet
Note Do not attempt making any partial modification. EEM does not support partial changes to already registered
policies. EEM policy has to be always unregistered before registering again with changes.
Action configuration commands are uniquely identified using the label argument, which can be any string
value. Actions are sorted in ascending alphanumeric key sequence using the label argument as the sort key
and are run using this sequence.
The EEM schedules and runs policies on the basis of an event specification that is contained within the policy
itself. When applet configuration mode is exited, EEM examines the event and action commands that are
entered and registers the applet to be run when a specified event occurs.
The EEM policies will be assigned a class when class class-letter is specified when they are registered. EEM
policies registered without a class will be assigned to the default class. Threads that have default as the class
will service the default class when the thread is available for work. Threads that are assigned specific class
letters will service any policy with a matching class letter when the thread is available for work.
If there is no EEM execution thread available to run the policy in the specified class and a scheduler rule for
the class is configured, the policy will wait until a thread of that class is available for execution. Synchronous
policies that are triggered from the same input event should be scheduled in the same execution thread. Policies
will be queued in a separate queue for each class using the queue_priority as the queuing order.
When a policy is triggered and if AAA is configured it will contact the AAA server for authorization. Using
the authorization bypass keyword combination, you can skip to contact the AAA server and run the policy
immediately. EEM stores AAA bypassed policy names in a list. This list is checked when policies are triggered.
If a match is found, AAA authorization is bypassed.
To avoid authorization for commands configured through the EEM policy, EEM will use named method lists,
which AAA provides. These named method lists can be configured to have no command authorization.
The following is a sample AAA configuration.
This configuration assumes a TACACS+ server at 192.168.10.1 port 10000. If the TACACS+ server is not
enabled, configuration commands are permitted on the console; however, EEM policy and applet CLI
interactions will fail.
enable password lab
aaa new-model
tacacs-server host 128.107.164.152 port 10000
tacacs-server key cisco
aaa authentication login consoleline none
aaa authorization exec consoleline none
aaa authorization commands 1 consoleline none
aaa authorization commands 15 consoleline none
line con 0
exec-timeout 0 0
login authentication consoleline
aaa authentication login default group tacacs+ enable
aaa authorization exec default group tacacs+
aaa authorization commands 1 default group tacacs+
aaa authorization commands 15 default group tacacs+
The authorization, class and trap keywords can be used in any combination.
Examples The following example shows an EEM applet called IPSLAping1 being registered to run when there
is an exact match on the value of a specified SNMP object ID that represents a successful IP SLA
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1146
Network Management
event manager applet
ICMP echo operation (this is equivalent to a ping command). Four actions are triggered when the
echo operation fails, and event monitoring is disabled until after the second failure. A message that
the ICMP echo operation to a server failed is sent to syslog, an SNMP trap is generated, EEM
publishes an application-specific event, and a counter called IPSLA1F is incremented by a value of
one.
Router(config)# event manager applet IPSLAping1
Router(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.42.1.2.9.1.6.4 get-type exact
entry-op eq entry-val 1 exit-op eq exit-val 2 poll-interval 5
Router(config-applet)# action 1.0 syslog priority critical msg "Server IP echo failed:
OID=$_snmp_oid_val"
Router(config-applet)# action 1.1 snmp-trap strdata "EEM detected server reachability
failure to 10.1.88.9"
Router(config-applet)# action 1.2 publish-event sub-system 88000101 type 1 arg1 10.1.88.9
arg2 IPSLAEcho arg3 fail
Router(config-applet)# action 1.3 counter name _IPSLA1F value 1 op inc
The following example shows how to register an applet with the name one and class A and enter
applet configuration mode where the timer event detector is set to trigger an event every 10 seconds.
When the event is triggered, the action syslog command writes the message “hello world” to syslog.
Router(config)# event manager applet one class A
Router(config-applet)# event timer watchdog time 10
Router(config-applet)# action syslog syslog msg "hello world"
Router(config-applet)# exit
The following example shows how to bypass the AAA authorization when registering an applet with
the name one and class A.
Router(config)# event manager applet one class A authorization bypass
Router(config-applet)#
Related Commands Command Description
show event manager policy registered Displays registered EEM policies.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1147
Network Management
export-protocol netflow-v9
export-protocol netflow-v9
To configure NetFlow Version 9 export as the export protocol for a Flexible NetFlow exporter, use the
export-protocol netflow-v9 command in flow exporter configuration mode.
export-protocol netflow-v9
Syntax Description This command has no arguments or keywords.
Command Default NetFlow Version 9 is enabled.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The device does not support NetFlow v5 export format, only NetFlow v9 export format is supported.
The following example configures NetFlow Version 9 export as the export protocol for a NetFlow
exporter:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# export-protocol netflow-v9
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1148
Network Management
export-protocol netflow-v5
export-protocol netflow-v5
To configure NetFlow Version 5 export as the export protocol for a Flexible NetFlow exporter, use the
export-protocol netflow-v5 command in flow exporter configuration mode.
export-protocol netflow-v5
Syntax Description This command has no arguments or keywords.
Command Default NetFlow Version 5 is enabled.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1149
Network Management
exporter
exporter
To add a flow exporter for a flow monitor, use the exporter command in the appropriate configuration mode.
To remove a flow exporter for a flow monitor, use the no form of this command.
exporter exporter-name
no exporter exporter-name
Syntax Description exporter-name Name of a flow exporter that was previously configured.
Command Default An exporter is not configured.
Command Modes Flow monitor configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You must have already created a flow exporter by using the flow exporter command before you can apply
the flow exporter to a flow monitor with the exporter command.
To return this command to its default settings, use the no exporter or default exporter flow monitor
configuration command.
Examples The following example configures an exporter for a flow monitor:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# exporter EXPORTER-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1150
Network Management
fconfigure
fconfigure
To specify the options in a channel use the fconfigure command in the TCL configuration mode.
fconfigure channel-name remote[host port]broadcast boolean vrf vrf-table-name
Syntax Description remote Configures a remote session. It supports both IPv4 and IPv6 addresses.
broadcast Enables or disables broadcasting. The value of the option must be a proper boolean value.
vrf Returns the local VRF table name for the specified socket. If no VRF Table has been configured
for the given socket, TCL_ERROR will be returned and “No VRF table configured” will be
appended to the interpreter result.
Command Default
Command Modes TCL configuration mode
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 The myvrf keyword was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1151
Network Management
filter (ERSPAN)
filter (ERSPAN)
To configure the Encapsulated Remote Switched Port Analyzer (ERSPAN) source VLAN filtering when the
ERSPAN source is a trunk port, use the filter command in ERSPAN monitor source session configuration
mode. To remove the configuration, use the no form of this command.
filter {ip access-group {standard-access-list extended-access-list acl-name} | ipv6 access-group acl-name
| mac access-group acl-name | sgt sgt-id [{,}] [{-}] | vlan vlan-id [{,}] [{-}]}
no filter {ip [{access-group | [{ standard-access-list extended-access-list acl-name}]}] | ipv6
[{access-group}] | mac [{access-group}] | sgt sgt-id [{,}] [{-}] | vlan vlan-id [{,}] [{-}]}
Syntax Description ip Specifies the IP access control rules.
access-group Specifies an access control group.
standard-access-list Standard IP access list.
extended-access-list Extended IP access list.
acl-name Access list name.
ipv6 Specifies the IPv6 access control rules.
mac Specifies the media access control (MAC) rules.
sgt sgt-ID Specifies the Security Group Tag (SGT). Valid values are from 1 to 65535.
vlan vlan-ID Specifies the ERSPAN source VLAN. Valid values are from 1 to 4094.
, (Optional) Specifies another VLAN.
- (Optional) Specifies a range of VLANs.
Command Default Source VLAN filtering is not configured.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.11.1 The sgt keyword was introduced.
Usage Guidelines You cannot include source VLANs and filter VLANs in the same session.
When you configure the filter command on a monitored trunk interface, only traffic on that set of specified
VLANs is monitored.
Examples The following example shows how to configure source VLAN filtering:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1152
Network Management
filter (ERSPAN)
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# filter vlan 3
Related Commands Command Description
monitor session type Configures a local ERSPAN source or destination session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1153
Network Management
flow exporter
flow exporter
To create a Flexible NetFlow flow exporter, or to modify an existing Flexible NetFlow flow exporter, and
enter Flexible NetFlow flow exporter configuration mode, use the flow exporter command in global
configuration mode. To remove a Flexible NetFlow flow exporter, use the no form of this command.
flow exporter exporter-name
no flow exporter exporter-name
Syntax Description exporter-name Name of the flow exporter that is being created or modified.
Command Default Flexible NetFlow flow exporters are not present in the configuration.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Flow exporters export the data in the flow monitor cache to a remote system, such as a server running NetFlow
collector, for analysis and storage. Flow exporters are created as separate entities in the configuration. Flow
exporters are assigned to flow monitors to provide data export capability for the flow monitors. You can create
several flow exporters and assign them to one or more flow monitors to provide several export destinations.
You can create one flow exporter and apply it to several flow monitors.
Examples The following example creates a flow exporter named FLOW-EXPORTER-1 and enters Flexible
NetFlow flow exporter configuration mode:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1154
Network Management
flow monitor
flow monitor
To create a flow monitor, or to modify an existing flow monitor, and enter flow monitor configuration mode,
use the flow monitor command in global configuration mode. To remove a flow monitor, use the no form of
this command.
flow monitor monitor-name
no flow monitor monitor-name
Syntax Description monitor-name Name of the flow monitor that is being created or modified.
Command Default Flexible NetFlow flow monitors are not present in the configuration.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Flow monitors are the Flexible NetFlow component that is applied to interfaces to perform network traffic
monitoring. Flow monitors consist of a flow record and a cache. You add the record to the flow monitor after
you create the flow monitor. The flow monitor cache is automatically created at the time the flow monitor is
applied to the first interface. Flow data is collected from the network traffic during the monitoring process
based on the key and nonkey fields in the flow monitor's record and stored in the flow monitor cache.
Examples The following example creates a flow monitor named FLOW-MONITOR-1 and enters flow monitor
configuration mode:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1155
Network Management
flow record
flow record
To create a Flexible NetFlow flow record, or to modify an existing Flexible NetFlow flow record, and enter
Flexible NetFlow flow record configuration mode, use the flow record command in global configuration
mode. To remove a Flexible NetFlow record, use the no form of this command.
flow record record-name
no flow record record-name
Syntax Description record-name Name of the flow record that is being created or modified.
Command Default A Flexible NetFlow flow record is not configured.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record defines the keys that Flexible NetFlow uses to identify packets in the flow, as well as other
fields of interest that Flexible NetFlow gathers for the flow. You can define a flow record with any combination
of keys and fields of interest. The device supports a rich set of keys. A flow record also defines the types of
counters gathered per flow. You can configure 64-bit packet or byte counters.
Examples The following example creates a flow record named FLOW-RECORD-1, and enters Flexible NetFlow
flow record configuration mode:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1156
Network Management
header-type
header-type
To configure the ERSPAN header type for encapsulation, use the header-type command in ERSPAN monitor
source session configuration mode. To remove the configuration, use the no form of this command.
header-type header-type
no header-type header-type
Syntax Description header-type ERSPAN header type. Valid header types are 2 and
3.
Command Default ERSPAN header type is set to 2.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Gibraltar 16.11.1 This command was
introduced.
Examples The following example shows how to change the ERSPAN header type to 3:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# header-type 3
Related Commands Command Description
monitor session type Configures a local ERSPAN source or destination session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1157
Network Management
inactive time
inactive time
To configure et-analytics inactive timer value, use the inactive time secondscommand in the et-analytics
configuration mode. To disable the timer settings, use the no form of the command.
inactive time seconds
no inactive time seconds
Syntax Description inactive time Configures the inactive timer value.
seconds Timer value in seconds. The range
is from 1 to 604800 and the default
value is 60 seconds.
Command Default Disabled.
Command Modes et-analytics configuration (config-et-analytics)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to configure an inactive timer of 10 seconds:
Device>enable
Device#configure terminal
Device(config)# et-analytics
Device(config-et-analytics)# inactive time 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1158
Network Management
ip flow-export destination
ip flow-export destination
To configure the global collector destination IP address, use the ip flow-export destination ip_address
portcommand in the et-analytics configuration mode. To remove the collector destination IP address, use the
no form of the command.
ip flow-export destination ip_address port
no ip flow-export destination ip_address port
Syntax Description ip flow-export destination Configures the global collector
destination IP address and port.
ip_address Destination IP address.
port Destination port.
Command Default Disabled.
Command Modes et-analytics configuration (config-et-analytics)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to configure a flow-exporter destination IP address of 10.1.1.1
and port 2055:
Device>enable
Device#configure terminal
Device(config)# et-analytics
Device(config-et)# ip flow-export destination 10.1.1.1 2055
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1159
Network Management
ip wccp
ip wccp
To enable the web cache service, and specify the service number that corresponds to a dynamic service that
is defined by the application engine, use the ip wccp global configuration command on the device. Use the
no form of this command to disable the service.
ip wccp {web-cache | service-number} [group-address groupaddress] [group-list access-list]
[redirect-list access-list] [password encryption-number password]
no ip wccp {web-cache | service-number} [group-address groupaddress] [group-list access-list]
[redirect-list access-list] [password encryption-number password]
Syntax Description web-cache Specifies the web-cache service (WCCP Version 1 and Version 2).
service-number Dynamic service identifier, which means the service definition is
dictated by the cache. The dynamic service number can be from 0 to
254. The maximum number of services is 256, which includes the
web-cache service specified with the web-cache keyword.
group-address groupaddress (Optional) Specifies the multicast group address used by the device
and the application engines to participate in the service group.
group-list access-list (Optional) If a multicast group address is not used, specifies a list of
valid IP addresses that correspond to the application engines that are
participating in the service group.
redirect-list access-list (Optional) Specifies the redirect service for specific hosts or specific
packets from hosts.
password encryption-number (Optional) Specifies an encryption number. The range is 0 to 7. Use
password 0 for not encrypted, and use 7 for proprietary. Also, specifies a
password name up to seven characters in length. The device combines
the password with the MD5 authentication value to create security
for the connection between the device and the application engine.
By default, no password is configured, and no authentication is
performed.
Command Default WCCP services are not enabled on the device.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines WCCP transparent caching bypasses Network Address Translation (NAT) when Cisco Express Forwarding
switching is enabled. To work around this situation, configure WCCP transparent caching in the outgoing
direction, enable Cisco Express Forwarding switching on the content engine interface, and specify the ip wccp
web-cache redirect out command. Configure WCCP in the incoming direction on the inside interface by
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1160
Network Management
ip wccp
specifying the ip wccp redirect exclude in command on the router interface facing the cache. This configuration
prevents the redirection of any packets arriving on that interface.
You can also include a redirect list when configuring a service group. The specified redirect list will deny
packets with a NAT (source) IP address and prevent redirection.
This command instructs a device to enable or disable support for the specified service number or the web-cache
service name. A service number can be from 0 to 254. Once the service number or name is enabled, the router
can participate in the establishment of a service group.
When the no ip wccp command is entered, the device terminates participation in the service group, deallocates
space if none of the interfaces still have the service configured, and terminates the WCCP task if no other
services are configured.
The keywords following the web-cache keyword and the service-number argument are optional and may be
specified in any order, but only may be specified once.
Example
The following example configures a web cache, the interface connected to the application engine or
the server, and the interface connected to the client:
Device(config)# ip wccp web-cache
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# no switchport
Device(config-if)# ip address 172.20.10.30 255.255.255.0
Device(config-if)# no shutdown
Device(config-if)# exit
Device(config)# interface gigabitethernet1/0/2
Device(config-if)# no switchport
Device(config-if)#
*Dec 6 13:11:29.507: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/3, changed state to down
Device(config-if)# ip address 175.20.20.10 255.255.255.0
Device(config-if)# no shutdown
Device(config-if)# ip wccp web-cache redirect in
Device(config-if)# ip wccp web-cache group-listen
Device(config-if)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1161
Network Management
ip flow monitor
ip flow monitor
To enable a Flexible NetFlow flow monitor for IPv4 traffic that the device is receiving, use the ip flow monitor
command in interface configuration mode. To disable a flow monitor, use the no form of this command.
ip flow monitor monitor-name [sampler sampler-name] input
no ip flow monitor monitor-name [sampler sampler-name] input
Syntax Description monitor-name Name of the flow monitor to apply to the interface.
sampler sampler-name (Optional) Enables the specified flow sampler for the flow monitor.
input Monitors IPv4 traffic that the device receives on the interface.
Command Default A flow monitor is not enabled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Before you can apply a flow monitor to an interface with the ip flow monitor command, you must have
already created the flow monitor using the flow monitor global configuration command.
When you add a sampler to a flow monitor, only packets that are selected by the named sampler will be entered
into the cache to form flows. Each use of a sampler causes separate statistics to be stored for that usage.
You cannot add a sampler to a flow monitor after the flow monitor has been enabled on the interface. You
must first remove the flow monitor from the interface and then enable the same flow monitor with a sampler.
Note The statistics for each flow must be scaled to give the expected true usage. For example, with a 1 in 100
sampler it is expected that the packet and byte counters will have to be multiplied by 100.
The following example enables a flow monitor for monitoring input traffic:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip flow monitor FLOW-MONITOR-1 input
The following example enables a flow monitor for monitoring input traffic, with a sampler to limit
the input packets that are sampled:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip flow monitor FLOW-MONITOR-1 sampler SAMPLER-1 input
The following example shows what happens when you try to add a sampler to a flow monitor that
has already been enabled on an interface without a sampler:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1162
Network Management
ip flow monitor
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip flow monitor FLOW-MONITOR-1 sampler SAMPLER-2 input
% Flow Monitor: Flow Monitor 'FLOW-MONITOR-1' is already on in full mode and cannot be
enabled with a sampler.
The following example shows how to remove a flow monitor from an interface so that it can be
enabled with the sampler:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# no ip flow monitor FLOW-MONITOR-1 input
Device(config-if)# ip flow monitor FLOW-MONITOR-1 sampler SAMPLER-2 input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1163
Network Management
ipv6 flow monitor
ipv6 flow monitor
To enable a flow monitor for IPv6 traffic that the device is receiving, use the ipv6 flow monitor command
in interface configuration mode. To disable a flow monitor, use the no form of this command.
ipv6 flow monitor monitor-name [sampler sampler-name] input
no ipv6 flow monitor monitor-name [sampler sampler-name] input
Syntax Description monitor-name Name of the flow monitor to apply to the interface.
sampler sampler-name (Optional) Enables the specified flow sampler for the flow monitor.
input Monitors IPv6 traffic that the device receives on the interface.
Command Default A flow monitor is not enabled.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Before you can apply a flow monitor to the interface with the ipv6 flow monitor command, you must have
already created the flow monitor using the flow monitor global configuration command.
When you add a sampler to a flow monitor, only packets that are selected by the named sampler will be entered
into the cache to form flows. Each use of a sampler causes separate statistics to be stored for that usage.
You cannot add a sampler to a flow monitor after the flow monitor has been enabled on the interface. You
must first remove the flow monitor from the interface and then enable the same flow monitor with a sampler.
Note The statistics for each flow must be scaled to give the expected true usage. For example, with a 1 in 100
sampler it is expected that the packet and byte counters will have to be multiplied by 100.
The following example enables a flow monitor for monitoring input traffic:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ipv6 flow monitor FLOW-MONITOR-1 input
The following example enables a flow monitor for monitoring input traffic, with a sampler to limit
the input packets that are sampled:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ipv6 flow monitor FLOW-MONITOR-1 sampler SAMPLER-1 input
The following example shows what happens when you try to add a sampler to a flow monitor that
has already been enabled on an interface without a sampler:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1164
Network Management
ipv6 flow monitor
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ipv6 flow monitor FLOW-MONITOR-1 sampler SAMPLER-2 input
% Flow Monitor: Flow Monitor 'FLOW-MONITOR-1' is already on in full mode and cannot be
enabled with a sampler.
The following example shows how to remove a flow monitor from an interface so that it can be
enabled with the sampler:
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# no ipv6 flow monitor FLOW-MONITOR-1 input
Device(config-if)# ipv6 flow monitor FLOW-MONITOR-1 sampler SAMPLER-2 input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1165
Network Management
ipv6 deny echo reply
ipv6 deny echo reply
To disable the generation of ICMP IPv6 echo reply message to an IPv6 multicast address or anycast address,
use the ipv6 deny-echo-reply command in the global configuration mode. To enable the generation of ICMP
IPv6 echo reply message, use the no form of the command.
ipv6 deny-echo-reply
no ipv6 deny-echo-reply
Command Default ICMPv6 Echo Reply messages are sent from the device.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 The command was introduced.
Usage Guidelines The ipv6 deny-echo-reply command works only for an IPv6 multicast or anycast address. It does not suppress
an echo reply message for an IPv6 unicast address.
The following example shows how to configure a device to stop sending a response to an ICMPv6
echo message:
Device# configure terminal
Device(config)#ipv6 deny-echo-reply
Router(config)#end
The following example shows how to remove the ipv6 deny-echo-reply configuration:
Device# configure terminal
Device(config)#no ipv6 deny-echo-reply
Router(config)#end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1166
Network Management
match datalink ethertype
match datalink ethertype
To configure the EtherType of the packet as a key field for a flow record, use the match datalink ethertype
command in flow record configuration mode. To disable the EtherType of the packet as a key field for a flow
record, use the no form of this command.
match datalink ethertype
no match datalink ethertype
Syntax Description This command has no arguments or keywords.
Command Default The EtherType of the packet is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
When you configure the EtherType of the packet as a key field for a flow record using the match datalink
ethertype command, the traffic flow that is created is based on the type of flow monitor that is assigned to
the interface:
• When a datalink flow monitor is assigned to an interface using the datalink flow monitor interface
configuration command, it creates unique flows for different Layer 2 protocols.
• When an IP flow monitor is assigned to an interface using the ip flow monitor interface configuration
command, it creates unique flows for different IPv4 protocols.
• When an IPv6 flow monitor is assigned to an interface using the ipv6 flow monitor interface configuration
command, it creates unique flows for different IPv6 protocols.
To return this command to its default settings, use the no match datalink ethertype or default match datalink
ethertype flow record configuration command.
The following example configures the EtherType of the packet as a key field for a Flexible NetFlow
flow record:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match datalink ethertype
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1167
Network Management
match datalink mac
match datalink mac
To configure the use of MAC addresses as a key field for a flow record, use the match datalink mac command
in flow record configuration mode. To disable the use of MAC addresses as a key field for a flow record, use
the no form of this command.
match datalink mac {destination address input | source address input}
no match datalink mac {destination address input | source address input}
Syntax Description destination address Configures the use of the destination MAC address as a key field.
input Specifies the MAC address of input packets.
source address Configures the use of the source MAC address as a key field.
Command Default MAC addresses are not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The input keyword is used to specify the observation point that is used by the match datalink mac command
to create flows based on the unique MAC addresses in the network traffic.
Note When a datalink flow monitor is assigned to an interface or VLAN record, it creates flows only for non-IPv6
or non-IPv4 traffic.
To return this command to its default settings, use the no match datalink mac or default match datalink
mac flow record configuration command.
The following example configures the use of the destination MAC address of packets that are received
by the device as a key field for a flow record:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match datalink mac destination address input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1168
Network Management
match datalink vlan
match datalink vlan
To configure the VLAN ID as a key field for a flow record, use the match datalink vlan command in flow
record configuration mode. To disable the use of the VLAN ID value as a key field for a flow record, use the
no form of this command.
match datalink vlan input
no match datalink vlan input
Syntax Description input Configures the VLAN ID of traffic being received by the device as a key field.
Command Default The VLAN ID is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The input keyword is used to specify the observation point that is used by the match datalink vlan command
to create flows based on the unique VLAN IDs in the network traffic.
The following example configures the VLAN ID of traffic being received by the device as a key
field for a flow record:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match datalink vlan input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1169
Network Management
match device-type
match device-type
To evaluate control classes based on the device type, use the match device-type command in control class-map
filter mode. To disable this condition, use the no form of this command.
match device-type { device-name | regex regular-expression }
no match device-type
Syntax Description device-name Device name for the class map attribute filter criteria.
regex regular-expression Regular expression to specify the filter type.
Command Default No default behavior or values.
Command Modes Control class-map filter (config-filter-control-classmap)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.1 This command was
introduced.
Examples The following example shows how to set a class map filter to match a device type:
Device> enable
Device# configure terminal
Device(config)# class-map type control subscriber match-all DOT1X_NO_AGENT
Device(config-filter-control-classmap)# match device-type regex cis*
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1170
Network Management
match flow cts
match flow cts
To configure CTS source group tag and destination group tag for a flow record, use thematch flow cts
command in flow record configuration mode. To disable the group tag as key field for a flow record, use the
no form of this command.
match flow cts {source | destination} group-tag
no match flow cts {source | destination} group-tag
Syntax Description cts destination group-tag Configures the CTS destination field group as a key field.
cts source group-tag Configures the CTS source field group as a key field.
Command Default The CTS destination or source field group, flow direction and the flow sampler ID are not configured as key
fields.
Command Modes Flexible NetFlow flow record configuration (config-flow-record)
Policy inline configuration (config-if-policy-inline)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a The command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the source group-tag as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match flow cts source group-tag
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1171
Network Management
match flow direction
match flow direction
To configure the flow direction as key fields for a flow record, use the match flow direction command in
flow record configuration mode. To disable the use of the flow direction as key fields for a flow record, use
the no form of this command.
match flow direction
no match flow direction
Syntax Description This command has no arguments or keywords.
Command Default The flow direction is not configured as key fields.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The match flow direction command captures the direction of the flow as a key field. This feature is most
useful when a single flow monitor is configured for input and output flows. It can be used to find and eliminate
flows that are being monitored twice, once on input and once on output. This command can help to match up
pairs of flows in the exported data when the two flows are flowing in opposite directions.
The following example configures the direction the flow was monitored in as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match flow direction
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1172
Network Management
match interface
match interface
To configure the input and output interfaces as key fields for a flow record, use the match interface command
in flow record configuration mode. To disable the use of the input and output interfaces as key fields for a
flow record, use the no form of this command.
match interface {input | output}
no match interface {input | output}
Syntax Description input Configures the input interface as a key field.
output Configures the output interface as a key field.
Command Default The input and output interfaces are not configured as key fields.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the input interface as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match interface input
The following example configures the output interface as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match interface output
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1173
Network Management
match ipv4
match ipv4
To configure one or more of the IPv4 fields as a key field for a flow record, use the match ipv4 command in
flow record configuration mode. To disable the use of one or more of the IPv4 fields as a key field for a flow
record, use the no form of this command.
match ipv4 {destination address | protocol | source address | tos | version}
no match ipv4 {destination address | protocol | source address | tos | version}
Syntax Description destination address Configures the IPv4 destination address as a key field. For more information see
match ipv4 destination address.
protocol Configures the IPv4 protocol as a key field.
source address Configures the IPv4 destination address as a key field. For more information see
match ipv4 source address.
tos Configures the IPv4 ToS as a key field.
version Configures the IP version from IPv4 header as a key field.
Command Default The use of one or more of the IPv4 fields as a key field for a user-defined flow record is not enabled.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the IPv4 protocol as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv4 protocol
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1174
Network Management
match ipv4 destination address
match ipv4 destination address
To configure the IPv4 destination address as a key field for a flow record, use the match ipv4 destination
address command in flow record configuration mode. To disable the IPv4 destination address as a key field
for a flow record, use the no form of this command.
match ipv4 destination address
no match ipv4 destination address
Syntax Description This command has no arguments or keywords.
Command Default The IPv4 destination address is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
To return this command to its default settings, use the no match ipv4 destination address or default match
ipv4 destination address flow record configuration command.
The following example configures the IPv4 destination address as a key field for a flow record:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv4 destination address
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1175
Network Management
match ipv4 source address
match ipv4 source address
To configure the IPv4 source address as a key field for a flow record, use the match ipv4 source address
command in flow record configuration mode. To disable the use of the IPv4 source address as a key field for
a flow record, use the no form of this command.
match ipv4 source address
no match ipv4 source address
Syntax Description This command has no arguments or keywords.
Command Default The IPv4 source address is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
To return this command to its default settings, use the no match ipv4 source address or default match ipv4
source address flow record configuration command.
The following example configures the IPv4 source address as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv4 source address
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1176
Network Management
match ipv4 ttl
match ipv4 ttl
To configure the IPv4 time-to-live (TTL) field as a key field for a flow record, use the match ipv4 ttl command
in flow record configuration mode. To disable the use of the IPv4 TTL field as a key field for a flow record,
use the no form of this command.
match ipv4 ttl
no match ipv4 ttl
Syntax Description This command has no arguments or keywords.
Command Default The IPv4 time-to-live (TTL) field is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match ipv4 ttl command.
The following example configures IPv4 TTL as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv4 ttl
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1177
Network Management
match ipv6
match ipv6
To configure one or more of the IPv6 fields as a key field for a flow record, use the match ipv6 command in
flow record configuration mode. To disable the use of one or more of the IPv6 fields as a key field for a flow
record, use the no form of this command.
match ipv6 {destination address | protocol | source address | traffic-class | version}
no match ipv6 {destination address | protocol | source address | traffic-class | version}
Syntax Description destination address Configures the IPv4 destination address as a key field. For more
information see match ipv6 destination address.
protocol Configures the IPv6 protocol as a key field.
source address Configures the IPv4 destination address as a key field. For more
information see match ipv6 source address.
Command Default The IPv6 fields are not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the IPv6 protocol field as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv6 protocol
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1178
Network Management
match ipv6 destination address
match ipv6 destination address
To configure the IPv6 destination address as a key field for a flow record, use the match ipv6 destination
address command in flow record configuration mode. To disable the IPv6 destination address as a key field
for a flow record, use the no form of this command.
match ipv6 destination address
no match ipv6 destination address
Syntax Description This command has no arguments or keywords.
Command Default The IPv6 destination address is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
To return this command to its default settings, use the no match ipv6 destination address or default match
ipv6 destination address flow record configuration command.
The following example configures the IPv6 destination address as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv6 destination address
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1179
Network Management
match ipv6 hop-limit
match ipv6 hop-limit
To configure the IPv6 hop limit as a key field for a flow record, use the match ipv6 hop-limit command in
flow record configuration mode. To disable the use of a section of an IPv6 packet as a key field for a flow
record, use the no form of this command.
match ipv6 hop-limit
no match ipv6 hop-limit
Syntax Description This command has no arguments or keywords.
Command Default The use of the IPv6 hop limit as a key field for a user-defined flow record is not enabled by default.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the hop limit of the packets in the flow as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv6 hop-limit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1180
Network Management
match ipv6 source address
match ipv6 source address
To configure the IPv6 source address as a key field for a flow record, use the match ipv6 source address
command in flow record configuration mode. To disable the use of the IPv6 source address as a key field for
a flow record, use the no form of this command.
match ipv6 source address
no match ipv6 source address
Syntax Description This command has no arguments or keywords.
Command Default The IPv6 source address is not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
To return this command to its default settings, use the no match ipv6 source address or default match ipv6
source address flow record configuration command.
The following example configures a IPv6 source address as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match ipv6 source address
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1181
Network Management
map platform-type
map platform-type
To set the parameter map attribute filter criteria to platform type, use the map platform-type command in
parameter-map filter mode. To remove this criteria, use the no form of this command.
map-number map platform-type {{eq | not-eq | regex} platform-type}
no map-number map platform-type {{eq | not-eq | regex} platform-type}
Syntax Description map-number Parameter map number.
eq Specifies that the filter type name is equal to the platform type name.
not-eq Specifies that the filter type name is not equal to the platform type name.
regex Specifies that the filter type name is a regular expression.
platform-type Platform type for the parameter map attribute filter criteria.
Command Default No default behavior or values.
Command Modes Parameter-map filter (config-parameter-map-filter)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Examples The following example shows how to set the parameter map attribute filter criteria to platform type:
Device> enable
Device# configure terminal
Device(config)# parameter-map type subscriber attribute-to-service Aironet-Policy-para
Device(config-parameter-map-filter)# 10 map platform-type eq C9xxx
Related Commands Command Description
parameter-map type subscriber Configures a subscriber parameter map and enters
attribute-to-service parameter-map filter configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1182
Network Management
match transport
match transport
To configure one or more of the transport fields as a key field for a flow record, use the match transport
command in flow record configuration mode. To disable the use of one or more of the transport fields as a
key field for a flow record, use the no form of this command.
Syntax Description destination-port Configures the transport destination port as a key field.
source-port Configures the transport source port as a key field.
Command Default The transport fields are not configured as a key field.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the destination port as a key field:
(config)# flow record FLOW-RECORD-1
(config-flow-record)# match transport destination-port
The following example configures the source port as a key field:
(config)# flow record FLOW-RECORD-1
(config-flow-record)# match transport source-port
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1183
Network Management
match transport icmp ipv4
match transport icmp ipv4
To configure the ICMP IPv4 type field and the code field as key fields for a flow record, use the match
transport icmp ipv4 command in flow record configuration mode. To disable the use of the ICMP IPv4 type
field and code field as key fields for a flow record, use the no form of this command.
match transport icmp ipv4 {code | type}
no match transport icmp ipv4 {code | type}
Syntax Description code Configures the IPv4 ICMP code as a key field.
type Configures the IPv4 ICMP type as a key field.
Command Default The ICMP IPv4 type field and the code field are not configured as key fields.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the IPv4 ICMP code field as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match transport icmp ipv4 code
The following example configures the IPv4 ICMP type field as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match transport icmp ipv4 type
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1184
Network Management
match transport icmp ipv6
match transport icmp ipv6
To configure the ICMP IPv6 type field and the code field as key fields for a flow record, use the match
transport icmp ipv6 command in flow record configuration mode. To disable the use of the ICMP IPv6 type
field and code field as key fields for a flow record, use the no form of this command.
match transport icmp ipv6 {code | type}
no match transport icmp ipv6 {code | type}
Syntax Description code Configures the IPv6 ICMP code as a key field.
type Configures the IPv6 ICMP type as a key field.
Command Default The ICMP IPv6 type field and the code field are not configured as key fields.
Command Modes Flow record configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A flow record requires at least one key field before it can be used in a flow monitor. The key fields distinguish
flows, with each flow having a unique set of values for the key fields. The key fields are defined using the
match command.
The following example configures the IPv6 ICMP code field as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match transport icmp ipv6 code
The following example configures the IPv6 ICMP type field as a key field:
Device(config)# flow record FLOW-RECORD-1
Device(config-flow-record)# match transport icmp ipv6 type
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1185
Network Management
match platform-type
match platform-type
To evaluate control classes based on the platform type, use the match platform-type command in control
class-map filter mode. To remove this condition, use the no form of this command.
match platform-type platform-name
no match platform-type platform-name
Syntax Description platform-name Name of the
platform.
Command Default No default behavior or values.
Command Modes Control class-map filter (config-filter-control-classmap)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Examples The following example shows how to set a class map filter to match a platform type:
Device> enable
Device# configure terminal
Device(config)# class-map type control subscriber match-all DOT1X_NO_AGENT
Device(config-filter-control-classmap)# match platform-type C9xxx
Related Commands Command Description
class-map type control subscriber Creates a control class and enters control class-map filter mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1186
Network Management
mode random 1 out-of
mode random 1 out-of
To enable random sampling and to specify the packet interval for a Flexible NetFlow sampler, use the mode
random 1 out-of command in sampler configuration mode. To remove the packet interval information for a
Flexible NetFlow sampler, use the no form of this command.
mode random 1 out-of window-size
no mode
Syntax Description window-size Specifies the window size from which to select packets. The range is 2 to 1024.
Command Default The mode and the packet interval for a sampler are not configured.
Command Modes Sampler configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A total of four unique samplers are supported on the device. Packets are chosen in a manner that should
eliminate any bias from traffic patterns and counter any attempt by users to avoid monitoring.
Note The deterministic keyword is not supported, even though it is visible in the command-line help string.
Examples The following example enables random sampling with a window size of 1000:
Device(config)# sampler SAMPLER-1
Device(config-sampler)# mode random 1 out-of 1000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1187
Network Management
monitor capture (interface/control plane)
monitor capture (interface/control plane)
To configure monitor capture points specifying an attachment point and the packet flow direction or add more
attachment points to a capture point, use the monitor capture command in privileged EXEC mode. To disable
the monitor capture with the specified attachment point and the packet flow direction or disable one of multiple
attachment points on a capture point, use the no form of this command.
monitor capture {capture-name}{interface interface-type interface-id | control-plane}{in | out
| both}
no monitor capture {capture-name}{interface interface-type interface-id | control-plane}{in |
out | both}
Syntax Description capture-name The name of the capture to be defined.
interface interface-type Specifies an interface with interface-type and interface-id as an attachment
interface-id point. The arguments have these meanings:
• GigabitEthernet interface-id—A Gigabit Ethernet IEEE 802.3z
interface.
• vlan vlan-id—A VLAN. The range for vlan-id is 1 to 4095.
control-plane Specifies the control plane as an attachment point.
in | out | both Specifies the traffic direction to be captured.
Command Default A Wireshark capture is not configured.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Once an attachment point has been associated with a capture point using this command, the only way to change
its direction is to remove the attachment point using the no form of the command and reattach the attachment
point with the new direction. An attachment point's direction cannot be overridden.
If an attachment point is removed from a capture point and only one attachment point is associated with it,
the capture point is effectively deleted.
Multiple attachment points can be associated with a capture point by re-running this command with another
attachment point. An example is provided below.
Packets captured in the output direction of an interface might not reflect the changes made by switch rewrite
(includes TTL, VLAN tag, CoS, checksum, MAC addresses, DSCP, precedent, UP, etc.).
No specific order applies when defining a capture point; you can define capture point parameters in any order.
The Wireshark CLI allows as many parameters as possible on a single line. This limits the number of commands
required to define a capture point.
Neither VRFs, management ports, nor private VLANs can be used as attachment points.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1188
Network Management
monitor capture (interface/control plane)
Wireshark cannot capture packets on a destination SPAN port.
When a VLAN is used as a Wireshark attachment point, packets are captured in the input direction only.
Examples
To define a capture point using a physical interface as an attachment point:
Device# monitor capture mycap interface GigabitEthernet1/0/1 in
Device# monitor capture mycap match ipv4 any any
Note The second command defines the core filter for the capture point. This is required for a functioning
capture point.
To define a capture point with multiple attachment points:
Device# monitor capture mycap interface GigabitEthernet1/0/1 in
Device# monitor capture mycap match ipv4 any any
Device# monitor capture mycap control-plane in
Device# show monitor capture mycap parameter
monitor capture mycap interface GigabitEthernet1/0/1 in
monitor capture mycap control-plane in
To remove an attachment point from a capture point defined with multiple attachment points:
Device# show monitor capture mycap parameter
monitor capture mycap interface GigabitEthernet1/0/1 in
monitor capture mycap control-plane in
Device# no monitor capture mycap control-plane
Device# show monitor capture mycap parameter
monitor capture mycap interface GigabitEthernet1/0/1 in
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1189
Network Management
monitor capture buffer
monitor capture buffer
To configure the buffer for monitor capture (WireShark), use the monitor capture buffer command in
privileged EXEC mode. To disable the monitor capture buffer or change the buffer back to a default linear
buffer from a circular buffer, use the no form of this command.
monitor capture {capture-name} buffer {circular [size buffer-size ] | size buffer-size}
no monitor capture {capture-name} buffer [circular ]
Syntax Description capture-name The name of the capture whose buffer is to be configured.
circular Specifies that the buffer is of a circular type. The circular type of buffer continues to capture
data, even after the buffer is consumed, by overwriting the data captured previously.
size buffer-size (Optional) Specifies the size of the buffer. The range is from 1 MB to 100 MB.
Command Default A linear buffer is configured.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you first configure a WireShark capture, a circular buffer of a small size is suggested.
Example
To configure a circular buffer with a size of 1 MB:
Device# monitor capture mycap buffer circular size 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1190
Network Management
monitor capture clear
monitor capture clear
To clears the monitor capture (WireShark) buffer, use the monitor capture clear command in privileged
EXEC mode.
monitor capture {capture-name} clear
Syntax Description capture-name The name of the capture whose buffer is to be cleared.
Command Default The buffer content is not cleared.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the monitor capture clear command either during capture or after the capture has stopped either because
one or more end conditions has been met, or you entered the monitor capture stop command. If you enter
the monitor capture clear command after the capture has stopped, the monitor capture export command
that is used to store the contents of the captured packets in a file will have no impact because the buffer has
no captured packets.
If you have more than one capture that is storing packets in a buffer, clear the buffer before starting a new
capture to avoid memory loss.
Example
To clear the buffer contents for capture mycap:
Device# monitor capture mycap clear
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1191
Network Management
monitor capture export
monitor capture export
To export a monitor capture (WireShark) to a file, use the monitor capture export command in privileged
EXEC mode.
monitor capture {capture-name} export file-location : file-name
Syntax Description capture-name The name of the capture to be exported.
file-location : file-name (Optional) Specifies the location and file name of the capture storage file.
Acceptable values for file-location :
• flash—On-board flash storage
• — USB drive
Command Default The captured packets are not stored.
Command Modes Privileged EXEC
Command History Release Modification
This command was introduced.
Usage Guidelines Use the monitor capture export command only when the storage destination is a capture buffer. The file
may be stored either remotely or locally. Use this command either during capture or after the packet capture
has stopped. The packet capture is stopped when one or more end conditions have been met or you entered
the monitor capture stop command.
When WireShark is used on switches in a stack, packet captures can be stored only on the devices specified
for file-location above that are connected to the active switch. Example: flash1 is connected to the active
switch. flash2 is connected to the secondary switch. Only flash1 can be used to store packet captures.
Note Attempts to store packet captures on unsupported devices or devices not connected to the active switch will
probably result in errors.
Example
To export the capture buffer contents to mycap.pcap on a flash drive:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1192
Network Management
monitor capture file
monitor capture file
To configure monitor capture (WireShark) storage file attributes, use the monitor capture file command in
privileged EXEC mode. To remove a storage file attribute, use the no form of this command.
monitor capture {capture-name} file{[ buffer-size temp-buffer-size ][ location file-location :
file-name ][ ring number-of-ring-files ][ size total-size ]}
no monitor capture {capture-name} file{[ buffer-size ][ location ][ ring ][ size ]}
Syntax Description capture-name The name of the capture to be modified.
buffer-size temp-buffer-size (Optional) Specifies the size of the temporary buffer. The range for
temp-buffer-size is 1 to 100 MB. This is specified to reduce packet loss.
location file-location : file-name (Optional) Specifies the location and file name of the capture storage
file. Acceptable values for file-location :
• flash—On-board flash storage
• — USB drive
ring number-of-ring-files (Optional) Specifies that the capture is to be stored in a circular file chain
and the number of files in the file ring.
size total-size (Optional) Specifies the total size of the capture files.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the monitor capture file command only when the storage destination is a file. The file may be stored
either remotely or locally. Use this command after the packet capture has stopped. The packet capture is
stopped when one or more end conditions have been met or you entered the monitor capture stop command.
When WireShark is used on switches in a stack, packet captures can be stored only on the devices specified
for file-location above that are connected to the active switch. Example: flash1 is connected to the active
switch. flash2 is connected to the secondary switch. Only flash1 can be used to store packet captures.
Note Attempts to store packet captures on unsupported devices or devices not connected to the active switch will
probably result in errors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1193
Network Management
monitor capture file
Example
To specify that the storage file name is mycap.pcap, stored on a flash drive:
Device# monitor capture mycap file location flash:mycap.pcap
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1194
Network Management
monitor capture limit
monitor capture limit
To configure capture limits, use the monitor capture limit command in privileged EXEC mode. To remove
the capture limits, use the no form of this command.
monitor capture {capture-name} limit {[duration seconds][packet-length size][packets num]}
no monitor capture {capture-name} limit [duration][packet-length][packets]
Syntax Description capture-name The name of the capture to be assigned capture limits.
duration seconds (Optional) Specifies the duration of the capture, in seconds. The range is from 1 to
1000000.
packet-length size (Optional) Specifies the packet length, in bytes. If the actual packet is longer than the
specified length, only the first set of bytes whose number is denoted by the bytes
argument is stored.
packets num (Optional) Specifies the number of packets to be processed for capture.
Command Default Capture limits are not configured.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
To configure a session limit of 60 seconds and a packet segment length of 400 bytes:
Device# monitor capture mycap limit duration 60 packet-len 400
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1195
Network Management
monitor capture match
monitor capture match
To define an explicit inline core filter for a monitor (Wireshark) capture, use the monitor capture match
command in privileged EXEC mode. To remove this filter, use the no form of this command.
monitor capture {capture-name} match {any | mac mac-match-string | ipv4 {any | host |
protocol}{any | host} | ipv6 {any | host | protocol}{any | host}}
no monitor capture {capture-name} match
Syntax Description capture-name The name of the capture to be assigned a core filter.
any Specifies all packets.
mac mac-match-string Specifies a Layer 2 packet.
ipv4 Specifies IPv4 packets.
host Specifies the host.
protocol Specifies the protocol.
ipv6 Specifies IPv6 packets.
Command Default A core filter is not configured.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples
To define a capture point and the core filter for the capture point that matches to any IP version 4
packets on the source or destination:
Device# monitor capture mycap interface GigabitEthernet1/0/1 in
Device# monitor capture mycap match ipv4 any any
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1196
Network Management
monitor capture pktlen-range
monitor capture pktlen-range
To specify a range of packet lengths for packet capture, use the monitor capture pktlen-range command in
the EXEC configuration mode. To remove the packet length range filter, use the no form of this command
monitor capture capture-name interface interface-id {in |out|both}match pktlen-range [max
packet-length-in bytes ][min packet-length-in bytes ]
no monitor capture capture-name interface interface-id {in |out|both}match pktlen-range [max
packet-length-in bytes ][min packet-length-in bytes ]
Syntax Description packet-length-in bytes Defines the length of the packet to be captured.The range is from 1-9216.
Command Default The default action is to have no packet length range for packet capture.
Command Modes Global configuration mode.
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 The command was
introduced.
This example shows how to define a range of packet lengths for packet capture. In this example the
maximum length of packet is set to 100 bytes and the minimum length of packet is set to 50 bytes.
Device(config)#mon cap cap1 int FortyGigabitEthernet 1/0/1 in match pktlen-range max 100
min 50
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1197
Network Management
monitor capture start
monitor capture start
To start the capture of packet data at a traffic trace point into a buffer, use the monitor capture start command
in privileged EXEC mode.
monitor capture {capture-name} start
Syntax Description capture-name The name of the capture to be started.
Command Default The buffer content is not cleared.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the monitor capture clear command to enable the packet data capture after the capture point is defined.
To stop the capture of packet data, use the monitor capture stop command.
Ensure that system resources such as CPU and memory are available before starting a capture.
Example
To start capturing buffer contents:
Device# monitor capture mycap start
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1198
Network Management
monitor capture stop
monitor capture stop
To stop the capture of packet data at a traffic trace point, use the monitor capture stop command in privileged
EXEC mode.
monitor capture {capture-name} stop
Syntax Description capture-name The name of the capture to be stopped.
Command Default The packet data capture is ongoing.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the monitor capture stop command to stop the capture of packet data that you started using the monitor
capture start command. You can configure two types of capture buffers: linear and circular. When the linear
buffer is full, data capture stops automatically. When the circular buffer is full, data capture starts from the
beginning and the data is overwritten.
Example
To stop capturing buffer contents:
Device# monitor capture mycap stop
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1199
Network Management
monitor session
monitor session
To create a new Ethernet Switched Port Analyzer (SPAN) or a Remote Switched Port Analyzer (RSPAN) or
Encapsulated Remote Switched Port Analyzer (ERSPAN) session configuration for analyzing traffic between
ports or add to an existing session configuration, use the monitor session global configuration command. To
clear sessions, use the no form of this command.
monitor session session-number {destination | filter | source | type {erspan-destination |
erspan-source}}
no monitor session {session-number [destination | filter | source | type {erspan-destination
| erspan-source}] | all | local | range session-range | remote}
Syntax Description session-number The session number identified with the sessio
all Clears all monitor sessions.
local Clears all local monitor sessions.
range session-range Clears monitor sessions in the specified range
remote Clears all remote monitor sessions.
Command Default No monitor sessions are configured.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.11.1 The type {erspan-destination |
erspan-source} keywords were
introduced.
Usage Guidelines You can set a combined maximum of two local SPAN sessions and RSPAN source sessions. You can have
a total of 66 SPAN, RSPAN, and ERSPAN sessions on a switch or switch stack.
You can verify your settings by entering the show monitor privileged EXEC command. You can display
SPAN, RSPAN, FSPAN, FRSPAN, and ERSPAN configuration on the switch by entering the show
running-config privileged EXEC command. SPAN information appears near the end of the output.
Example
This example shows how to create a local SPAN session 1 to monitor traffic on Po13 (an EtherChannel
port) and limit SPAN traffic in the session only to VLAN 1281. Egress traffic replicates the source;
ingress forwarding is not enabled.
Device(config)# monitor session 1 source interface Po13
Device(config)# monitor session 1 filter vlan 1281
Device(config)# monitor session 1 destination interface GigabitEthernet2/0/36 encapsulation
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1200
Network Management
monitor session
replicate
Device(config)# monitor session 1 destination interface GigabitEthernet3/0/36 encapsulation
replicate
The following is the output of a show monitor session all command after completing these setup
instructions:
Device# show monitor session all
Session 1
---------
Type : Local Session
Source Ports :
Both : Po13
Destination Ports : Gi2/0/36,Gi3/0/36
Encapsulation : Replicate
Ingress : Disabled
Filter VLANs : 1281
...
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1201
Network Management
monitor session destination
monitor session destination
To start a new Switched Port Analyzer (SPAN) session or Remote SPAN (RSPAN) destination session, to
enable ingress traffic on the destination port for a network security device (such as a Cisco IDS Sensor
Appliance), and to add or delete interfaces or VLANs to or from an existing SPAN or RSPAN session, use
the monitor session destination global configuration command. To remove the SPAN or RSPAN session or
to remove destination interfaces from the SPAN or RSPAN session, use the no form of this command.
monitor session session-number destination {interface interface-id [, | -] [encapsulation
{replicate | dot1q} ] {ingress [dot1q | untagged] } | {remote} vlan vlan-id
no monitor session session-number destination {interface interface-id [, | -] [encapsulation
{replicate | dot1q} ] {ingress [dot1q | untagged] } | {remote} vlan vlan-id
Syntax Description session-number The session number identified with the SPAN
interface interface-id Specifies the destination or source interface fo
physical ports (including type, stack member,
channel is also a valid interface type, and the
, (Optional) Specifies a series of interfaces or V
from a previous range. Enter a space before a
- (Optional) Specifies a range of interfaces or V
encapsulation replicate (Optional) Specifies that the destination interfa
If not selected, the default is to send packets i
These keywords are valid only for local SPAN
original VLAN ID; therefore, packets are alw
ignored with the no form of the command.
encapsulation dot1q (Optional) Specifies that the destination interf
IEEE 802.1Q encapsulation.
These keywords are valid only for local SPAN
original VLAN ID; therefore, packets are alw
ignored with the no form of the command.
ingress Enables ingress traffic forwarding.
dot1q (Optional) Accepts incoming packets with IE
the default VLAN.
untagged (Optional) Accepts incoming packets with un
default VLAN.
isl Specifies ingress forwarding using ISL encap
remote Specifies the remote VLAN for an RSPAN so
1006 to 4094.
The RSPAN VLAN cannot be VLAN 1 (the d
for Token Ring and FDDI VLANs).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1202
Network Management
monitor session destination
vlan vlan-id Sets the default VLAN for ingress traffic w
Command Default No monitor sessions are configured.
If encapsulation replicate is not specified on a local SPAN destination port, packets are sent in native form
with no encapsulation tag.
Ingress forwarding is disabled on destination ports.
You can specify all, local, range session-range, or remote with the no monitor session command to clear
all SPAN and RSPAN, all local SPAN, a range, or all RSPAN sessions.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can set a combined maximum of 8 local SPAN sessions and RSPAN source sessions. You can have a
total of 66 SPAN and RSPAN sessions on a switch or switch stack.
A SPAN or RSPAN destination must be a physical port.
You can have a maximum of 64 destination ports on a switch or a switch stack.
Each session can include multiple ingress or egress source ports or VLANs, but you cannot combine source
ports and source VLANs in a single session. Each session can include multiple destination ports.
When you use VLAN-based SPAN (VSPAN) to analyze network traffic in a VLAN or set of VLANs, all
active ports in the source VLANs become source ports for the SPAN or RSPAN session. Trunk ports are
included as source ports for VSPAN, and only packets with the monitored VLAN ID are sent to the destination
port.
You can monitor traffic on a single port or VLAN or on a series or range of ports or VLANs. You select a
series or range of interfaces or VLANs by using the [, | -] options.
If you specify a series of VLANs or interfaces, you must enter a space before and after the comma. If you
specify a range of VLANs or interfaces, you must enter a space before and after the hyphen (-).
EtherChannel ports can be configured as SPAN or RSPAN destination ports. A physical port that is a member
of an EtherChannel group can be used as a destination port, but it cannot participate in the EtherChannel group
while it is as a SPAN destination.
A port used as a destination port cannot be a SPAN or RSPAN source, nor can a port be a destination port for
more than one session at a time.
You can enable IEEE 802.1x authentication on a port that is a SPAN or RSPAN destination port; however,
IEEE 802.1x authentication is disabled until the port is removed as a SPAN destination. If IEEE 802.1x
authentication is not available on the port, the switch returns an error message. You can enable IEEE 802.1x
authentication on a SPAN or RSPAN source port.
If ingress traffic forwarding is enabled for a network security device, the destination port forwards traffic at
Layer 2.
Destination ports can be configured to function in these ways:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1203
Network Management
monitor session destination
• When you enter monitor session session_number destination interface interface-id with no other
keywords, egress encapsulation is untagged, and ingress forwarding is not enabled.
• When you enter monitor session session_number destination interface interface-id ingress, egress
encapsulation is untagged; ingress encapsulation depends on the keywords that follow—dot1q or
untagged.
• When you enter monitor session session_number destination interface interface-id encapsulation
replicate with no other keywords, egress encapsulation replicates the source interface encapsulation;
ingress forwarding is not enabled. (This applies to local SPAN only; RSPAN does not support
encapsulation replication.)
• When you enter monitor session session_number destination interface interface-id encapsulation
replicate ingress, egress encapsulation replicates the source interface encapsulation; ingress encapsulation
depends on the keywords that follow—dot1q or untagged. (This applies to local SPAN only; RSPAN
does not support encapsulation replication.)
You can verify your settings by entering the show monitor privileged EXEC command. You can display
SPAN, RSPAN, FSPAN, and FRSPAN configuration on the switch by entering the show running-config
privileged EXEC command. SPAN information appears near the end of the output.
Examples
This example shows how to create a local SPAN session 1 to monitor both sent and received traffic
on source port 1 on stack member 1 to destination port 2 on stack member 2:
Device(config)# monitor session 1 source interface gigabitethernet1/0/1 both
Device(config)# monitor session 1 destination interface gigabitethernet1/0/2
This example shows how to delete a destination port from an existing local SPAN session:
Device(config)# no monitor session 2 destination interface gigabitethernet1/0/2
This example shows how to configure RSPAN source session 1 to monitor a source interface and to
configure the destination RSPAN VLAN 900:
Device(config)# monitor session 1 source interface gigabitethernet1/0/1
Device(config)# monitor session 1 destination remote vlan 900
Device(config)# end
This example shows how to configure an RSPAN destination session 10 in the switch receiving the
monitored traffic:
Device(config)# monitor session 10 source remote vlan 900
Device(config)# monitor session 10 destination interface gigabitethernet1/0/2
This example shows how to configure the destination port for ingress traffic on VLAN 5 by using a
security device that supports IEEE 802.1Q encapsulation. Egress traffic replicates the source; ingress
traffic uses IEEE 802.1Q encapsulation.
Device(config)# monitor session 2 destination interface gigabitethernet1/0/2 encapsulation
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1204
Network Management
monitor session destination
dot1q ingress dot1q vlan 5
This example shows how to configure the destination port for ingress traffic on VLAN 5 by using a
security device that does not support encapsulation. Egress traffic and ingress traffic are untagged.
Device(config)# monitor session 2 destination interface gigabitethernet1/0/2 ingress untagged
vlan 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1205
Network Management
monitor session filter
monitor session filter
To start a new flow-based SPAN (FSPAN) session or flow-based RSPAN (FRSPAN) source or destination
session, or to limit (filter) SPAN source traffic to specific VLANs, use the monitor session filter global
configuration command. To remove filters from the SPAN or RSPAN session, use the no form of this command.
monitor session session-number filter {vlan vlan-id [, | -] }
no monitor session session-number filter {vlan vlan-id [, | -] }
Syntax Description session-number The session number identified with the SPAN or RSPAN ses
vlan vlan-id Specifies a list of VLANs as filters on trunk source ports to lim
VLANs. The vlan-id range is 1 to 4094.
, (Optional) Specifies a series of VLANs, or separates a range
Enter a space before and after the comma.
- (Optional) Specifies a range of VLANs. Enter a space before
Command Default No monitor sessions are configured.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can set a combined maximum of two local SPAN sessions and RSPAN source sessions. You can have
a total of 66 SPAN and RSPAN sessions on a switch or switch stack.
You can monitor traffic on a single VLAN or on a series or range of ports or VLANs. You select a series or
range of VLANs by using the [, | -] options.
If you specify a series of VLANs, you must enter a space before and after the comma. If you specify a range
of VLANs, you must enter a space before and after the hyphen (-).
VLAN filtering refers to analyzing network traffic on a selected set of VLANs on trunk source ports. By
default, all VLANs are monitored on trunk source ports. You can use the monitor session session_number
filter vlan vlan-id command to limit SPAN traffic on trunk source ports to only the specified VLANs.
VLAN monitoring and VLAN filtering are mutually exclusive. If a VLAN is a source, VLAN filtering cannot
be enabled. If VLAN filtering is configured, a VLAN cannot become a source.
You can verify your settings by entering the show monitor privileged EXEC command. You can display
SPAN, RSPAN, FSPAN, and FRSPAN configuration on the switch by entering the show running-config
privileged EXEC command. SPAN information appears near the end of the output.
Examples
This example shows how to limit SPAN traffic in an existing session only to specific VLANs:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1206
Network Management
monitor session filter
Switch(config)# monitor session 1 filter vlan 100 - 110
This example shows how to create a local SPAN session 1 to monitor both sent and received traffic
on source port 1 on stack member 1 to destination port 2 on stack member 2 and to filter IPv4 traffic
using access list number 122 in an FSPAN session:
Device(config)# monitor session 1 source interface gigabitethernet1/0/1 both
Device(config)# monitor session 1 destination interface gigabitethernet1/0/2
Device(config)# monitor session 1 filter ip access-group 122
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1207
Network Management
monitor session source
monitor session source
To start a new Switched Port Analyzer (SPAN) session or Remote SPAN (RSPAN) source session, or to add
or delete interfaces or VLANs to or from an existing SPAN or RSPAN session, use the monitor session
source global configuration command. To remove the SPAN or RSPAN session or to remove source interfaces
from the SPAN or RSPAN session, use the no form of this command.
monitor session session_number source {interface interface-id [, | -] [both | rx | tx] |
[remote] vlan vlan-id [, | -] [both | rx | tx]}
no monitor session session_number source {interface interface-id [, | -] [both | rx | tx] |
[remote] vlan vlan-id [, | -] [both | rx | tx]}
Syntax Description session_number The session number identified with the SPAN or RSPAN session. The range
is 1 to 66.
interface interface-id Specifies the source interface for a SPAN or RSPAN session. Valid
interfaces are physical ports (including type, stack member, module, and
port number). For source interface, port channel is also a valid interface
type, and the valid range is 1 to 48.
, (Optional) Specifies a series of interfaces or VLANs, or separates a range
of interfaces or VLANs from a previous range. Enter a space before and
after the comma.
- (Optional) Specifies a range of interfaces or VLANs. Enter a space before
and after the hyphen.
both | rx | tx (Optional) Specifies the traffic direction to monitor. If you do not specify
a traffic direction, the source interface sends both transmitted and received
traffic.
remote (Optional) Specifies the remote VLAN for an RSPAN source or destination
session. The range is 2 to 1001 and 1006 to 4094.
The RSPAN VLAN cannot be VLAN 1 (the default VLAN) or VLAN IDs
1002 to 1005 (reserved for Token Ring and FDDI VLANs).
vlan vlan-id When used with only the ingress keyword, sets default VLAN for ingress
traffic.
Command Default No monitor sessions are configured.
On a source interface, the default is to monitor both received and transmitted traffic.
On a trunk interface used as a source port, all VLANs are monitored.
Command Modes Global configuration
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1208
Network Management
monitor session source
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Traffic that enters or leaves source ports or source VLANs can be monitored by using SPAN or RSPAN.
Traffic routed to source ports or source VLANs cannot be monitored.
You can set a combined maximum of two local SPAN sessions and RSPAN source sessions. You can have
a total of 66 SPAN and RSPAN sessions on a switch or switch stack.
A source can be a physical port, a port channel, or a VLAN.
Each session can include multiple ingress or egress source ports or VLANs, but you cannot combine source
ports and source VLANs in a single session. Each session can include multiple destination ports.
When you use VLAN-based SPAN (VSPAN) to analyze network traffic in a VLAN or set of VLANs, all
active ports in the source VLANs become source ports for the SPAN or RSPAN session. Trunk ports are
included as source ports for VSPAN, and only packets with the monitored VLAN ID are sent to the destination
port.
You can monitor traffic on a single port or VLAN or on a series or range of ports or VLANs. You select a
series or range of interfaces or VLANs by using the [, | -] options.
If you specify a series of VLANs or interfaces, you must enter a space before and after the comma. If you
specify a range of VLANs or interfaces, you must enter a space before and after the hyphen (-).
You can monitor individual ports while they participate in an EtherChannel, or you can monitor the entire
EtherChannel bundle by specifying the port-channel number as the RSPAN source interface.
A port used as a destination port cannot be a SPAN or RSPAN source, nor can a port be a destination port for
more than one session at a time.
You can enable IEEE 802.1x authentication on a SPAN or RSPAN source port.
You can verify your settings by entering the show monitor privileged EXEC command. You can display
SPAN, RSPAN, FSPAN, and FRSPAN configuration on the switch by entering the show running-config
privileged EXEC command. SPAN information appears near the end of the output.
Examples
This example shows how to create a local SPAN session 1 to monitor both sent and received traffic
on source port 1 on stack member 1 to destination port 2 on stack member 2:
Switch(config)# monitor session 1 source interface gigabitethernet1/0/1 both
Switch(config)# monitor session 1 destination interface gigabitethernet1/0/2
This example shows how to configure RSPAN source session 1 to monitor multiple source interfaces
and to configure the destination RSPAN VLAN 900.
Switch(config)# monitor session 1 source interface gigabitethernet1/0/1
Switch(config)# monitor session 1 source interface port-channel 2 tx
Switch(config)# monitor session 1 destination remote vlan 900
Switch(config)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1209
Network Management
monitor session type
monitor session type
To configure a local Encapsulated Remote Switched Port Analyzer (ERSPAN) session, use the monitor
session type command in global configuration mode. To remove the ERSPAN configuration, use the no form
of this command.
monitor session span-session-number type {erspan-destination | erspan-source}
no monitor session span-session-number type {erspan-destination | erspan-source}
Syntax Description span-session-number Number of the local ERSPAN session. Valid values are from 1 to 66.
Command Default ERSPAN source or destination session is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.11.1 The erspan-destination keyword was introduced.
Usage Guidelines The span-session-number and the session type cannot be changed once configured. Use the no form of this
command to remove the session and then re-create the session with a new session ID or a new session type.
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 can
configure the same address in both the source and destination sessions with the ip address command in
ERSPAN monitor destination session configuration mode.
A newly configured ERSPAN session will be in the shutdown state by default. The ERSPAN session remains
inactive until the no shutdown command is configured along with other mandatory configurations such as
source interface, ERSPAN ID, ERSPAN IP address, and so on.
The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from different
ERSPAN source sessions.
The maximum local ERSPAN source session limit is 8.
Examples The following example shows how to configure an ERSPAN source session number:
Device(config)# monitor session 55 type erspan-source
Device(config-mon-erspan-src)#
Related Commands Command Description
monitor session type Creates an ERSPAN source or destination session number or enters the
ERSPAN session configuration mode for the session.
show capability feature monitor Displays information about monitor features.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1210
Network Management
monitor session type
Command Description
show monitor session Displays information about the ERSPAN, SPAN, and RSPAN sessions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1211
Network Management
option
option
To configure optional data parameters for a flow exporter for Flexible NetFlow, use the option command in
flow exporter configuration mode. To remove optional data parameters for a flow exporter, use the no form
of this command.
option {exporter-stats | interface-table | sampler-table} [{timeout seconds}]
no option {exporter-stats | interface-table | sampler-table}
Syntax Description exporter-stats Configures the exporter statistics option for flow exporters.
interface-table Configures the interface table option for flow exporters.
sampler-table Configures the export sampler table option for flow exporters.
timeout seconds (Optional) Configures the option resend time in seconds for flow
exporters. The range is 1 to 86400. The default is 600.
Command Default The timeout is 600 seconds. All other optional data parameters are not configured.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The option exporter-stats command causes the periodic sending of the exporter statistics, including the
number of records, bytes, and packets sent. This command allows the collector to estimate packet loss for the
export records it receives. The optional timeout alters the frequency at which the reports are sent.
The option interface-table command causes the periodic sending of an options table, which allows the
collector to map the interface SNMP indexes provided in the flow records to interface names. The optional
timeout can alter the frequency at which the reports are sent.
The option sampler-table command causes the periodic sending of an options table, which details the
configuration of each sampler and allows the collector to map the sampler ID provided in any flow record to
a configuration that it can use to scale up the flow statistics. The optional timeout can alter the frequency at
which the reports are sent.
To return this command to its default settings, use the no option or default option flow exporter configuration
command.
The following example shows how to enable the periodic sending of the sampler option table, which
allows the collector to map the sampler ID to the sampler type and rate:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# option sampler-table
The following example shows how to enable the periodic sending of the exporter statistics, including
the number of records, bytes, and packets sent:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1212
Network Management
option
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# option exporter-stats
The following example shows how to enable the periodic sending of an options table, which allows
the collector to map the interface SNMP indexes provided in the flow records to interface names:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# option interface-table
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1213
Network Management
record
record
To add a flow record for a Flexible NetFlow flow monitor, use the record command in flow monitor
configuration mode. To remove a flow record for a Flexible NetFlow flow monitor, use the no form of this
command.
record record-name
no record
Syntax Description record-name Name of a user-defined flow record that was previously configured.
Command Default A flow record is not configured.
Command Modes Flow monitor configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Each flow monitor requires a record to define the contents and layout of its cache entries. The flow monitor
can use one of the wide range of predefined record formats, or advanced users may create their own record
formats.
Note You must use the no ip flow monitor command to remove a flow monitor from all of the interfaces to which
you have applied it before you can modify the parameters for the record command for the flow monitor.
Examples The following example configures the flow monitor to use FLOW-RECORD-1:
Device(config)# flow monitor FLOW-MONITOR-1
Device(config-flow-monitor)# record FLOW-RECORD-1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1214
Network Management
sensor-name (stealthwatch-cloud-monitor)
sensor-name (stealthwatch-cloud-monitor)
To set the sensor name for the Stealthwatch Cloud registration, use the sensor-name SwC-sensor-name
command in stealthwatch-cloud-monitor configuration mode.
sensor-name SwC-sensor-name
Syntax Description SwC-sensor-name Sensor name in alphanumeric format.
Command Default The device name is configured.
Command Modes stealthwatch-cloud-monitor (stealthwatch-cloud-monitor)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Configure the stealthwatch-cloud-monitor command before setting the sensor name.
Setting the sensor name is optional. If no sensor name is set, by default, the device name is set as the sensor
name.
Examples The following example shows how to set the sensor name:
Device> enable
Device# configure terminal
Device(config)# stealthwatch-cloud-monitor
Device(config-stealthwatch-cloud-monitor)# service-key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Device(config-stealthwatch-cloud-monitor)# sensor-name mysensor
Related Commands Command Description
service-key SwC-service-key Configures the Stealthwatch Cloud service key.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
url SwC-server-url Configures the Stealthwatch Cloud server URL.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1215
Network Management
service-key (stealthwatch-cloud-monitor)
service-key (stealthwatch-cloud-monitor)
To configure the Stealthwatch Cloud service key, use the service-key SwC-service-key command in
stealthwatch-cloud-monitor configuration mode.
service-key SwC-service-key
Syntax Description SwC-service-key Stealthwatch Cloud service key
Command Modes stealthwatch-cloud-monitor (stealthwatch-cloud-monitor)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Configure the stealthwatch-cloud-monitor command before configuring the Stealthwatch Cloud service
key.
You can view the service key from the Stealthwatch Cloud portal. See Configuring Stealthwatch Cloud on a
Device section on the configuration guide for additional information.
Note A service key can be configured for multiple sensors.
Examples The following example shows how to configure a Stealthwatch Cloud service key:
Device> enable
Device# configure terminal
Device(config)# stealthwatch-cloud-monitor
Device(config-stealthwatch-cloud-monitor)# service-key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Related Commands Command Description
sensor-name SwC-sensor-name Sets the sensor name for the Stealthwatch Cloud
registration.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
url SwC-server-url Configures the Stealthwatch Cloud server URL.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1216
Network Management
show flow monitor etta-mon cache
show flow monitor etta-mon cache
To display ETA monitor cache details, use the show flow monitor etta-mon cache command in privileged
EXEC mode.
show flow monitor etta-mon cache
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to display ETA flow monitor cache details:
Device>enable
Device#configure terminal
Device# show flow monitor etta-mon cache
Cache type: Normal (Platform cache)
Cache size: 10000
Current entries: 4
Flows added: 6
Flows aged: 2
- Inactive timeout ( 15 secs) 2
IPV4 DESTINATION ADDRESS: 15.15.15.35
IPV4 SOURCE ADDRESS: 72.163.128.140
IP PROTOCOL: 17
TRNS SOURCE PORT: 53
TRNS DESTINATION PORT: 12032
counter bytes long: 128
counter packets long: 1
timestamp abs first: 06:23:24.799
timestamp abs last: 06:23:24.799
interface input: Null
interface output: Null
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1217
Network Management
sampler
sampler
To create a Flexible Netflow flow sampler, or to modify an existing Flexible Netflow flow sampler, and to
enter Flexible Netflow sampler configuration mode, use the sampler command in global configuration mode.
To remove a sampler, use the no form of this command.
sampler sampler-name
no sampler sampler-name
Syntax Description sampler-name Name of the flow sampler that is being created or modified.
Command Default Flexible Netflow flow samplers are not configured.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Flow samplers are used to reduce the load placed by Flexible Netflow on the networking device to monitor
traffic by limiting the number of packets that are analyzed. You configure a rate of sampling that is 1 out of
a range of packets. Flow samplers are applied to interfaces in conjunction with a flow monitor to implement
sampled Flexible Netflow.
To enable flow sampling, you configure the record that you want to use for traffic analysis and assign it to a
flow monitor. When you apply a flow monitor with a sampler to an interface, the sampled packets are analyzed
at the rate specified by the sampler and compared with the flow record associated with the flow monitor. If
the analyzed packets meet the criteria specified by the flow record, they are added to the flow monitor cache.
Examples The following example creates a flow sampler name SAMPLER-1:
Device(config)# sampler SAMPLER-1
Device(config-sampler)#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1218
Network Management
show capability feature monitor
show capability feature monitor
To display information about monitor features, use the show capability feature monitor command in privileged
EXEC mode.
show capability feature monitor {erspan-destination | erspan-source}
Syntax Description erspan-destination Displays information about the configured Encapsulated Remote Switched Port
Analyzer (ERSPAN) source sessions.
erspan-source Displays all the configured global built-in templates.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following is sample output from the show capability feature monitor erspan-source command:
Switch# show capability feature monitor erspan-source
ERSPAN Source Session Supported: true
No of Rx ERSPAN source session: 8
No of Tx ERSPAN source session: 8
ERSPAN Header Type supported: II
ACL filter Supported: true
Fragmentation Supported: true
Truncation Supported: false
Sequence number Supported: false
QOS Supported: true
The following is sample output from the show capability feature monitor erspan-destination
command:
Switch# show capability feature monitor erspan-destination
ERSPAN Destination Session Supported: false
Related Commands Command Description
monitor session type erspan-source Creates an ERSPAN source session number or enters the ERSPAN
session configuration mode for the session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1219
Network Management
show class-map type control subscriber
show class-map type control subscriber
To display the class map statistics for the configured control policies, use the show class-map type control
subscriber command in privileged EXEC mode.
show class-map type control subscriber {all|name control-class-name}
Syntax Description all Displays class map statistics for all
control policies.
name control-class-name Displays class map statistics for the
specified control policy.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following is a sample output of the show class-map type control subscriber name
control-class-name command:
Device# show class-map type control subscriber name platform
Class-map Action Exec Hit Miss Comp
--------- ------ ---- --- ---- ----
match-all platform match platform-type C9xxx 0 0 0 0
Key:
"Exec" - The number of times this line was executed
"Hit" - The number of times this line evaluated to TRUE
"Miss" - The number of times this line evaluated to FALSE
"Comp" - The number of times this line completed the execution of its
condition without a need to continue on to the end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1220
Network Management
show flow exporter
show flow exporter
To display flow exporter status and statistics, use the show flow exporter command in privileged EXEC
mode.
show flow exporter [{export-ids netflow-v9 | [name] exporter-name [{statistics | templates}] | statistics
| templates}]
Syntax Description export-ids netflow-v9 (Optional) Displays the NetFlow Version 9 export fields that can be exported and
their IDs.
name (Optional) Specifies the name of a flow exporter.
exporter-name (Optional) Name of a flow exporter that was previously configured.
statistics (Optional) Displays statistics for all flow exporters or for the specified flow exporter.
templates (Optional) Displays template information for all flow exporters or for the specified
flow exporter.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following example displays the status and statistics for all of the flow exporters configured on
a device:
Device# show flow exporter
Flow Exporter FLOW-EXPORTER-1:
Description: Exports to the datacenter
Export protocol: NetFlow Version 9
Transport Configuration:
Destination IP address: 192.168.0.1
Source IP address: 192.168.0.2
Transport Protocol: UDP
Destination Port: 9995
Source Port: 55864
DSCP: 0x0
TTL: 255
Output Features: Used
This table describes the significant fields shown in the display:
Table 136: show flow exporter Field Descriptions
Field Description
Flow Exporter The name of the flow exporter that you configured.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1221
Network Management
show flow exporter
Field Description
Description The description that you configured for the exporter,
or the default description User defined.
Transport Configuration The transport configuration fields for this exporter.
Destination IP address The IP address of the destination host.
Source IP address The source IP address used by the exported packets.
Transport Protocol The transport layer protocol used by the exported
packets.
Destination Port The destination UDP port to which the exported
packets are sent.
Source Port The source UDP port from which the exported packets
are sent.
DSCP The differentiated services code point (DSCP) value.
TTL The time-to-live value.
Output Features Specifies whether the output-features command,
which causes the output features to be run on Flexible
NetFlow export packets, has been used or not.
The following example displays the status and statistics for all of the flow exporters configured on
a device:
Device# show flow exporter name FLOW-EXPORTER-1 statistics
Flow Exporter FLOW-EXPORTER-1:
Packet send statistics (last cleared 2w6d ago):
Successfully sent: 0 (0 bytes)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1222
Network Management
show flow interface
show flow interface
To display the Flexible Netflow configuration and status for an interface, use the show flow interface command
in privileged EXEC mode.
show flow interface [type number]
Syntax Description type (Optional) The type of interface on which you want to display Flexible Netflow accounting
configuration information.
number (Optional) The number of the interface on which you want to display Flexible Netflow accounting
configuration information.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example displays the Flexible Netflow accounting configuration on Ethernet interfaces
0/0 and 0/1:
Device# show flow interface gigabitethernet1/0/1
Interface Ethernet1/0
monitor: FLOW-MONITOR-1
direction: Output
traffic(ip): on
Device# show flow interface gigabitethernet1/0/2
Interface Ethernet0/0
monitor: FLOW-MONITOR-1
direction: Input
traffic(ip): sampler SAMPLER-2#
The table below describes the significant fields shown in the display.
Table 137: show flow interface Field Descriptions
Field Description
Interface The interface to which the information applies.
monitor The name of the flow monitor that is configured on the interface.
direction: The direction of traffic that is being monitored by the flow monitor.
The possible values are:
• Input—Traffic is being received by the interface.
• Output—Traffic is being transmitted by the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1223
Network Management
show flow interface
Field Description
traffic(ip) Indicates if the flow monitor is in normal mode or sampler mode.
The possible values are:
• on—The flow monitor is in normal mode.
• sampler—The flow monitor is in sampler mode (the name of the sampler will be included
in the display).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1224
Network Management
show flow monitor
show flow monitor
To display the status and statistics for a Flexible NetFlow flow monitor, use the show flow monitor command
in privileged EXEC mode.
Syntax Description name (Optional) Specifies the name of a flow monitor.
monitor-name (Optional) Name of a flow monitor that was previously configured.
cache (Optional) Displays the contents of the cache for the flow monitor.
format (Optional) Specifies the use of one of the format options for formatting the display output.
csv (Optional) Displays the flow monitor cache contents in comma-separated variables (CSV)
format.
record (Optional) Displays the flow monitor cache contents in record format.
table (Optional) Displays the flow monitor cache contents in table format.
statistics (Optional) Displays the statistics for the flow monitor.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The cache keyword uses the record format by default.
The uppercase field names in the display output of the show flowmonitor monitor-name cache command
are key fields that Flexible netFlow uses to differentiate flows. The lowercase field names in the display output
of the show flow monitor monitor-name cache command are nonkey fields from which Flexible NetFlow
collects values as additional data for the cache.
Examples The following example displays the status for a flow monitor:
Device# show flow monitor FLOW-MONITOR-1
Flow Monitor FLOW-MONITOR-1:
Description: Used for basic traffic analysis
Flow Record: flow-record-1
Flow Exporter: flow-exporter-1
flow-exporter-2
Cache:
Type: normal
Status: allocated
Size: 4096 entries / 311316 bytes
Inactive Timeout: 15 secs
Active Timeout: 1800 secs
This table describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1225
Network Management
show flow monitor
Table 138: show flow monitor monitor-name Field Descriptions
Field Description
Flow Monitor Name of the flow monitor that you configured.
Description Description that you configured or the monitor, or the default description User defined.
Flow Record Flow record assigned to the flow monitor.
Flow Exporter Exporters that are assigned to the flow monitor.
Cache Information about the cache for the flow monitor.
Type Flow monitor cache type. The value is always normal, as it is the only supported cache
type.
Status Status of the flow monitor cache.
The possible values are:
• allocated—The cache is allocated.
• being deleted—The cache is being deleted.
• not allocated—The cache is not allocated.
Size Current cache size.
Inactive Timeout Current value for the inactive timeout in seconds.
Active Timeout Current value for the active timeout in seconds.
The following example displays the status, statistics, and data for the flow monitor named
FLOW-MONITOR-1:
This table describes the significant fields shown in the display.
The following example displays the status, statistics, and data for the flow monitor named
FLOW-MONITOR-1 in a table format:
The following example displays the status, statistics, and data for the flow monitor named
FLOW-MONITOR-IPv6 (the cache contains IPv6 data) in record format:
The following example displays the status and statistics for a flow monitor:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1226
Network Management
show flow record
show flow record
To display the status and statistics for a Flexible Netflow flow record, use the show flow record command
in privileged EXEC mode.
show flow record [{[name] record-name}]
Syntax Description name (Optional) Specifies the name of a flow record.
record-name (Optional) Name of a user-defined flow record that was previously configured.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
The following example displays the status and statistics for FLOW-RECORD-1:
Device# show flow record FLOW-RECORD-1
flow record FLOW-RECORD-1:
Description: User defined
No. of users: 0
Total field space: 24 bytes
Fields:
match ipv6 destination address
match transport source-port
collect interface input
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1227
Network Management
show ip sla statistics
show ip sla statistics
To display current or aggregated operational status and statistics of all Cisco IOS IP Service Level Agreement
(SLA) operations or a specified operation, use the show ip sla statistics command in user EXEC or privileged
EXEC mode.
show ip sla statistics [ operation-number [details] | aggregated [ operation-number | details]
| details]
Syntax Description operation-number (Optional) Number of the operation for which operational status and
statistics are displayed. Accepted values are from 1 to 2147483647.
details (Optional) Specifies detailed output.
aggregated (Optional) Specifies the IP SLA aggregated statistics.
Command Default Displays output for all running IP SLA operations.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show ip sla statistics to display the current state of IP SLA operations, including how much life the
operation has left, whether the operation is active, and the completion time. The output also includes the
monitoring data returned for the last (most recently completed) operation. This generated operation ID is
displayed when you use the show ip sla configuration command for the base multicast operation, and as part
of the summary statistics for the entire operation.
Enter the show command for a specific operation ID to display details for that one responder.
Examples
The following is sample output from the show ip sla statistics command:
Device# show ip sla statistics
Current Operational State
Entry Number: 3
Modification Time: *22:15:43.000 UTC Sun Feb 11 2001
Diagnostics Text:
Last Time this Entry was Reset: Never
Number of Octets in use by this Entry: 1332
Number of Operations Attempted: 2
Current Seconds Left in Life: 3511
Operational State of Entry: active
Latest Completion Time (milliseconds): 544
Latest Operation Start Time: *22:16:43.000 UTC Sun Feb 11 2001
Latest Oper Sense: ok
Latest Sense Description: 200 OK
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1228
Network Management
show ip sla statistics
Total RTT: 544
DNS RTT: 12
TCP Connection RTT: 28
HTTP Transaction RTT: 504
HTTP Message Size: 9707
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1229
Network Management
show monitor
show monitor
To display information about all Switched Port Analyzer (SPAN) and Remote SPAN (RSPAN) sessions, use
the show monitor command in EXEC mode.
show monitor [session {session_number | all | local | range list | remote} [detail]]
Syntax Description session (Optional) Displays information about specified SPAN
sessions.
session_number The session number identified with the SPAN or RSPAN
session. The range is 1 to 66.
all (Optional) Displays all SPAN sessions.
local (Optional) Displays only local SPAN sessions.
range list (Optional) Displays a range of SPAN sessions, where list is
the range of valid sessions. The range is either a single
session or a range of sessions described by two numbers,
the lower one first, separated by a hyphen. Do not enter any
spaces between comma-separated parameters or in
hyphen-specified ranges.
Note This keyword is available only in privileged
EXEC mode.
remote (Optional) Displays only remote SPAN sessions.
detail (Optional) Displays detailed information about the specified
sessions.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The output is the same for the show monitor command and the show monitor session all command.
Maximum number of SPAN source sessions: 2 (applies to source and local sessions)
Examples
This is an example of output for the show monitor user EXEC command:
Device# show monitor
Session 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1230
Network Management
show monitor
---------
Type : Local Session
Source Ports :
RX Only : Gi4/0/1
Both : Gi4/0/2-3,Gi4/0/5-6
Destination Ports : Gi4/0/20
Encapsulation : Replicate
Ingress : Disabled
Session 2
---------
Type : Remote Source Session
Source VLANs :
TX Only : 10
Both : 1-9
Dest RSPAN VLAN : 105
This is an example of output for the show monitor user EXEC command for local SPAN source
session 1:
Device# show monitor session 1
Session 1
---------
Type : Local Session
Source Ports :
RX Only : Gi4/0/1
Both : Gi4/0/2-3,Gi4/0/5-6
Destination Ports : Gi4/0/20
Encapsulation : Replicate
Ingress : Disabled
This is an example of output for the show monitor session all user EXEC command when ingress
traffic forwarding is enabled:
Device# show monitor session all
Session 1
---------
Type : Local Session
Source Ports :
Both : Gi4/0/2
Destination Ports : Gi4/0/3
Encapsulation : Native
Ingress : Enabled, default VLAN = 5
Ingress encap : DOT1Q
Session 2
---------
Type : Local Session
Source Ports :
Both : Gi4/0/8
Destination Ports : Gi4/012
Encapsulation : Replicate
Ingress : Enabled, default VLAN = 4
Ingress encap : Untagged
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1231
Network Management
show monitor capture
show monitor capture
To display monitor capture (WireShark) content, use the show monitor capture command in privileged
EXEC mode.
show monitor capture [capture-name [ buffer ] | file file-location : file-name ][ brief |
detailed | display-filter display-filter-string ]
Syntax Description capture-name (Optional) Specifies the name of the capture to be displayed.
buffer (Optional) Specifies that a buffer associated with the named capture is
to be displayed.
file file-location : file-name (Optional) Specifies the file location and name of the capture storage
file to be displayed.
brief (Optional) Specifies the display content in brief.
detailed (Optional) Specifies detailed display content.
display-filter display-filter-string Filters the display content according to the display-filter-string.
Command Default Displays all capture content.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Example
The following is sample output from the show monitor capture command:
Device# show monitor capture mycap
Status Information for Capture mycap
Target Type:
Interface: CAPWAP,
Ingress:
0
Egress:
0
Status : Active
Filter Details:
Capture all packets
Buffer Details:
Buffer Type: LINEAR (default)
File Details:
Associated file name: flash:mycap.pcap
Size of buffer(in MB): 1
Limit Details:
Number of Packets to capture: 0 (no limit)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1232
Network Management
show monitor capture
Packet Capture duration: 0 (no limit)
Packet Size to capture: 0 (no limit)
Packets per second: 0 (no limit)
Packet sampling rate: 0 (no sampling)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1233
Network Management
show monitor session
show monitor session
To display information about Switched Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated
Remote Switched Port Analyzer (ERSPAN) sessions, use the show monitor session command in EXEC
mode.
show monitor session {session_number | all | erspan-destination | erspan-source | local |
range list | remote} [detail]
Syntax Description session_number The session number identified with th
all Displays all SPAN sessions.
erspan-source Displays only source ERSPAN session
erspan-destination Displays only destination ERSPAN se
local Displays only local SPAN sessions.
range list Displays a range of SPAN sessions, w
of sessions described by two numbers
comma-separated parameters or in hyp
Note This keyword is available
remote Displays only remote SPAN sessions.
detail (Optional) Displays detailed informati
Command Modes User EXEC (>)
Privileged EXEC(#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.11.1 The erspan-destination keyword was introduced.
Usage Guidelines The maximum local ERSPAN source session limit is 8.
Examples
The following is sample output from the show monitor session command for local SPAN source
session 1:
Device# show monitor session 1
Session 1
---------
Type : Local Session
Source Ports :
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1234
Network Management
show monitor session
RX Only : Gi4/0/1
Both : Gi4/0/2-3,Gi4/0/5-6
Destination Ports : Gi4/0/20
Encapsulation : Replicate
Ingress : Disabled
The following is sample output from the show monitor session all command when ingress traffic
forwarding is enabled:
Device# show monitor session all
Session 1
---------
Type : Local Session
Source Ports :
Both : Gi4/0/2
Destination Ports : Gi4/0/3
Encapsulation : Native
Ingress : Enabled, default VLAN = 5
Ingress encap : DOT1Q
Session 2
---------
Type : Local Session
Source Ports :
Both : Gi4/0/8
Destination Ports : Gi4/012
Encapsulation : Replicate
Ingress : Enabled, default VLAN = 4
Ingress encap : Untagged
The following is sample output from the show monitor session erspan-source command:
Device# show monitor session erspan-source
Type : ERSPAN Source Session
Status : Admin Enabled
Source Ports :
RX Only : Gi1/4/33
Destination IP Address : 20.20.163.20
Destination ERSPAN ID : 110
Origin IP Address : 10.10.10.216
IPv6 Flow Label : None
The following is sample output from the show monitor session erspan-destination command:
Device# show monitor session erspan-destination
Type : ERSPAN Destination Session
Status : Admin Enabled
Source IP Address : 10.10.10.210
Source ERSPAN ID : 40
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1235
Network Management
show parameter-map type subscriber attribute-to-service
show parameter-map type subscriber attribute-to-service
To display parameter map statistics, use the show parameter-map type subscriber attribute-to-service
command in privileged EXEC mode.
show parameter-map type subscriber attribute-to-service {all|name parameter-map-name}
Syntax Description all Displays statistics for all parameter
maps.
name parameter-map-name Displays statistics for the specified
parameter map.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Examples The following is a sample output of the show parameter-map type subscriber attribute-to-service
name parameter-map-name command:
Device# show parameter-map type subscriber attribute-to-service name platform
Parameter-map name: platform
Map: 10 platform-type regex "C9xxx"
Action(s):
10 interface-template critical
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1236
Network Management
show platform software et-analytics
show platform software et-analytics
To display et-analytics configuration, use the show platform software et-analytics command in privileged
EXEC mode.
show platform software et-analytics {global | interfaces}
Syntax Description global Displays global et-analytics configuration.
interfaces Displays interface et-analytics configuration.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to display global et-analytics configuration:
Device>enable
Device#configure terminal
Device# show platform software et-analytics global
ET-Analytics Global state
=========================
All Interfaces : Off
IP Flow-record Destination: 10.126.71.20 : 2055
Inactive timer: 0
ET-Analytics interfaces
GigabitEthernet1/0/3
The following example shows how to display global et-analytics configuration:
Device>enable
Device#configure terminal
Device# show platform software et-analytics interfaces
ET-Analytics interfaces
GigabitEthernet1/0/3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1237
Network Management
show platform software fed switch active fnf et-analytics-flow-dump
show platform software fed switch active fnf
et-analytics-flow-dump
To display interface et-analytics flow dump, use the show platform software fed switch active fnf
et-analytics-flow-dump command in privileged EXEC mode.
show platform software fed switch active fnf et-analytics-flow-dump
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Example:
The following example shows how to display interface et-analytics flow dump.:
Device>enable
Device#configure terminal
Device# show platform software fed switch active fnf et-analytics-flow-dump
ET Analytics Flow dump
=================
Total packets received (27)
Excess packets received (0)
(Index:0) 72.163.128.140, 15.15.15.35, protocol=17, source port=53, dest port=12032, flow
done=u
SPLT: len = 2, value = (25600,0)(128,0)
IDP: len = 128, value = 45:0:0:80:f0:6c:0:0:f9:11:
(Index:1) 72.163.128.140, 15.15.15.35, protocol=17, source port=53, dest port=32356, flow
done=u
SPLT: len = 2, value = (59649,0)(128,0)
IDP: len = 517, value = 45:0:2:5:c3:1:0:0:f9:11:
(Index:2) 15.15.15.35, 72.163.128.140, protocol=17, source port=12032, dest port=53, flow
done=u
SPLT: len = 2, value = (10496,0)(128,0)
IDP: len = 69, value = 45:0:0:45:62:ae:40:0:40:11:
(Index:3) 15.15.15.35, 72.163.128.140, protocol=17, source port=32356, dest port=53, flow
done=u
SPLT: len = 2, value = (10496,0)(128,0)
IDP: len = 69, value = 45:0:0:45:62:ad:40:0:40:11:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1238
Network Management
show platform software fed switch ip wccp
show platform software fed switch ip wccp
To display platform-dependent Web Cache Communication Protocol (WCCP) information, use the show
platform software fed switch ip wccp privileged EXEC command.
show platform software fed switch{switch-number | active | standby}ip
wccp{cache-engines | interfaces | service-groups}
Syntax Description switch{switch_num|active|standby} The device for which you want to display information.
• switch_num—Enter the switch ID. Displays information for the
specified switch.
• active—Displays information for the active switch.
• standby—Displays information for the standby switch, if
available.
cache-engines Displays WCCP cache engines.
interfaces Displays WCCP interfaces.
service-groups Displays WCCP service groups.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command only when you are working directly with a technical support representative while
troubleshooting a problem. Do not use this command unless a technical support representative asks you to do
so.
This command is available only if your device is running the IP Services feature set.
The following example displays WCCP interfaces:
Device# show platform software fed switch 1 ip wccp interfaces
WCCP Interface Info
=====================
**** WCCP Interface: Port-channel13 iif_id: 000000000000007c (#SG:3), VRF: 0 Ingress WCCP
****
port_handle:0x20000f9
List of Service Groups on this interface:
* Service group id:90 vrf_id:0 (ref count:24)
type: Dynamic Open service prot: PROT_TCP l4_type: Dest ports priority: 35
Promiscuous mode (no ports).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1239
Network Management
show platform software fed switch ip wccp
* Service group id:70 vrf_id:0 (ref count:24)
type: Dynamic Open service prot: PROT_TCP l4_type: Dest ports priority: 35
Promiscuous mode (no ports).
* Service group id:60 vrf_id:0 (ref count:24)
type: Dynamic Open service prot: PROT_TCP l4_type: Dest ports priority: 35
Promiscuous mode (no ports).
**** WCCP Interface: Port-channel14 iif_id: 000000000000007e (#SG:3), VRF: 0 Ingress WCCP
****
port_handle:0x880000fa
List of Service Groups on this interface:
* Service group id:90 vrf_id:0 (ref count:24)
type: Dynamic Open service prot: PROT_TCP l4_type: Dest ports priority: 35
Promiscuous mode (no ports).
* Service group id:70 vrf_id:0 (ref count:24)
type: Dynamic Open service prot: PROT_TCP l4_type: Dest ports priority: 35
Promiscuous mode (no ports).
<output truncated>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1240
Network Management
show platform software fed switch swc connection
show platform software fed switch swc connection
To display the connection details and events of the Stealthwatch Cloud integration, use the show platform
software fed switch switch-number swc connection command in privileged EXEC mode.
show platform software fed switch { switch-number | active } swc connection
Syntax Description switch {switch-number | active } Displays switch information.
• switch_num: Switch ID.
• active : Displays information for the active
switch.
swc connection Displays the connection details and events.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show platform software fed switch active swc connection
command:
Device> enable
Device# show platform software fed switch active swc connection
Stealthwatch-Cloud details
Registration
#ID : 0xc000001
URL : https://sensor.ext.obsrvbl.com
Service Key : XXXXXXXXXXXXXXXXXXXXXXXX
Sensor Name : C9200
Registered : N/A
Connection
Status : DOWN
<<— Status will be in UP state only when the flow uploads into the Stealthwatch Cloud.
Last status update : 02/09/2021 10:10:47
# Flaps : 0
# Heartbeats : 0
# Lost heartbeats : 0
Total RX bytes : 7360
Total TX bytes : 869
Upload Speed (B/s) : 127
Download Speed (B/s) : 58
# Open sessions : 0
# Redirections : 0
# Timeouts : 0
HTTP Events
GET response : 4
GET request : 4
GET Status Code 2XX : 4
PUT response : 12
PUT request : 12
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1241
Network Management
show platform software fed switch swc connection
PUT Status Code 2XX : 2
POST response : 2
POST request : 2
POST Status Code 2XX : 2
API Events
TX : 4
OK : 2
Error : 2
Event History
Timestamp #Times Event RC Context
----------------------- -------- ------------------- --
----------------------------------------
02/10/2021 09:29:41.126 2 SEND_OK 0 ID:0003
02/10/2021 09:29:39.795 2 SIGNAL_DATA 0 ID:0003
02/10/2021 09:29:38.279 12 PUT_DATA 0 ID:0003
02/10/2021 09:29:37.962 4 GET_URL 0 ID:0003
02/10/2021 09:29:37.961 4 SEND_START 0 ID:0003
02/10/2021 09:27:41.484 2 SEND_ERR 0 ID:0001
02/10/2021 09:27:41.484 2 MAX_ATTEMPTS 0 ID:0001
02/10/2021 09:22:53.670 4 REGISTER_OK 0 Not applicable
02/10/2021 09:22:53.670 4 SEND_ABORT_ALL 0 config change
02/10/2021 09:22:53.670 1 OPTIONS_CONFIG 0 File Extension: .csv.gz (reset)
02/10/2021 09:22:53.669 1 OPTIONS_CONFIG 0 Data Type: ios-xe-catalyst
02/10/2021 09:22:53.669 1 OPTIONS_CONFIG 0 URL: https://sensor.ext.obsrvbl.com
(res
02/10/2021 09:22:53.668 1 OPTIONS_CONFIG 0 Sensor Name: niinamdaUS (reset)
02/10/2021 09:22:53.553 1 OPTIONS_CONFIG 0 Service Key:
b5tQtXJM8AGZSp6oB8PvK4H0FiW
Related Commands Command Description
clear platform software fed switch {switch-number Clears the connection details and events of the
|active }swc connection Stealthwatch Cloud integration.
show platform software fed switch {switch-number Displays the statistical information of the Stealthwatch
|active }swc statistics Cloud integration.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1242
Network Management
show platform software fed switch swc statistics
show platform software fed switch swc statistics
To display the statistical information of the Stealthwatch Cloud integration, use the show platform software
fed switch switch-number swc statistics command in privileged EXEC mode.
show platform software fed switch { switch-number | active } swc statistics
Syntax Description switch {switch-number | active } Displays switch information.
• switch_num: Switch ID.
• active: Displays information for the active
switch.
swc statistics Displays the statistical information.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show platform software fed switch active swc statistics
command:
Device> enable
Device# show platform software fed switch active swc statistics
==========================
SWC Upload Statistics:
==========================
1: Last file uploaded : 202102100928_1
2: Time of upload : 02/10/21 09:29:41 UTC
3: Current file uploading :
4: Files queued for upload :
5: Number of files queued : 0
6: Last failed upload :
7: Files failed to upload : 0
8: Files successfully uploaded : 1
==========================
SWC File Creation Statistics:
==========================
9: Last file created : 202102100929_1
10: Time of creation : 02/10/21 09:29:08 UTC
==========================
SWC Flow Statistics:
==========================
11: Number of flows in prev file: 15
12: Number of flows in curr file: 11
13: Invalid dropped flows : 0
14: Error dropped flows : 0
==========================
SWC Flags:
==========================
15: Is Registered : Registered
16: Delete debug : Disabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1243
Network Management
show platform software fed switch swc statistics
17: Exporter delete debug : Disabled
18: Certificate Validation : Enabled
Related Commands Command Description
clear platform software fed switch {switch-number Clears the statistical information of the Stealthwatch
|active }swc statistics Cloud integration.
show platform software fed switch {switch-number Displays the connection details and events of the
|active }swc connection Stealthwatch Cloud integration.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1244
Network Management
show platform software swspan
show platform software swspan
To display switched port analyzer (SPAN) information, use the show platform software swspan command
in privileged EXEC mode.
show platform software swspan {switch} {{{F0 | FP active} counters} | R0 | RP active} {destination
sess-id session-ID | source sess-id session-ID}
Syntax Description switch Displays information about the switch.
F0 Displays information about the Embedded Service Processor (ESP) slot 0.
FP Displays information about the ESP.
active Displays information about the active instance of the ESP or the Route
Processor (RP).
counters Displays the SWSPAN message counters.
R0 Displays information about the RP slot 0.
RP Displays information the RP.
destination sess-id session-ID Displays information about the specified destination session.
source sess-id session-ID Displays information about the specified source session.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced in a release prior to Cisco IOS XE Denali
16.5.1a 16.1.1.
Usage Guidelines If the session number does not exist or if the SPAN session is a remote destination session, the command
output will display the following message "% Error: No Information Available."
Examples The following is sample output from the show platform software swspan FP active source
command:
Switch# show platform software swspan FP active source sess-id 0
Showing SPAN source detail info
Session ID : 0
Intf Type : PORT
Port dpidx : 30
PD Sess ID : 1
Session Type : Local
Direction : Ingress
Filter Enabled : No
ACL Configured : No
AOM Object id : 579
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1245
Network Management
show platform software swspan
AOM Object Status : Done
Parent AOM object Id : 118
Parent AOM object Status : Done
Session ID : 9
Intf Type : PORT
Port dpidx : 8
PD Sess ID : 0
Session Type : Local
Direction : Ingress
Filter Enabled : No
ACL Configured : No
AOM Object id : 578
AOM Object Status : Done
Parent AOM object Id : 70
Parent AOM object Status : Done
The following is sample output from the show platform software swspan RP active destination
command:
Switch# show platform software swspan RP active destination
Showing SPAN destination table summary info
Sess-id IF-type IF-id Sess-type
--------------------------------------
1 PORT 19 Remote
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1246
Network Management
show sampler
show sampler
To display the status and statistics for a Flexible NetFlow sampler, use the show sampler command in
privileged EXEC mode.
show sampler [{[name] sampler-name}]
Syntax Description name (Optional) Specifies the name of a sampler.
sampler-name (Optional) Name of a sampler that was previously configured.
Command Default None
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
The following example displays the status and statistics for all of the flow samplers configured:
Device# show sampler
Sampler SAMPLER-1:
ID: 2083940135
export ID: 0
Description: User defined
Type: Invalid (not in use)
Rate: 1 out of 32
Samples: 0
Requests: 0
Users (0):
Sampler SAMPLER-2:
ID: 3800923489
export ID: 1
Description: User defined
Type: random
Rate: 1 out of 100
Samples: 1
Requests: 124
Users (1):
flow monitor FLOW-MONITOR-1 (datalink,vlan1) 0 out of 0
This table describes the significant fields shown in the display.
Table 139: show sampler Field Descriptions
Field Description
ID ID number of the flow sampler.
Export ID ID of the flow sampler export.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1247
Network Management
show sampler
Field Description
Description Description that you configured for the flow sampler,
or the default description User defined.
Type Sampling mode that you configured for the flow
sampler.
Rate Window size (for packet selection) that you
configured for the flow sampler. The range is 2 to
32768.
Samples Number of packets sampled since the flow sampler
was configured or the device was restarted. This is
equivalent to the number of times a positive response
was received when the sampler was queried to
determine if the traffic needed to be sampled. See the
explanation of the Requests field in this table.
Requests Number of times the flow sampler was queried to
determine if the traffic needed to be sampled.
Users Interfaces on which the flow sampler is configured.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1248
Network Management
show snmp stats
show snmp stats
To display the SNMP statistics, use the show snmp stats command in privileged EXEC mode.
show snmp stats { hosts | oid}
Syntax Description hosts Displays the details of the SNMP servers polled to the SNMP agent.
oid Displays recently requested object identifiers (OIDs).
Command Default Displays the SNMP manager entries polled to the SNMP agent.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was
introduced.
Usage Guidelines Use the show snmp stats hosts command to list the NMS IP address, the number of times an NMS polls the
agent, and the timestamp of polling. To delete the entries polled to the SNMP agent, use the clear snmp stats
hosts command.
Before running the show snmp stats oid command, connect the device to the NMS. The command output
displays the list of OIDs recently requested by the NMS. It also displays the number of times an object identifier
is requested by the NMS. This information is useful for troubleshooting memory leaks and network failures
when little information is available about the MIBs that the NMS is querying. You can use the show snmp
stats oid command at any time to view OIDs recently requested by the NMS.
The following is sample output of the show snmp stats hosts command.
Device# show snmp stats hosts
Request Count Last Timestamp Address
2 00:00:01 ago 3.3.3.3
1 1w2d ago 2.2.2.2
The table below describes the significant fields shown in the display:
Table 140: show snmp stats hosts Field Descriptions
Field Description
Request Count Displays the number of times an SNMP Manager has sent requests to the SNMP Agent.
Last Displays the time at which the request was sent to the SNMP Agent by the SNMP Manager.
Timestamp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1249
Network Management
show snmp stats
Field Description
Address Displays the IP Address of the SNMP Manager that has sent the request.
The following is sample output of the show snmp stats oid command.
Device# show snmp stats oid
time-stamp #of times requested OID
15:30:01 UTC Dec 2 2019 6 ifPhysAddress
15:30:01 UTC Dec 2 2019 10 system.2
15:30:01 UTC Dec 2 2019 9 system.1
09:39:39 UTC Nov 26 2019 3 system.5
09:39:39 UTC Nov 26 2019 3 stem.4
09:39:39 UTC Nov 26 2019 3 system.7
09:39:39 UTC Nov 26 2019 2 system.6
09:39:39 UTC Nov 26 2019 10 ceemEventMapEntry.2
09:39:39 UTC Nov 26 2019 6 ipAddrEntry.4
09:39:39 UTC Nov 26 2019 3 ipAddrEntry.5
09:39:39 UTC Nov 26 2019 10 ipAddrEntry.3
09:39:39 UTC Nov 26 2019 7 ipAddrEntry.2
09:39:39 UTC Nov 26 2019 4 ipAddrEntry.1
09:39:39 UTC Nov 26 2019 1 lsystem.3
The table below describes the significant fields shown in the display.
Table 141: show snmp stats oid Field Descriptions
Field Description
time-stamp Displays the time and date when the object identifiers is requested by the NMS.
#of times Displays the number of times an object identifier is requested.
requested
OID Displays the object identifiers recently requested by the NMS.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1250
Network Management
show stealth-watch-cloud detail
show stealth-watch-cloud detail
To display the status of the Stealthwatch Cloud registration details, use the show stealth-watch-cloud detail
command in privileged EXEC mode.
show stealth-watch-cloud detail
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Examples The following is a sample output of the show stealth-watch-cloud detail command:
Device> enable
Device# show stealth-watch-cloud detail
========================================
Stealthwatch Cloud Parameters
========================================
Service Key : XXXXXXXXXXXXXXXXXXXXXXXX
Sensor Name : C9200
URL : https://sensor.eu-prod.obsrvbl.com
========================================
Stealthwatch Cloud Sensor Info
========================================
Sensor Status : Registered
Last heartbeat : 2020-08-21T10:35:16
Related Commands Command Description
show platform software fed switch {switch-number Displays the connection details and events of the
|active }swc connection Stealthwatch Cloud integration.
show platform software fed switch {switch-number Displays the statistics of the Stealthwatch Cloud
|active }swc statistics integration.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1251
Network Management
shutdown (monitor session)
shutdown (monitor session)
To disable a configured ERSPAN session, use the shutdown command in ERSPAN monitor source session
configuration mode. To enable configured ERSPAN session, use the no form of this command.
shutdown
no shutdown
Syntax Description This command has no arguments or keywords.
Command Default A newly configured ERSPAN session will be in the shutdown state.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The ERSPAN session remains inactive until the no shutdown command is configured.
Examples The following example shows how to activate an ERSPAN session using the no shutdown command:
Device> enable
Device# configure terminal
Device(config)# monitor session 1 type erspan-source
Device(config-mon-erspan-src)# description source1
Device(config-mon-erspan-src)# source interface GigabitEthernet1/0/1 rx
Device(config-mon-erspan-src)# destination
Device(config-mon-erspan-src-dst)# erspan-id 100
Device(config-mon-erspan-src-dst)# origin ip address 10.10.0.1
Device(config-mon-erspan-src-dst)# ip address 10.1.0.2
Device(config-mon-erspan-src-dst)# ip dscp 10
Device(config-mon-erspan-src-dst)# ip ttl 32
Device(config-mon-erspan-src-dst)# mtu 512
Device(config-mon-erspan-src-dst)# vrf monitoring
Device(config-mon-erspan-src-dst)# exit
Device(config-mon-erspan-src)# no shutdown
Device(config-mon-erspan-src)# end
Related Commands Command Description
monitor session type Creates an ERSPAN source and destination session number or enters the ERSPAN
session configuration mode for the session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1252
Network Management
snmp ifmib ifindex persist
snmp ifmib ifindex persist
To globally enable ifIndex values to persist , which will remain constant across reboots, for use by the Simple
Network Management Protocol (SNMP), use the snmp ifmib ifindex persist command in global
configuration mode. To globally disable ifIndex persistence, use the no form of this command.
snmp ifmib ifindex persist
no snmp ifmib ifindex persist
Syntax Description This command has no arguments or keywords.
Command Default The ifIndex persistence on a device is disabled.
Command Modes Global configuration (config)
Usage Guidelines The snmp ifmib ifindex persist command does not override an interface-specific configuration. The
interface-specific configuration of ifIndex persistence is configured with the snmp ifindex persist and snmp
ifindex clear commands in interface configuration mode.
The snmp ifmib ifindex persist command enables ifIndex persistence for all interfaces on a routing device
by using the ifDescr and ifIndex entries in the ifIndex table of interface MIB (IF-MIB).
ifIndex persistence means that the ifIndex values in the IF-MIB persist across reboots, allowing for the
consistent identification of specific interfaces that use SNMP.
If ifIndex persistence was previously disabled for a specific interface by using the no snmp ifindex persist
command, ifIndex persistence will remain disabled for that interface.
Examples The following example shows how to enable ifIndex persistence for all interfaces:
Device(config)# snmp ifmib ifindex persist
Related Commands Command Description
snmp ifindex clear Clears any previously configured snmp ifIndex commands issued in interface
configuration mode for a specific interface.
snmp ifindex persist Enables ifIndex values that persist across reboots (ifIndex persistence) in the IF-MIB.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1253
Network Management
snmp-server community
snmp-server community
To configure the community access string to permit access to the Simple Network Management Protocol
(SNMP), use the snmp-server community command in global configuration mode. To remove the specified
community string, use the no form of this command.
snmp-server community[clear|encrypted]community-string[view
view-name][RO|RW][SDROwner|SystemOwner][access-list-name]
no snmp-server community community-string
Syntax Description clear (Optional) Specifies that the entered community-string is clear text and should be encrypted
when displayed by the show running command.
encrypted (Optional) Specifies that the entered community-string is encrypted text and should be
displayed as such by the show running command.
community-string Community string that acts like a password and permits access to the SNMP protocol. The
maximum length of the community-string argument is 32 alphabetic characters.
If the clear keyword was used, community-string is assumed to be clear text. If the
encrypted keyword was used, community-string is assumed to be encrypted. If neither
was used, community-string is assumed to be clear text.
viewview-name (Optional) Specifies the name of a previously defined view. The view defines the objects
available to the community.
RO (Optional) Specifies read-only access. Authorized management stations are able only to
retrieve MIB objects.
RW (Optional) Specifies read-write access. Authorized management stations are able both to
retrieve and to modify MIB objects.
SDROwner (Optional) Limits access to the owner service domain router (SDR).
SystemOwner (Optional) Provides system-wide access including access to all non-owner SDRs.
access-list-name (Optional) Name of an access list of IP addresses allowed to use the community string to
gain access to the SNMP agent.
Command Default By default, an SNMP community string permits read-only access to all MIB objects. By default, a community
string is assigned to the SDR owner.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a The command was introduced.
Usage Guidelines To use this command, you must be in a user group associated with a task group that includes appropriate task
IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator
for assistance.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1254
Network Management
snmp-server community
Use the snmp-server community command to configure the community access string to permit access to
SNMP.
To remove the specified community string, use the no form of this command.
Use the clear keyword to specify that the clear text community string you enter is displayed encrypted in the
show running command output. To enter an encrypted string, use the encrypted keyword. To enter a clear
text community string that is not encrypted by the system, use neither of these keywords.
When the snmp-server community command is entered with the SDROwner keyword, SNMP access is
granted only to the MIB object instances in the owner SDR. When the snmp-server community command
is entered with the SystemOwner keyword, SNMP access is granted to all SDRs in the system.
Note In a non-owner SDR, a community name provides access only to the object instances that belong to that SDR,
regardless of the access privilege assigned to the community name. Access to the owner SDR and system-wide
access privileges are available only from the owner SDR.
Examples This example shows how to assign the string comaccess to SNMP, allowing read-only access, and
to specify that IP access list 4 can use the community string:
RP/0/RP0/CPU0:router(config)# snmp-server community comaccess ro 4
The following example shows how to assign the string mgr to SNMP, allowing read-write access to
the objects in the restricted view:
RP/0/RP0/CPU0:router(config)# snmp-server community mgr view restricted rw
This example shows how to remove the community comaccess:
RP/0/RP0/CPU0:router(config)# no snmp-server community comaccess
Related Commands Command Description
snmp-server Creates or updates an SNMP view entry.
view
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1255
Network Management
snmp-server enable traps
snmp-server enable traps
To enable the device to send Simple Network Management Protocol (SNMP) notifications for various traps
or inform requests to the network management system (NMS), use the snmp-server enable traps command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps [ auth-framework [ sec-violation ] | bridge | call-home |
config | config-copy | config-ctid | copy-config | cpu | dot1x | energywise | entity
| envmon | errdisable | event-manager | flash | fru-ctrl | license | mac-notification
| port-security | power-ethernet | rep | snmp | stackwise | storm-control | stpx
| syslog | transceiver | tty | vlan-membership | vlancreate | vlandelete | vstack
| vtp ]
no snmp-server enable traps [ auth-framework [ sec-violation ] | bridge | call-home
| config | config-copy | config-ctid | copy-config | cpu | dot1x | energywise |
entity | envmon | errdisable | event-manager | flash | fru-ctrl | license |
mac-notification | port-security | power-ethernet | rep | snmp | stackwise |
storm-control | stpx | syslog | transceiver | tty | vlan-membership | vlancreate |
vlandelete | vstack | vtp ]
Syntax Description auth-framework (Optional) Enables SNMP CISCO-AUTH-FRAMEWORK-MIB
traps.
sec-violation (Optional) Enables SNMP camSecurityViolationNotif notifications.
bridge (Optional) Enables SNMP STP Bridge MIB traps.*
call-home (Optional) Enables SNMP CISCO-CALLHOME-MIB traps.*
config (Optional) Enables SNMP configuration traps.
config-copy (Optional) Enables SNMP configuration copy traps.
config-ctid (Optional) Enables SNMP configuration CTID traps.
copy-config (Optional) Enables SNMP copy-configuration traps.
cpu (Optional) Enables CPU notification traps.*
dot1x (Optional) Enables SNMP dot1x traps.*
energywise (Optional) Enables SNMP energywise traps.*
entity (Optional) Enables SNMP entity traps.
envmon (Optional) Enables SNMP environmental monitor traps.*
errdisable (Optional) Enables SNMP errdisable notification traps.*
event-manager (Optional) Enables SNMP Embedded Event Manager traps.
flash (Optional) Enables SNMP FLASH notification traps.*
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1256
Network Management
snmp-server enable traps
fru-ctrl (Optional) Generates entity field-replaceable unit (FRU) control traps.
In a device stack, this trap refers to the insertion or removal of a
device in the stack.
license (Optional) Enables license traps.*
mac-notification (Optional) Enables SNMP MAC Notification traps.*
port-security (Optional) Enables SNMP port security traps.*
power-ethernet (Optional) Enables SNMP power Ethernet traps.*
rep (Optional) Enables SNMP Resilient Ethernet Protocol traps.
snmp (Optional) Enables SNMP traps.*
stackwise (Optional) Enables SNMP stackwise traps.*
storm-control (Optional) Enables SNMP storm-control trap parameters.*
stpx (Optional) Enables SNMP STPX MIB traps.*
syslog (Optional) Enables SNMP syslog traps.
transceiver (Optional) Enables SNMP transceiver traps.*
tty (Optional) Sends TCP connection traps. This is enabled by default.
vlan-membership (Optional) Enables SNMP VLAN membership traps.
vlancreate (Optional) Enables SNMP VLAN-created traps.
vlandelete (Optional) Enables SNMP VLAN-deleted traps.
vstack (Optional) Enables SNMP Smart Install traps.*
vtp (Optional) Enables VLAN Trunking Protocol (VTP) traps.
Command Default The sending of SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The command options marked with an asterisk in the table above have subcommands. For more information
on these subcommands, see the Related Commands section below.
Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
When supported, use the snmp-server enable traps command to enable sending of traps or informs.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1257
Network Management
snmp-server enable traps
Note Though visible in the command-line help strings, the fru-ctrl, insertion, and removal keywords are not
supported on the device. The snmp-server enable informs global configuration command is not supported.
To enable the sending of SNMP inform notifications, use the snmp-server enable traps global configuration
command combined with the snmp-server host host-addr informs global configuration command.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable more than one type of SNMP trap:
Device(config)# snmp-server enable traps config
Device(config)# snmp-server enable traps vtp
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1258
Network Management
snmp-server enable traps bridge
snmp-server enable traps bridge
To generate STP bridge MIB traps, use the snmp-server enable traps bridge command in global configuration
mode. Use the no form of this command to return to the default setting.
snmp-server enable traps bridge [newroot] [topologychange]
no snmp-server enable traps bridge [newroot] [topologychange]
Syntax Description newroot (Optional) Enables SNMP STP bridge MIB new root traps.
topologychange (Optional) Enables SNMP STP bridge MIB topology change traps.
Command Default The sending of bridge SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to send bridge new root traps to the NMS:
Device(config)# snmp-server enable traps bridge newroot
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1259
Network Management
snmp-server enable traps bulkstat
snmp-server enable traps bulkstat
To enable data-collection-MIB traps, use the snmp-server enable traps bulkstat command in global
configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps bulkstat [collection | transfer]
no snmp-server enable traps bulkstat [collection | transfer]
Syntax Description collection (Optional) Enables data-collection-MIB collection traps.
transfer (Optional) Enables data-collection-MIB transfer traps.
Command Default The sending of data-collection-MIB traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate data-collection-MIB collection traps:
Device(config)# snmp-server enable traps bulkstat collection
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1260
Network Management
snmp-server enable traps call-home
snmp-server enable traps call-home
To enable SNMP CISCO-CALLHOME-MIB traps, use the snmp-server enable traps call-home command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps call-home [message-send-fail | server-fail]
no snmp-server enable traps call-home [message-send-fail | server-fail]
Syntax Description message-send-fail (Optional) Enables SNMP message-send-fail traps.
server-fail (Optional) Enables SNMP server-fail traps.
Command Default The sending of SNMP CISCO-CALLHOME-MIB traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP message-send-fail traps:
Device(config)# snmp-server enable traps call-home message-send-fail
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1261
Network Management
snmp-server enable traps cef
snmp-server enable traps cef
To enable SNMP Cisco Express Forwarding (CEF) traps, use the snmp-server enable traps cef command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps cef [inconsistency | peer-fib-state-change | peer-state-change |
resource-failure]
no snmp-server enable traps cef [inconsistency | peer-fib-state-change | peer-state-change |
resource-failure]
Syntax Description inconsistency (Optional) Enables SNMP CEF Inconsistency traps.
peer-fib-state-change (Optional) Enables SNMP CEF Peer FIB State change traps.
peer-state-change (Optional) Enables SNMP CEF Peer state change traps.
resource-failure (Optional) Enables SNMP CEF Resource Failure traps.
Command Default The sending of SNMP CEF traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP CEF inconsistency traps:
Device(config)# snmp-server enable traps cef inconsistency
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1262
Network Management
snmp-server enable traps cpu
snmp-server enable traps cpu
To enable CPU notifications, use the snmp-server enable traps cpu command in global configuration mode.
Use the no form of this command to return to the default setting.
snmp-server enable traps cpu [threshold]
no snmp-server enable traps cpu [threshold]
Syntax Description threshold (Optional) Enables CPU threshold notification.
Command Default The sending of CPU notifications is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate CPU threshold notifications:
Device(config)# snmp-server enable traps cpu threshold
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1263
Network Management
snmp-server enable traps envmon
snmp-server enable traps envmon
To enable SNMP environmental traps, use the snmp-server enable traps envmon command in global
configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps envmon [ fan ] [ shutdown ] [ status ] [ supply ] [ temperature
]
no snmp-server enable traps envmon [ fan ] [ shutdown ] [ status ] [ supply ] [
temperature ]
Syntax Description fan (Optional) Enables fan traps.
shutdown (Optional) Enables environmental monitor shutdown traps.
status (Optional) Enables SNMP environmental status-change traps.
supply (Optional) Enables environmental monitor power-supply traps.
temperature (Optional) Enables environmental monitor temperature traps.
Command Default The sending of environmental SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate fan traps:
Device(config)# snmp-server enable traps envmon fan
Examples This example shows how to generate status-change traps:
Device(config)# snmp-server enable traps envmon status
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1264
Network Management
snmp-server enable traps errdisable
snmp-server enable traps errdisable
To enable SNMP notifications of error-disabling, use the snmp-server enable traps errdisable command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps errdisable [notification-rate number-of-notifications]
no snmp-server enable traps errdisable [notification-rate number-of-notifications]
Syntax Description notification-rate (Optional) Specifies number of notifications per minute as the
number-of-notifications notification rate. Accepted values are from 0 to 10000.
Command Default The sending of SNMP notifications of error-disabling is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to set the number SNMP notifications of error-disabling to 2:
Device(config)# snmp-server enable traps errdisable notification-rate 2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1265
Network Management
snmp-server enable traps flash
snmp-server enable traps flash
To enable SNMP flash notifications, use the snmp-server enable traps flash command in global configuration
mode. Use the no form of this command to return to the default setting.
snmp-server enable traps flash [insertion][removal]
no snmp-server enable traps flash [insertion][removal]
Syntax Description insertion (Optional) Enables SNMP flash insertion notifications.
removal (Optional) Enables SNMP flash removal notifications.
Command Default The sending of SNMP flash notifications is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP flash insertion notifications:
Device(config)# snmp-server enable traps flash insertion
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1266
Network Management
snmp-server enable traps isis
snmp-server enable traps isis
To enable intermediate system-to-intermediate system (IS-IS) link-state routing protocol traps, use the
snmp-server enable traps isis command in global configuration mode. Use the no form of this command to
return to the default setting.
snmp-server enable traps isis [errors | state-change]
no snmp-server enable traps isis [errors | state-change]
Syntax Description errors (Optional) Enables IS-IS error traps.
state-change (Optional) Enables IS-IS state change traps.
Command Default The sending of IS-IS traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate IS-IS error traps:
Device(config)# snmp-server enable traps isis errors
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1267
Network Management
snmp-server enable traps license
snmp-server enable traps license
To enable license traps, use the snmp-server enable traps license command in global configuration mode.
Use the no form of this command to return to the default setting.
snmp-server enable traps license [deploy][error][usage]
no snmp-server enable traps license [deploy][error][usage]
Syntax Description deploy (Optional) Enables license deployment traps.
error (Optional) Enables license error traps.
usage (Optional) Enables license usage traps.
Command Default The sending of license traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate license deployment traps:
Device(config)# snmp-server enable traps license deploy
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1268
Network Management
snmp-server enable traps mac-notification
snmp-server enable traps mac-notification
To enable SNMP MAC notification traps, use the snmp-server enable traps mac-notification command in
global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps mac-notification [change][move][threshold]
no snmp-server enable traps mac-notification [change][move][threshold]
Syntax Description change (Optional) Enables SNMP MAC change traps.
move (Optional) Enables SNMP MAC move traps.
threshold (Optional) Enables SNMP MAC threshold traps.
Command Default The sending of SNMP MAC notification traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP MAC notification change traps:
Device(config)# snmp-server enable traps mac-notification change
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1269
Network Management
snmp-server enable traps ospf
snmp-server enable traps ospf
To enable SNMP Open Shortest Path First (OSPF) traps, use the snmp-server enable traps ospf command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps ospf [cisco-specific | errors | lsa | rate-limit rate-limit-time
max-number-of-traps | retransmit | state-change]
no snmp-server enable traps ospf [cisco-specific | errors | lsa | rate-limit rate-limit-time
max-number-of-traps | retransmit | state-change]
Syntax Description cisco-specific (Optional) Enables Cisco-specific traps.
errors (Optional) Enables error traps.
lsa (Optional) Enables link-state advertisement (LSA) traps.
rate-limit (Optional) Enables rate-limit traps.
rate-limit-time (Optional) Specifies window of time in seconds for rate-limit traps. Accepted values
are 2 to 60.
max-number-of-traps (Optional) Specifies maximum number of rate-limit traps to be sent in window time.
retransmit (Optional) Enables packet-retransmit traps.
state-change (Optional) Enables state-change traps.
Command Default The sending of OSPF SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable LSA traps:
Device(config)# snmp-server enable traps ospf lsa
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1270
Network Management
snmp-server enable traps pim
snmp-server enable traps pim
To enable SNMP Protocol-Independent Multicast (PIM) traps, use the snmp-server enable traps pim
command in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps pim [invalid-pim-message][neighbor-change][rp-mapping-change]
no snmp-server enable traps pim [invalid-pim-message][neighbor-change][rp-mapping-change]
Syntax Description invalid-pim-message (Optional) Enables invalid PIM message traps.
neighbor-change (Optional) Enables PIM neighbor-change traps.
rp-mapping-change (Optional) Enables rendezvous point (RP)-mapping change traps.
Command Default The sending of PIM SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable invalid PIM message traps:
Device(config)# snmp-server enable traps pim invalid-pim-message
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1271
Network Management
snmp-server enable traps port-security
snmp-server enable traps port-security
To enable SNMP port security traps, use the snmp-server enable traps port-security command in global
configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps port-security [trap-rate value]
no snmp-server enable traps port-security [trap-rate value]
Syntax Description trap-rate (Optional) Sets the maximum number of port-security traps sent per second. The range is
value from 0 to 1000; the default is 0 (no limit imposed; a trap is sent at every occurrence).
Command Default The sending of port security SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable port-security traps at a rate of 200 per second:
Device(config)# snmp-server enable traps port-security trap-rate 200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1272
Network Management
snmp-server enable traps power-ethernet
snmp-server enable traps power-ethernet
To enable SNMP power-over-Ethernet (PoE) traps, use the snmp-server enable traps power-ethernet
command in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps power-ethernet {group number | police}
no snmp-server enable traps power-ethernet {group number | police}
Syntax Description group Enables inline power group-based traps for the specified group number. Accepted values are
number from 1 to 9.
police Enables inline power policing traps.
Command Default The sending of power-over-Ethernet SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable power-over-Ethernet traps for group 1:
Device(config)# snmp-server enable traps poower-over-ethernet group 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1273
Network Management
snmp-server enable traps snmp
snmp-server enable traps snmp
To enable SNMP traps, use the snmp-server enable traps snmp command in global configuration mode.
Use the no form of this command to return to the default setting.
snmp-server enable traps snmp [authentication ][coldstart ][linkdown ] [linkup ][warmstart]
no snmp-server enable traps snmp [authentication ][coldstart ][linkdown ] [linkup
][warmstart]
Syntax Description authentication (Optional) Enables authentication traps.
coldstart (Optional) Enables cold start traps.
linkdown (Optional) Enables linkdown traps.
linkup (Optional) Enables linkup traps.
warmstart (Optional) Enables warmstart traps.
Command Default The sending of SNMP traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to enable a warmstart SNMP trap:
Device(config)# snmp-server enable traps snmp warmstart
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1274
Network Management
snmp-server enable traps stackwise
snmp-server enable traps stackwise
To enable SNMP StackWise traps, use the snmp-server enable traps stackwise command in global
configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps stackwise [GLS][ILS][SRLS]
[insufficient-power][invalid-input-current]
[invalid-output-current][member-removed][member-upgrade-notification]
[new-master][new-member] [port-change][power-budget-warning][power-invalid-topology]
[power-link-status-changed][power-oper-status-changed]
[power-priority-conflict][power-version-mismatch][ring-redundant]
[stack-mismatch][unbalanced-power-supplies][under-budget][under-voltage]
no snmp-server enable traps stackwise [GLS][ILS][SRLS]
[insufficient-power][invalid-input-current]
[invalid-output-current][member-removed][member-upgrade-notification]
[new-master][new-member] [port-change][power-budget-warning][power-invalid-topology]
[power-link-status-changed][power-oper-status-changed]
[power-priority-conflict][power-version-mismatch][ring-redundant]
[stack-mismatch][unbalanced-power-supplies][under-budget][under-voltage]
Syntax Description GLS (Optional) Enables StackWise stack power GLS trap.
ILS (Optional) Enables StackWise stack power ILS trap.
SRLS (Optional) Enables StackWise stack power SRLS trap.
insufficient-power (Optional) Enables StackWise stack power unbalanced power supplies trap.
invalid-input-current (Optional) Enables StackWise stack power invalid input current trap.
invalid-output-current (Optional) Enables StackWise stack power invalid output current trap.
member-removed (Optional) Enables StackWise stack member removed trap.
member-upgrade-notification (Optional) Enables StackWise member to be reloaded for upgrade trap.
new-master (Optional) Enables StackWise new primary trap.
new-member (Optional) Enables StackWise stack new member trap.
port-change (Optional) Enables StackWise stack port change trap.
power-budget-warning (Optional) Enables StackWise stack power budget warning trap.
power-invalid-topology (Optional) Enables StackWise stack power invalid topology trap.
power-link-status-changed (Optional) Enables StackWise stack power link status changed trap.
power-oper-status-changed (Optional) Enables StackWise stack power port oper status changed trap.
power-priority-conflict (Optional) Enables StackWise stack power priority conflict trap.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1275
Network Management
snmp-server enable traps stackwise
power-version-mismatch (Optional) Enables StackWise stack power version mismatch discovered
trap.
ring-redundant (Optional) Enables StackWise stack ring redundant trap.
stack-mismatch (Optional) Enables StackWise stack mismatch trap.
unbalanced-power-supplies (Optional) Enables StackWise stack power unbalanced power supplies trap.
under-budget (Optional) Enables StackWise stack power under budget trap.
under-voltage (Optional) Enables StackWise stack power under voltage trap.
Command Default The sending of SNMP StackWise traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate StackWise stack power GLS traps:
Device(config)# snmp-server enable traps stackwise GLS
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1276
Network Management
snmp-server enable traps storm-control
snmp-server enable traps storm-control
To enable SNMP storm-control trap parameters, use the snmp-server enable traps storm-control command
in global configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps storm-control { trap-rate number-of-minutes }
no snmp-server enable traps storm-control { trap-rate }
Syntax Description trap-rate (Optional) Specifies the SNMP storm-control trap rate in minutes. Accepted values
number-of-minutes are from 0 to 1000. The default is 0.
Value 0 indicates that no limit is imposed and a trap is sent at every occurrence.
When configured, show run all command output displays no snmp-server
enable traps storm-control.
Command Default The sending of SNMP storm-control trap parameters is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to set the SNMP storm-control trap rate to 10 traps per minute:
Device(config)# snmp-server enable traps storm-control trap-rate 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1277
Network Management
snmp-server enable traps stpx
snmp-server enable traps stpx
To enable SNMP STPX MIB traps, use the snmp-server enable traps stpx command in global configuration
mode. Use the no form of this command to return to the default setting.
snmp-server enable traps stpx [inconsistency][loop-inconsistency][root-inconsistency]
no snmp-server enable traps stpx [inconsistency][loop-inconsistency][root-inconsistency]
Syntax Description inconsistency (Optional) Enables SNMP STPX MIB inconsistency update traps.
loop-inconsistency (Optional) Enables SNMP STPX MIB loop inconsistency update traps.
root-inconsistency (Optional) Enables SNMP STPX MIB root inconsistency update traps.
Command Default The sending of SNMP STPX MIB traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP STPX MIB inconsistency update traps:
Device(config)# snmp-server enable traps stpx inconsistency
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1278
Network Management
snmp-server enable traps transceiver
snmp-server enable traps transceiver
To enable SNMP transceiver traps, use the snmp-server enable traps transceiver command in global
configuration mode. Use the no form of this command to return to the default setting.
snmp-server enable traps transceiver {all}
no snmp-server enable traps transceiver {all}
Syntax Description all (Optional) Enables all SNMP transceiver traps.
Command Default The sending of SNMP transceiver traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to set all SNMP transceiver traps:
Device(config)# snmp-server enable traps transceiver all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1279
Network Management
snmp-server enable traps vrfmib
snmp-server enable traps vrfmib
To allow SNMP vrfmib traps, use the snmp-server enable traps vrfmib command in global configuration
mode. Use the no form of this command to return to the default setting.
snmp-server enable traps vrfmib [vnet-trunk-down | vnet-trunk-up | vrf-down | vrf-up]
no snmp-server enable traps vrfmib [vnet-trunk-down | vnet-trunk-up | vrf-down | vrf-up]
Syntax Description vnet-trunk-down (Optional) Enables vrfmib trunk down traps.
vnet-trunk-up (Optional) Enables vrfmib trunk up traps.
vrf-down (Optional) Enables vrfmib vrf down traps.
vrf-up (Optional) Enables vrfmib vrf up traps.
Command Default The sending of SNMP vrfmib traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate vrfmib trunk down traps:
Device(config)# snmp-server enable traps vrfmib vnet-trunk-down
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1280
Network Management
snmp-server enable traps vstack
snmp-server enable traps vstack
To enable SNMP smart install traps, use the snmp-server enable traps vstack command in global configuration
mode. Use the no form of this command to return to the default setting.
snmp-server enable traps vstack [addition][failure][lost][operation]
no snmp-server enable traps vstack [addition][failure][lost][operation]
Syntax Description addition (Optional) Enables client added traps.
failure (Optional) Enables file upload and download failure traps.
lost (Optional) Enables client lost trap.
operation (Optional) Enables operation mode change traps.
Command Default The sending of SNMP smart install traps is disabled.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Specify the host (NMS) that receives the traps by using the snmp-server host global configuration command.
If no trap types are specified, all trap types are sent.
Note Informs are not supported in SNMPv1.
To enable more than one type of trap, you must enter a separate snmp-server enable traps command for
each trap type.
Examples This example shows how to generate SNMP Smart Install client-added traps:
Device(config)# snmp-server enable traps vstack addition
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1281
Network Management
snmp-server engineID
snmp-server engineID
To configure a name for either the local or remote copy of SNMP, use the snmp-server engineID command
in global configuration mode.
snmp-server engineID {local engineid-string | remote ip-address [udp-port port-number]
engineid-string}
Syntax Description local engineid-string Specifies a 24-character ID string with the name of the copy of SNMP. You need
not specify the entire 24-character engine ID if it has trailing zeros. Specify only
the portion of the engine ID up to the point where only zeros remain in the value.
remote ip-address Specifies the remote SNMP copy. Specify the ip-address of the device that contains
the remote copy of SNMP.
udp-port port-number (Optional) Specifies the User Datagram Protocol (UDP) port on the remote device.
The default is 162.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines None
Examples
The following example configures a local engine ID of 123400000000000000000000:
Device(config)# snmp-server engineID local 1234
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1282
Network Management
snmp-server group
snmp-server group
To configure a new Simple Network Management Protocol (SNMP) group, use the snmp-server group
command in global configuration mode. To remove a specified SNMP group, use the no form of this command.
snmp-server group group-name {v1 | v2c | v3 {auth | noauth | priv}} [context context-name] [match
{exact | prefix}] [read read-view] [write write-view] [notify notify-view] [access [ipv6
named-access-list] [{acl-numberacl-name}]]
no snmp-server group group-name {v1 | v2c | v3 {auth | noauth | priv}} [context context-name]
Syntax Description group-name Name of the group.
v1 Specifies that the group is using the SNMPv1 security model. SNMPv1 is the least
secure of the possible SNMP security models.
v2c Specifies that the group is using the SNMPv2c security model.
The SNMPv2c security model allows informs to be transmitted and supports 64-character
strings.
v3 Specifies that the group is using the SNMPv3 security model.
SMNPv3 is the most secure of the supported security models. It allows you to explicitly
configure authentication characteristics.
auth Specifies authentication of a packet without encrypting it.
noauth Specifies no authentication of a packet.
priv Specifies authentication of a packet with encryption.
context (Optional) Specifies the SNMP context to associate with this SNMP group and its views.
context-name (Optional) Context name.
match (Optional) Specifies an exact context match or matches only the context prefix.
exact (Optional) Matches the exact context.
prefix (Optional) Matches only the context prefix.
read (Optional) Specifies a read view for the SNMP group. This view enables you to view
only the contents of the agent.
read-view (Optional) String of a maximum of 64 characters that is the name of the view.
The default is that the read-view is assumed to be every object belonging to the Internet
object identifier (OID) space (1.3.6.1), unless the read option is used to override this
state.
write (Optional) Specifies a write view for the SNMP group. This view enables you to enter
data and configure the contents of the agent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1283
Network Management
snmp-server group
write-view (Optional) String of a maximum of 64 characters that is the name of the view.
The default is that nothing is defined for the write view (that is, the null OID). You must
configure write access.
notify (Optional) Specifies a notify view for the SNMP group. This view enables you to specify
a notify, inform, or trap.
notify-view (Optional) String of a maximum of 64 characters that is the name of the view.
By default, nothing is defined for the notify view (that is, the null OID) until the
snmp-server host command is configured. If a view is specified in the snmp-server
group command, any notifications in that view that are generated will be sent to all
users associated with the group (provided a SNMP server host configuration exists for
the user).
Cisco recommends that you let the software autogenerate the notify view. See the
“Configuring Notify Views” section in this document.
access (Optional) Specifies a standard access control list (ACL) to associate with the group.
ipv6 (Optional) Specifies an IPv6 named access list. If both IPv6 and IPv4 access lists are
indicated, the IPv6 named access list must appear first in the list.
named-access-list (Optional) Name of the IPv6 access list.
acl-number (Optional) The acl-numberargument is an integer from 1 to 99 that identifies a previously
configured standard access list.
acl-name (Optional) The acl-name argument is a string of a maximum of 64 characters that is the
name of a previously configured standard access list.
Command Default No SNMP server groups are configured.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines When a community string is configured internally, two groups with the name public are autogenerated, one
for the v1 security model and the other for the v2c security model. Similarly, deleting a community string
will delete a v1 group with the name public and a v2c group with the name public.
No default values exist for authentication or privacy algorithms when you configure the snmp-server group
command. Also, no default passwords exist. For information about specifying a Message Digest 5 (MD5)
password, see the documentation of the snmp-server user command.
Configuring Notify Views
The notify-view option is available for two reasons:
• If a group has a notify view that is set using SNMP, you may need to change the notify view.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1284
Network Management
snmp-server group
• The snmp-server host command may have been configured before the snmp-server group command.
In this case, you must either reconfigure the snmp-server host command, or specify the appropriate
notify view.
Specifying a notify view when configuring an SNMP group is not recommended, for the following reasons:
• The snmp-server host command autogenerates a notify view for the user, and then adds it to the group
associated with that user.
• Modifying the group’s notify view will affect all users associated with that group.
Instead of specifying the notify view for a group as part of the snmp-server group command, use the following
commands in the order specified:
1. snmp-server user—Configures an SNMP user.
2. snmp-server group—Configures an SNMP group, without adding a notify view .
3. snmp-server host—Autogenerates the notify view by specifying the recipient of a trap operation.
SNMP Contexts
SNMP contexts provide VPN users with a secure way of accessing MIB data. When a VPN is associated with
a context, that VPN’s specific MIB data exists in that context. Associating a VPN with a context enables
service providers to manage networks with multiple VPNs. Creating and associating a context with a VPN
enables a provider to prevent the users of one VPN from accessing information about users of other VPNs on
the same networking device.
Use this command with the context context-name keyword and argument to associate a read, write, or notify
SNMP view with an SNMP context.
Create an SNMP Group
The following example shows how to create the SNMP server group “public,” allowing read-only
access for all objects to members of the standard named access list “lmnop”:
Device(config)# snmp-server group public v2c access lmnop
Remove an SNMP Server Group
The following example shows how to remove the SNMP server group “public” from the configuration:
Device(config)# no snmp-server group public v2c
Associate an SNMP Server Group with Specified Views
The following example shows SNMP context “A” associated with the views in SNMPv2c group
“GROUP1”:
Device(config)# snmp-server context A
Device(config)# snmp mib community commA
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1285
Network Management
snmp-server group
Device(config)# snmp mib community-map commA context A target-list commAVpn
Device(config)# snmp-server group GROUP1 v2c context A read viewA write viewA notify viewB
Related Commands Command Description
show snmp group Displays the names of groups on the device and the security model, the status
of the different views, and the storage type of each group.
snmp mib community-map Associates a SNMP community with an SNMP context, engine ID, security
name, or VPN target list.
snmp-server host Specifies the recipient of a SNMP notification operation.
snmp-server user Configures a new user to a SNMP group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1286
Network Management
snmp-server host
snmp-server host
To specify the recipient (host) of a Simple Network Management Protocol (SNMP) notification operation,
use the snmp-server host global configuration command on the device. Use the no form of this command to
remove the specified host.
snmp-server host {host-addr } [vrf vrf-instance ] [informs | traps] [version {1 | 2c | 3
{auth | noauth | priv} } ] {community-string [notification-type] }
no snmp-server host {host-addr } [vrf vrf-instance ] [informs | traps] [version {1 | 2c |
3 {auth | noauth | priv} } ] {community-string [notification-type] }
Syntax Description host-addr Name or Internet address of the host (the targeted recipient).
vrf vrf-instance (Optional) Specifies the virtual private network (VPN) routing instance and name for this
host.
informs | traps (Optional) Sends SNMP traps or informs to this host.
version 1 | 2c | (Optional) Specifies the version of the SNMP used to send the traps.
3
1—SNMPv1. This option is not available with informs.
2c—SNMPv2C.
3—SNMPv3. One of the authorization keywords (see next table row) must follow the
Version 3 keyword.
auth | noauth auth (Optional)—Enables Message Digest 5 (MD5) and Secure Hash Algorithm (SHA)
| priv packet authentication.
noauth (Default)—The noAuthNoPriv security level. This is the default if the auth |
noauth | priv keyword choice is not specified.
priv (Optional)—Enables Data Encryption Standard (DES) packet encryption (also called
privacy).
community-string Password-like community string sent with the notification operation. Though you can set
this string by using the snmp-server host command, we recommend that you define this
string by using the snmp-server community global configuration command before using
the snmp-server host command.
Note The @ symbol is used for delimiting the context information. Avoid using
the @ symbol as part of the SNMP community string when configuring this
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1287
Network Management
snmp-server host
notification-type (Optional) Type of notification to be sent to the host. If no type is specified, all notifications
are sent. The notification type can be one or more of the these keywords:
• auth-framework—Sends SNMP CISCO-AUTH-FRAMEWORK-MIB traps.
• bridge—Sends SNMP Spanning Tree Protocol (STP) bridge MIB traps.
• bulkstat—Sends Data-Collection-MIB Collection notification traps.
• call-home—Sends SNMP CISCO-CALLHOME-MIB traps.
• cef—Sends SNMP CEF traps.
• config—Sends SNMP configuration traps.
• config-copy—Sends SNMP config-copy traps.
• config-ctid—Sends SNMP config-ctid traps.
• copy-config—Sends SNMP copy configuration traps.
• cpu—Sends CPU notification traps.
• cpu threshold—Sends CPU threshold notification traps.
• eigrp—Sends SNMP EIGRP traps.
• entity—Sends SNMP entity traps.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1288
Network Management
snmp-server host
• envmon—Sends environmental monitor traps.
• errdisable—Sends SNMP errdisable notification traps.
• event-manager—Sends SNMP Embedded Event Manager traps.
• flash—Sends SNMP FLASH notifications.
• flowmon—Sends SNMP flowmon notification traps.
• ipmulticast—Sends SNMP IP multicast routing traps.
• ipsla—Sends SNMP IP SLA traps.
• isis—Sends IS-IS traps.
• license—Sends license traps.
• local-auth—Sends SNMP local auth traps.
• mac-notification—Sends SNMP MAC notification traps.
• ospf—Sends Open Shortest Path First (OSPF) traps.
• pim—Sends SNMP Protocol-Independent Multicast (PIM) traps.
• port-security—Sends SNMP port-security traps.
• power-ethernet—Sends SNMP power Ethernet traps.
• snmp—Sends SNMP-type traps.
• storm-control—Sends SNMP storm-control traps.
• stpx—Sends SNMP STP extended MIB traps.
• syslog—Sends SNMP syslog traps.
• transceiver—Sends SNMP transceiver traps.
• tty—Sends TCP connection traps.
• vlan-membership— Sends SNMP VLAN membership traps.
• vlancreate—Sends SNMP VLAN-created traps.
• vlandelete—Sends SNMP VLAN-deleted traps.
• vrfmib—Sends SNMP vrfmib traps.
• vstack—Sends SNMP Smart Install traps.
• vtp—Sends SNMP VLAN Trunking Protocol (VTP) traps.
• wireless—Sends wireless traps.
Command Default This command is disabled by default. No notifications are sent.
If you enter this command with no keywords, the default is to send all trap types to the host. No informs are
sent to this host.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1289
Network Management
snmp-server host
If no version keyword is present, the default is Version 1.
If Version 3 is selected and no authentication keyword is entered, the default is the noauth (noAuthNoPriv)
security level.
Note Though visible in the command-line help strings, the fru-ctrl keyword is not supported.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver does
not send acknowledgments when it receives traps. The sender cannot determine if the traps were received.
However, an SNMP entity that receives an inform request acknowledges the message with an SNMP response
PDU. If the sender never receives the response, the inform request can be sent again, so that informs are more
likely to reach their intended destinations.
However, informs consume more resources in the agent and in the network. Unlike a trap, which is discarded
as soon as it is sent, an inform request must be held in memory until a response is received or the request
times out. Traps are also sent only once, but an inform might be retried several times. The retries increase
traffic and contribute to a higher overhead on the network.
If you do not enter an snmp-server host command, no notifications are sent. To configure the device to send
SNMP notifications, you must enter at least one snmp-server host command. If you enter the command with
no keywords, all trap types are enabled for the host. To enable multiple hosts, you must enter a separate
snmp-server host command for each host. You can specify multiple notification types in the command for
each host.
If a local user is not associated with a remote host, the device does not send informs for the auth (authNoPriv)
and the priv (authPriv) authentication levels.
When multiple snmp-server host commands are given for the same host and kind of notification (trap or
inform), each succeeding command overwrites the previous command. Only the last snmp-server host
command is in effect. For example, if you enter an snmp-server host inform command for a host and then
enter another snmp-server host inform command for the same host, the second command replaces the first.
The snmp-server host command is used with the snmp-server enable traps global configuration command.
Use the snmp-server enable traps command to specify which SNMP notifications are sent globally. For a
host to receive most notifications, at least one snmp-server enable traps command and the snmp-server
host command for that host must be enabled. Some notification types cannot be controlled with the snmp-server
enable traps command. For example, some notification types are always enabled. Other notification types
are enabled by a different command.
The no snmp-server host command with no keywords disables traps, but not informs, to the host. To disable
informs, use the no snmp-server host informs command.
Examples This example shows how to configure a unique SNMP community string named comaccess for traps
and prevent SNMP polling access with this string through access-list 10:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1290
Network Management
snmp-server host
Device(config)# snmp-server community comaccess ro 10
Device(config)# snmp-server host 172.20.2.160 comaccess
Device(config)# access-list 10 deny any
This example shows how to send the SNMP traps to the host specified by the name myhost.cisco.com.
The community string is defined as comaccess:
Device(config)# snmp-server enable traps
Device(config)# snmp-server host myhost.cisco.com comaccess snmp
This example shows how to enable the device to send all traps to the host myhost.cisco.com by using
the community string public:
Device(config)# snmp-server enable traps
Device(config)# snmp-server host myhost.cisco.com public
You can verify your settings by entering the show running-config privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1291
Network Management
snmp-server manager
snmp-server manager
To start the Simple Network Management Protocol (SNMP) manager process, use the snmp-server manager
command in global configuration mode. To stop the SNMP manager process, use the no form of this command.
snmp-server manager
no snmp-server manager
Command Default
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a The command was
introduced.
Usage Guidelines The SNMP manager process sends SNMP requests to agents and receives SNMP responses and notifications
from agents. When the SNMP manager process is enabled, the router can query other SNMP agents and
process incoming SNMP traps.
Most network security policies assume that routers will be accepting SNMP requests, sending SNMP responses,
and sending SNMP notifications. With the SNMP manager functionality enabled, the router may also be
sending SNMP requests, receiving SNMP responses, and receiving SNMP notifications. The security policy
implementation may need to be updated prior to enabling this functionality.
SNMP requests are typically sent to UDP port 161. SNMP responses are typically sent from UDP port 161.
SNMP notifications are typically sent to UDP port 162.
The following example shows how to enable the SNMP manager process:
Router(config)# snmp-server manager
Related Commands Command Description
show running-config Displays the contents of the currently running configuration file or the
configuration for a specific interface, or map class information.
show snmp user Displays information on each SNMP username in the group username table.
snmp-server engineID Displays the identification of the local SNMP engine and all remote engines that
have been configured on the device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1292
Network Management
snmp-server user
snmp-server user
To configure a new user to a Simple Network Management Protocol (SNMP) group, use the snmp-server
user command in global configuration mode. To remove a user from an SNMP group, use the no form of this
command.
snmp-server user username group-name [remote host [udp-port port] [vrf vrf-name]] {v1 | v2c |
v3 [encrypted] [auth {md5 | sha} auth-password]} [access [ipv6 nacl] [priv {des | 3des | aes {128
| 192 | 256}} privpassword] {acl-numberacl-name}]
no snmp-server user username group-name [remote host [udp-port port] [vrf vrf-name]] {v1 |
v2c | v3 [encrypted] [auth {md5 | sha} auth-password]} [access [ipv6 nacl] [priv {des | 3des | aes
{128 | 192 | 256}} privpassword] {acl-numberacl-name}]
Syntax Description username Name of the user on the host that connects to the agent.
group-name Name of the group to which the user belongs.
remote (Optional) Specifies a remote SNMP entity to which the user belongs, and the hostname
or IPv6 address or IPv4 IP address of that entity. If both an IPv6 address and IPv4 IP
address are being specified, the IPv6 host must be listed first.
host (Optional) Name or IP address of the remote SNMP host.
udp-port (Optional) Specifies the User Datagram Protocol (UDP) port number of the remote host.
port (Optional) Integer value that identifies the UDP port. The default is 162.
vrf (Optional) Specifies an instance of a routing table.
vrf-name (Optional) Name of the Virtual Private Network (VPN) routing and forwarding (VRF)
table to use for storing data.
v1 Specifies that SNMPv1 should be used.
v2c Specifies that SNMPv2c should be used.
v3 Specifies that the SNMPv3 security model should be used. Allows the use of the encrypted
keyword or auth keyword or both.
encrypted (Optional) Specifies whether the password appears in encrypted format.
auth (Optional) Specifies which authentication level should be used.
md5 (Optional) Specifies the HMAC-MD5-96 authentication level.
sha (Optional) Specifies the HMAC-SHA-96 authentication level.
auth-password (Optional) String (not to exceed 64 characters) that enables the agent to receive packets
from the host.
access (Optional) Specifies an Access Control List (ACL) to be associated with this SNMP user.
ipv6 (Optional) Specifies an IPv6 named access list to be associated with this SNMP user.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1293
Network Management
snmp-server user
nacl (Optional) Name of the ACL. IPv4, IPv6, or both IPv4 and IPv6 access lists may be
specified. If both are specified, the IPv6 named access list must appear first in the statement.
priv (Optional) Specifies the use of the User-based Security Model (USM) for SNMP version
3 for SNMP message level security.
des (Optional) Specifies the use of the 56-bit Digital Encryption Standard (DES) algorithm for
encryption.
3des (Optional) Specifies the use of the 168-bit 3DES algorithm for encryption.
aes (Optional) Specifies the use of the Advanced Encryption Standard (AES) algorithm for
encryption.
128 (Optional) Specifies the use of a 128-bit AES algorithm for encryption.
192 (Optional) Specifies the use of a 192-bit AES algorithm for encryption.
256 (Optional) Specifies the use of a 256-bit AES algorithm for encryption.
privpassword (Optional) String (not to exceed 64 characters) that specifies the privacy user password.
acl-number (Optional) Integer in the range from 1 to 99 that specifies a standard access list of IP
addresses.
acl-name (Optional) String (not to exceed 64 characters) that is the name of a standard access list of
IP addresses.
Command Default See the table in the “Usage Guidelines” section for default behaviors for encryption, passwords, and access
lists.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines To configure a remote user, specify the IP address or port number for the remote SNMP agent of the device
where the user resides. Also, before you configure remote users for a particular agent, configure the SNMP
engine ID, using the snmp-server engineID command with the remote keyword. The remote agent’s SNMP
engine ID is needed when computing the authentication and privacy digests from the password. If the remote
engine ID is not configured first, the configuration command will fail.
For the privpassword and auth-passwordarguments, the minimum length is one character; the recommended
length is at least eight characters, and should include both letters and numbers. The recommended maximum
length is 64 characters.
The table below describes the default user characteristics for encryption, passwords, and access lists.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1294
Network Management
snmp-server user
Table 142: snmp-server user Default Descriptions
Characteristic Default
Access lists Access from all IP access lists is permitted.
Encryption Not present by default. The encrypted keyword is used to specify that the passwords are
message digest algorithm 5 (MD5)digests and not text passwords.
Passwords Assumed to be text strings.
Remote users All users are assumed to be local to this SNMP engine unless you specify they are remote
with the remote keyword.
SNMP passwords are localized using the SNMP engine ID of the authoritative SNMP engine. For informs,
the authoritative SNMP agent is the remote agent. You need to configure the remote agent’s SNMP engine
ID in the SNMP database before you can send proxy requests or informs to it.
Note Changing the engine ID after configuring the SNMP user, does not allow to remove the user. To remove the
user, you need to first reconfigure the SNMP user.
Working with Passwords and Digests
No default values exist for authentication or privacy algorithms when you configure the command. Also, no
default passwords exist. The minimum length for a password is one character, although Cisco recommends
using at least eight characters for security. The recommended maximum length of a password is 64 characters.
If you forget a password, you cannot recover it and will need to reconfigure the user. You can specify either
a plain-text password or a localized MD5 digest.
If you have the localized MD5 or Secure Hash Algorithm (SHA) digest, you can specify that string instead
of the plain-text password. The digest should be formatted as aa:bb:cc:dd where aa, bb, and cc are hexadecimal
values. Also, the digest should be exactly 16 octets long.
Examples The following example shows how to add the user abcd to the SNMP server group named public.
In this example, no access list is specified for the user, so the standard named access list applied to
the group applies to the user.
Device(config)# snmp-server user abcd public v2c
The following example shows how to add the user abcd to the SNMP server group named public.
In this example, access rules from the standard named access list qrst apply to the user.
Device(config)# snmp-server user abcd public v2c access qrst
In the following example, the plain-text password cisco123 is configured for the user abcd in the
SNMP server group named public:
Device(config)# snmp-server user abcd public v3 auth md5 cisco123
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1295
Network Management
snmp-server user
When you enter a show running-config command, a line for this user will be displayed. To learn if
this user has been added to the configuration, use the show snmp user command.
Note The show running-config command does not display any of the active SNMP users created in
authPriv or authNoPriv mode, though it does display the users created in noAuthNoPriv mode. To
display any active SNMPv3 users created in authPriv, authNoPrv, or noAuthNoPriv mode, use the
show snmp user command.
If you have the localized MD5 or SHA digest, you can specify that string instead of the plain-text
password. The digest should be formatted as aa:bb:cc:dd where aa, bb, and cc are hexadecimal values.
Also, the digest should be exactly 16 octets long.
In the following example, the MD5 digest string is used instead of the plain-text password:
Device(config)# snmp-server user abcd public v3 encrypted auth md5
00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF
In the following example, the user abcd is removed from the SNMP server group named public:
Device(config)# no snmp-server user abcd public v2c
In the following example, the user abcd from the SNMP server group named public specifies the use
of the 168-bit 3DES algorithm for privacy encryption with secure3des as the password.
Device(config)# snmp-server user abcd public priv v2c 3des secure3des
Related Commands Command Description
show running-config Displays the contents of the currently running configuration file or the
configuration for a specific interface, or map class information.
show snmp user Displays information on each SNMP username in the group username table.
snmp-server engineID Displays the identification of the local SNMP engine and all remote engines that
have been configured on the device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1296
Network Management
snmp-server view
snmp-server view
To create or update a view entry, use the snmp-server view command in global configuration mode. To
remove the specified Simple Network Management Protocol (SNMP) server view entry, use the noform of
this command.
snmp-server view view-name oid-tree {included | excluded}
no snmp-server view view-name
Syntax Description view-name Label for the view record that you are updating or creating. The name is used to reference the
record.
oid-tree Object identifier of the ASN.1 subtree to be included or excluded from the view. To identify
the subtree, specify a text string consisting of numbers, such as 1.3.6.2.4, or a word, such as
system. Replace a single subidentifier with the asterisk (*) wildcard to specify a subtree family;
for example 1.3.*.4.
included Configures the OID (and subtree OIDs) specified in oid-tree argument to be included in the
SNMP view.
excluded Configures the OID (and subtree OIDs) specified in oid-tree argument to be explicitly excluded
from the SNMP view.
Command Default No view entry exists.
Command Modes
Global configuration
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Usage Guidelines Other SNMP commands require an SMP view as an argument. You use this command to create a view to be
used as arguments for other commands.
Two standard predefined views can be used when a view is required, instead of defining a view. One is
everything, which indicates that the user can see all objects. The other is restricted,which indicates that the
user can see three groups: system, snmpStats, and snmpParties. The predefined views are described in RFC
1447.
The first snmp-server command that you enter enables SNMP on your routing device.
Examples The following example creates a view that includes all objects in the MIB-II subtree:
snmp-server view mib2 mib-2 included
The following example creates a view that includes all objects in the MIB-II system group and all
objects in the Cisco enterprise MIB:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1297
Network Management
snmp-server view
snmp-server view root_view system included
snmp-server view root_view cisco included
The following example creates a view that includes all objects in the MIB-II system group except
for sysServices (System 7) and all objects for interface 1 in the MIB-II interfaces group:
snmp-server view agon system included
snmp-server view agon system.7 excluded
snmp-server view agon ifEntry.*.1 included
In the following example, the USM, VACM, and Community MIBs are explicitly included in the
view “test” with all other MIBs under the root parent “internet”:
! -- include all MIBs under the parent tree “internet”
snmp-server view test internet included
! -- include snmpUsmMIB
snmp-server view test 1.3.6.1.6.3.15 included
! -- include snmpVacmMIB
snmp-server view test 1.3.6.1.6.3.16 included
! -- exclude snmpCommunityMIB
snmp-server view test 1.3.6.1.6.3.18 excluded
Related Commands Command Description
snmp-server community Sets up the community access string to permit access to the SNMP protocol.
snmp-server manager Starts the SNMP manager process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1298
Network Management
source
source
To configure the source IP address interface for all of the packets sent by a Flexible Netflow flow exporter,
use the source command in flow exporter configuration mode. To remove the source IP address interface for
all of the packets sent by a Flexible Netflow flow exporter, use the no form of this command.
source interface-type interface-number
no source
Syntax Description interface-type Type of interface whose IP address you want to use for the source IP address of the
packets sent by a Flexible Netflow flow exporter.
interface-number Interface number whose IP address you want to use for the source IP address of the
packets sent by a Flexible Netflow flow exporter.
Command Default The IP address of the interface over which the Flexible Netflow datagram is transmitted is used as the source
IP address.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The benefits of using a consistent IP source address for the datagrams that Flexible Netflow sends include
the following:
• The source IP address of the datagrams exported by Flexible Netflow is used by the destination system
to determine from which device the Flexible Netflow data is arriving. If your network has two or more
paths that can be used to send Flexible Netflow datagrams from the device to the destination system and
you do not specify the source interface from which the source IP address is to be obtained, the device
uses the IP address of the interface over which the datagram is transmitted as the source IP address of
the datagram. In this situation the destination system might receive Flexible Netflow datagrams from the
same device , but with different source IP addresses. When the destination system receives Flexible
Netflow datagrams from the same device with different source IP addresses, the destination system treats
the Flexible Netflow datagrams as if they were being sent from different devices . To avoid having the
destination system treat the Flexible Netflow datagrams as if they were being sent from different devices,
you must configure the destination system to aggregate the Flexible Netflow datagrams it receives from
all of the possible source IP addresses in the device into a single Flexible Netflow flow.
• If your device has multiple interfaces that can be used to transmit datagrams to the destination system,
and you do not configure the source command, you will have to add an entry for the IP address of each
interface into any access lists that you create for permitting Flexible Netflow traffic. Creating and
maintaining access lists for permitting Flexible Netflow traffic from known sources and blocking it from
unknown sources is easier when you limit the source IP address for Flexible Netflow datagrams to a
single IP address for each device that is exporting Flexible Netflow traffic.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1299
Network Management
source
Caution The interface that you configure as the source interface must have an IP address configured, and it must be
up.
Tip When a transient outage occurs on the interface that you configured with the source command, the Flexible
Netflow exporter reverts to the default behavior of using the IP address of the interface over which the
datagrams are being transmitted as the source IP address for the datagrams. To avoid this problem, use a
loopback interface as the source interface because loopback interfaces are not subject to the transient outages
that can occur on physical interfaces.
To return this command to its default settings, use the no source or default source flow exporter configuration
command.
Examples The following example shows how to configure Flexible Netflow to use a loopback interface as the
source interface for NetFlow traffic:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# source loopback 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1300
Network Management
source (ERSPAN)
source (ERSPAN)
To configure the Encapsulated Remote Switched Port Analyzer (ERSPAN) source interface or VLAN, and
the traffic direction to be monitored, use the source command in ERSPAN monitor source session configuration
mode. To disable the configuration, use the no form of this command.
source {interface type number | vlan vlan-ID}[{, | - | both | rx | tx}]
Syntax Description interface type number Specifies an interface type and number.
vlan vlan-ID Associates the ERSPAN source session number with VLANs. Valid values are
from 1 to 4094.
, (Optional) Specifies another interface.
- (Optional) Specifies a range of interfaces.
both (Optional) Monitors both received and transmitted ERSPAN traffic.
rx (Optional) Monitors only received traffic.
tx (Optional) Monitors only transmitted traffic.
Command Default Source interface or VLAN is not configured.
Command Modes ERSPAN monitor source session configuration mode (config-mon-erspan-src)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You cannot include source VLANs and filter VLANs in the same session.
Examples The following example shows how to configure ERSPAN source session properties:
Device(config)# monitor session 2 type erspan-source
Device(config-mon-erspan-src)# source interface fastethernet 0/1 rx
Related Commands Command Description
monitor session type Configures a local ERSPAN source or destination session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1301
Network Management
socket
socket
To specify the client socket and allow a TCL interpreter to connect via TCP over IPv4/IPv6 and open a TCP
network connection use the socket comand in the TCL configuration mode.
socket myaddr address myport port myvrf vrf-table-name host port
Syntax Description myaddr Specifies domain name or numerical IP address of the client-side network interface required for
the connection. Use this option especially if the client machine has multiple network interfaces.
myport Specifies port number that is required for the client's connection.
myvrf Specifies the vrf table name. If the vrf table is not configured, then the command will return a
TCL_ERROR.
Command Default
Command Modes TCL configuration mode
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 The myvrf keyword was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1302
Network Management
stealthwatch-cloud-monitor
stealthwatch-cloud-monitor
To configure the Stealthwatch Cloud monitor, use the stealthwatch-cloud-monitor command in global
configuration mode.
stealthwatch-cloud-monitor
Command Default Stealthwatch Cloud is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Before configuring Stealthwatch Cloud monitor on a device, the following root certificates must be installed:
• Starfield Services Root certificate from https://www.amazontrust.com/repository/
%20SFC2CA-SFSRootCAG2.pem
• Baltimore CyberTrust Root PEM certificate from https://www.digicert.com/kb/digicert-root-certificates.htm
After configuring Stealthwatch Cloud monitor on a device, configure the service key using the service-key
SwC-service-key command.
Examples The following example shows how to configure a Stealthwatch Cloud monitor:
Device> enable
Device# configure terminal
Device(config)# stealthwatch-cloud-monitor
Device(config-stealthwatch-cloud-monitor)#
Related Commands Command Description
sensor-name SwC-sensor-name Sets the sensor name for the Stealthwatch Cloud
registration.
service-key SwC-service-key Configures the Stealthwatch Cloud service key.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
url SwC-server-url Configures the Stealthwatch Cloud server URL.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1303
Network Management
switchport mode access
switchport mode access
To sets the interface as a nontrunking nontagged single-VLAN Ethernet interface , use the switchport mode
access command in template configuration mode. Use the no form of this command to return to the default
setting.
switchport mode access
no switchport mode access
Syntax Description switchport mode access Sets the interface as a nontrunking nontagged single-VLAN Ethernet interface.
Command Default An access port can carry traffic in one VLAN only. By default, an access port carries traffic for VLAN1.
Command Modes Template configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This example shows how to set a single-VLAN interface
Device(config-template)# switchport mode access
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1304
Network Management
switchport voice vlan
switchport voice vlan
To specify to forward all voice traffic through the specified VLAN, use the switchport voice vlan command
in template configuration mode. Use the no form of this command to return to the default setting.
switchport voice vlanvlan_id
no switchport voice vlan
Syntax Description switchport voice vlanvlan_id Specifies to forward all voice traffic through the specified VLAN.
Command Default You can specify a value from 1 to 4094.
Command Modes Template configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a Cisco IOS XE Fuji This command was introduced.
16.9.1
Examples This example shows how to specify to forward all voice traffic through the specified VLAN.
Device(config-template)# switchport voice vlan 20
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1305
Network Management
ttl
ttl
To configure the time-to-live (TTL) value, use the ttl command in flow exporter configuration mode. To
remove the TTL value, use the no form of this command.
ttl ttl
no ttl ttl
Syntax Description ttl Time-to-live (TTL) value for exported datagrams. The range is 1 to 255. The default is 255.
Command Default Flow exporters use a TTL of 255.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To return this command to its default settings, use the no ttl or default ttl flow exporter configuration command.
The following example specifies a TTL of 15:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# ttl 15
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1306
Network Management
transport
transport
To configure the transport protocol for a flow exporter for Flexible Netflow, use the transport command in
flow exporter configuration mode. To remove the transport protocol for a flow exporter, use the no form of
this command.
transport udp udp-port
no transport udp udp-port
Syntax Description udp udp-port Specifies User Datagram Protocol (UDP) as the transport protocol and the UDP port number.
Command Default Flow exporters use UDP on port 9995.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To return this command to its default settings, use the no transport or default transport flow exporter
configuration command.
The following example configures UDP as the transport protocol and a UDP port number of 250:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# transport udp 250
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1307
Network Management
template data timeout
template data timeout
To specify a timeout period for resending flow exporter template data, use the template data timeout command
in flow exporter configuration mode. To remove the template resend timeout for a flow exporter, use the no
form of this command.
template data timeout seconds
no template data timeout seconds
Syntax Description seconds Timeout value in seconds. The range is 1 to 86400. The default is 600.
Command Default The default template resend timeout for a flow exporter is 600 seconds.
Command Modes Flow exporter configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Flow exporter template data describes the exported data records. Data records cannot be decoded without the
corresponding template. The template data timeout command controls how often those templates are exported.
To return this command to its default settings, use the no template data timeout or default template data
timeout flow record exporter command.
The following example configures resending templates based on a timeout of 1000 seconds:
Device(config)# flow exporter FLOW-EXPORTER-1
Device(config-flow-exporter)# template data timeout 1000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1308
Network Management
udp peek
udp peek
To enable peeking into a UDP socket use the udp_peek command in the TCL configuration mode.
udp_peek socket buffersize buffer-size
Syntax Description buffersize Specifies the buffer
size.
Command Default
Command Modes TCL configuration mode
Command History Release Modification
Cisco IOS XE Amsterdam 17.2.1 This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1309
Network Management
url (stealthwatch-cloud-monitor)
url (stealthwatch-cloud-monitor)
To configure the URL of the Stealthwatch Cloud portal, use the url SwC-server-url command in
stealthwatch-cloud-monitor configuration mode.
url SwC-server-url
Syntax Description SwC-server-url Stealthwatch Cloud server URL.
Command Default The URL of the Stealthwatch Cloud server located in the U.S is configured.
Command Modes stealthwatch-cloud-monitor (stealthwatch-cloud-monitor)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Usage Guidelines Configuring the Stealthwatch Cloud URL is optional. Configure the stealthwatch-cloud-monitor and the
service-key SwC-service-key commands before setting the Stealthwatch Cloud URL.
If no URL is configured, by default, the URL of the Stealthwatch Cloud server, located in the U.S, is configured.
Based on your location, the default URL redirects you to the nearest Stealthwatch Cloud server URL.
Note All encrypted traffic must use HTTPS (TCP port 443) to reach the Stealthwatch Cloud portal.
Examples The following example shows how to configure the URL of a Stealthwatch Cloud server:
Device> enable
Device# configure terminal
Device(config)# stealthwatch-cloud-monitor
Device(config-stealthwatch-cloud-monitor)# service-key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Device(config-stealthwatch-cloud-monitor)# url https://sensors.eu-2.obsrvbl.com
Related Commands Command Description
sensor-name SwC-sensor-name Sets the sensor name for the Stealthwatch Cloud
registration.
service-key SwC-service-key Configures the Stealthwatch Cloud service key.
show stealth-watch-cloud detail Displays the Stealthwatch Cloud registration status
and its configured values.
stealthwatch-cloud-monitor Configures the Stealthwatch Cloud monitor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1310
PA R T IX
QoS
• QoS Commands, on page 1313
QoS Commands
• auto qos classify, on page 1314
• auto qos trust, on page 1316
• auto qos video, on page 1323
• auto qos voip , on page 1333
• class, on page 1347
• class-map, on page 1349
• debug auto qos, on page 1351
• match (class-map configuration), on page 1352
• policy-map, on page 1355
• priority, on page 1357
• qos stack-buffer, on page 1359
• qos queue-softmax-multiplier, on page 1360
• queue-buffers ratio, on page 1361
• queue-limit, on page 1362
• random-detect cos, on page 1364
• random-detect cos-based, on page 1365
• random-detect dscp, on page 1366
• random-detect dscp-based, on page 1368
• random-detect precedence, on page 1369
• random-detect precedence-based, on page 1371
• service-policy (Wired), on page 1372
• set, on page 1374
• show auto qos , on page 1380
• show class-map, on page 1382
• show platform hardware fed switch, on page 1383
• show platform software fed switch qos, on page 1386
• show platform software fed switch qos qsb, on page 1387
• show policy-map, on page 1390
• show tech-support qos, on page 1392
• trust device, on page 1394
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1313
QoS
auto qos classify
auto qos classify
To automatically configure quality of service (QoS) classification for untrusted devices within a QoS domain,
use the auto qos classify command in interface configuration mode. To return to the default setting, use the
no form of this command.
auto qos classify [police]
no auto qos classify [police]
Syntax Description police (Optional) Configure QoS policing for untrusted devices.
Command Default Auto-QoS classify is disabled on the port.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to configure the QoS for trusted interfaces within the QoS domain. The QoS domain
includes the device, the network interior, and edge devices that can classify incoming traffic for QoS.
When auto-QoS is enabled, it uses the ingress packet label to categorize traffic, to assign packet labels, and
to configure the ingress and egress queues.
Auto-QoS configures the device for connectivity with a trusted interface. The QoS labels of incoming packets
are trusted. For nonrouted ports, the CoS value of the incoming packets is trusted. For routed ports, the DSCP
value of the incoming packet is trusted.
To take advantage of the auto-QoS defaults, you should enable auto-QoS before you configure other QoS
commands. You can fine-tune the auto-QoS configuration after you enable auto-QoS.
Note The device applies the auto-QoS-generated commands as if the commands were entered from the command-line
interface (CLI). An existing user configuration can cause the application of the generated commands to fail
or to be overridden by the generated commands. These actions occur without warning. If all the generated
commands are successfully applied, any user-entered configuration that was not overridden remains in the
running configuration. Any user-entered configuration that was overridden can be retrieved by reloading the
device without saving the current configuration to memory. If the generated commands fail to be applied, the
previous running configuration is restored.
After auto-QoS is enabled, do not modify a policy map or aggregate policer that includes AutoQoS in its name.
If you need to modify the policy map or aggregate policer, make a copy of it, and change the copied policy
map or policer. To use the new policy map instead of the generated one, remove the generated policy map
from the interface, and apply the new policy map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1314
QoS
auto qos classify
To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging
before you enable auto-QoS. Use the debug auto qos privileged EXEC command to enable auto-QoS
debugging.
The following policy maps and class maps are created and applied when running the auto qos classify and
auto qos classify police commands:
Policy maps (For the auto qos classify policecommand):
• AutoQos-4.0-Classify-Police-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• AutoQos-4.0-Multimedia-Conf-Class (match-any)
• AutoQos-4.0-Bulk-Data-Class (match-any)
• AutoQos-4.0-Transaction-Class (match-any)
• AutoQos-4.0-Scavanger-Class (match-any)
• AutoQos-4.0-Signaling-Class (match-any)
• AutoQos-4.0-Default-Class (match-any)
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
To disable auto-QoS on a port, use the no auto qos classify interface configuration command. Only the
auto-QoS-generated interface configuration commands for this port are removed. If this is the last port on
which auto-QoS is enabled and you enter the no auto qos classify command, auto-QoS is considered disabled
even though the auto-QoS-generated global configuration commands remain (to avoid disrupting traffic on
other ports affected by the global configuration).
Examples This example shows how to enable auto-QoS classification of an untrusted device and police traffic:
You can verify your settings by entering the show auto qos interface interface-id privileged EXEC
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1315
QoS
auto qos trust
auto qos trust
To automatically configure quality of service (QoS) for trusted interfaces within a QoS domain, use the auto
qos trust command in interface configuration mode. To return to the default setting, use the no form of this
command.
auto qos trust {cos | dscp}
no auto qos trust {cos | dscp}
Syntax Description cos Trusts the CoS packet classification.
dscp Trusts the DSCP packet classification.
Command Default Auto-QoS trust is disabled on the port.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to configure the QoS for trusted interfaces within the QoS domain. The QoS domain
includes the device, the network interior, and edge devices that can classify incoming traffic for QoS. When
auto-QoS is enabled, it uses the ingress packet label to categorize traffic, to assign packet labels, and to
configure the ingress and egress queues.
Table 143: Traffic Types, Packet Labels, and Queues
4 5
VOIP Data VOIP Routing STP BPDU Real-Time All Other Traffic
Traffic Control Protocol Traffic Video Traffic
Traffic Traffic
DSCP6 46 24, 26 48 56 34 –
CoS7 5 3 6 7 3 –
4
STP = Spanning Tree Protocol
5
BPDU = bridge protocol data unit
6
DSCP = Differentiated Services Code Point
7
CoS = class of service
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1316
QoS
auto qos trust
Note The device applies the auto-QoS-generated commands as if the commands were entered from the command-line
interface (CLI). An existing user configuration can cause the application of the generated commands to fail
or to be overridden by the generated commands. These actions occur without warning. If all the generated
commands are successfully applied, any user-entered configuration that was not overridden remains in the
running configuration. Any user-entered configuration that was overridden can be retrieved by reloading the
device without saving the current configuration to memory. If the generated commands fail to be applied, the
previous running configuration is restored.
After auto-QoS is enabled, do not modify a policy map or aggregate policer that includes AutoQoS in its name.
If you need to modify the policy map or aggregate policer, make a copy of it, and change the copied policy
map or policer. To use the new policy map instead of the generated one, remove the generated policy map
from the interface, and apply the new policy map.
To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging
before you enable auto-QoS. Use the debug auto qos privileged EXEC command to enable auto-QoS
debugging.
The following policy maps and class maps are created and applied when running the auto qos trust cos
command.
Policy maps:
• AutoQos-4.0-Trust-Cos-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
The following policy maps and class maps are created and applied when running the auto qos trust dscp
command:
Policy maps:
• AutoQos-4.0-Trust-Dscp-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• class-default (match-any)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1317
QoS
auto qos trust
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
To disable auto-QoS on a port, use the no auto qos trust interface configuration command. Only the
auto-QoS-generated interface configuration commands for this port are removed. If this is the last port on
which auto-QoS is enabled and you enter the no auto qos trust command, auto-QoS is considered disabled
even though the auto-QoS-generated global configuration commands remain (to avoid disrupting traffic on
other ports affected by the global configuration).
Examples This example shows how to enable auto-QoS for a trusted interface with specific CoS classification.
Device(config)# interface gigabitethernet1/0/17
Device(config-if)# auto qos trust cos
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/17
Gigabitethernet1/0/17
Service-policy input: AutoQos-4.0-Trust-Cos-Input-Policy
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
cos cos table AutoQos-4.0-Trust-Cos-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1318
QoS
auto qos trust
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1319
QoS
auto qos trust
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
This example shows how to enable auto-QoS for a trusted interface with specific DSCP classification.
Device(config)# interface gigabitethernet1/0/18
Device(config-if)# auto qos trust dscp
Device(config-if)# end
Device#show policy-map interface gigabitethernet1/0/18
Gigabitethernet1/0/18
Service-policy input: AutoQos-4.0-Trust-Dscp-Input-Policy
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp dscp table AutoQos-4.0-Trust-Dscp-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1320
QoS
auto qos trust
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1321
QoS
auto qos trust
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
You can verify your settings by entering the show auto qos interface interface-id privileged EXEC
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1322
QoS
auto qos video
auto qos video
To automatically configure quality of service (QoS) for video within a QoS domain, use the auto qos video
command in interface configuration mode. Use the no form of this command to return to the default setting.
auto qos video { cts | ip-camera | media-player}
no auto qos video {cts | ip-camera | media-player}
Syntax Description cts Specifies a port connected to a Cisco TelePresence System and automatically configures QoS
for video.
ip-camera Specifies a port connected to a Cisco IP camera and automatically configures QoS for video.
media-player Specifies a port connected to a CDP-capable Cisco digital media player and automatically
configures QoS for video.
Command Default Auto-QoS video is disabled on the port.
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to configure the QoS appropriate for video traffic within the QoS domain. The QoS domain
includes the device, the network interior, and edge devices that can classify incoming traffic for QoS. When
auto-QoS is enabled, it uses the ingress packet label to categorize traffic, to assign packet labels, and to
configure the ingress and egress queues. For more information, see the queue tables at the end of this section.
Auto-QoS configures the device for video connectivity to a Cisco TelePresence system, a Cisco IP camera,
or a Cisco digital media player.
To take advantage of the auto-QoS defaults, you should enable auto-QoS before you configure other QoS
commands. You can fine-tune the auto-QoS configuration after you enable auto-QoS.
The device applies the auto-QoS-generated commands as if the commands were entered from the command-line
interface (CLI). An existing user configuration can cause the application of the generated commands to fail
or to be overridden by the generated commands. These actions occur without warning. If all the generated
commands are successfully applied, any user-entered configuration that was not overridden remains in the
running configuration. Any user-entered configuration that was overridden can be retrieved by reloading the
device without saving the current configuration to memory. If the generated commands fail to be applied, the
previous running configuration is restored.
If this is the first port on which you have enabled auto-QoS, the auto-QoS-generated global configuration
commands are executed followed by the interface configuration commands. If you enable auto-QoS on another
port, only the auto-QoS-generated interface configuration commands for that port are executed.
After auto-QoS is enabled, do not modify a policy map or aggregate policer that includes AutoQoS in its name.
If you need to modify the policy map or aggregate policer, make a copy of it, and change the copied policy
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1323
QoS
auto qos video
map or policer. To use the new policy map instead of the generated one, remove the generated policy map
from the interface, and apply the new policy map.
To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging
before you enable auto-QoS. Use the debug auto qos privileged EXEC command to enable auto-QoS
debugging.
The following policy maps and class maps are created and applied when running the auto qos video cts
command:
Policy maps:
• AutoQos-4.0-Trust-Cos-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
The following policy maps and class maps are created and applied when running the auto qos video ip-camera
command:
Policy maps:
• AutoQos-4.0-Trust-Dscp-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1324
QoS
auto qos video
The following policy maps and class maps are created and applied when running the auto qos video
media-player command:
Policy maps:
• AutoQos-4.0-Trust-Dscp-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
To disable auto-QoS on a port, use the no auto qos video interface configuration command. Only the
auto-QoS-generated interface configuration commands for this port are removed. If this is the last port on
which auto-QoS is enabled, and you enter the no auto qos video command, auto-QoS is considered disabled
even though the auto-QoS-generated global configuration commands remain (to avoid disrupting traffic on
other ports affected by the global configuration).
Table 144: Traffic Types, Packet Labels, and Queues
8 9
VOIP Data VOIP Routing STP BPDU Real-Time All Other Traffic
Traffic Control Protocol Traffic Video
Traffic Traffic Traffic
DSCP10 46 24, 26 48 56 34 –
CoS11 5 3 6 7 3 –
8
STP = Spanning Tree Protocol
9
BPDU = bridge protocol data unit
10
DSCP = Differentiated Services Code Point
11
CoS = class of service
Examples The following is an example of the auto qos video cts command and the applied policies and class
maps:
Device(config)# interface gigabitethernet1/0/12
Device(config-if)# auto qos video cts
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/12
Gigabitethernet1/0/12
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1325
QoS
auto qos video
Service-policy input: AutoQos-4.0-Trust-Cos-Input-Policy
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
cos cos table AutoQos-4.0-Trust-Cos-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1326
QoS
auto qos video
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1327
QoS
auto qos video
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
The following is an example of the auto qos video ip-camera command and the applied policies
and class maps:
Device(config)# interface gigabitethernet1/0/9
Device(config-if)# auto qos video ip-camera
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/9
Gigabitethernet1/0/9
Service-policy input: AutoQos-4.0-Trust-Dscp-Input-Policy
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp dscp table AutoQos-4.0-Trust-Dscp-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1328
QoS
auto qos video
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1329
QoS
auto qos video
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
The following is an example of the auto qos video media-player command and the applied policies
and class maps.
Device(config)# interface gigabitethernet1/0/7
Device(config-if)# auto qos video media-player
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/7
interface gigabitethernet1/0/7
Service-policy input: AutoQos-4.0-Trust-Dscp-Input-Policy
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp dscp table AutoQos-4.0-Trust-Dscp-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1330
QoS
auto qos video
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1331
QoS
auto qos video
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
You can verify your settings by entering the show auto qos video interface interface-id privileged
EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1332
QoS
auto qos voip
auto qos voip
To automatically configure quality of service (QoS) for voice over IP (VoIP) within a QoS domain, use the
auto qos voip command in interface configuration mode. Use the no form of this command to return to the
default setting.
auto qos voip {cisco-phone | cisco-softphone | trust}
no auto qos voip {cisco-phone | cisco-softphone | trust}
Syntax Description cisco-phone Specifies a port connected to a Cisco IP phone, and automatically configures QoS for VoIP.
The QoS labels of incoming packets are trusted only when the telephone is detected.
cisco-softphone Specifies a port connected to a device running the Cisco SoftPhone, and automatically
configures QoS for VoIP.
trust Specifies a port connected to a trusted device, and automatically configures QoS for VoIP.
The QoS labels of incoming packets are trusted. For nonrouted ports, the CoS value of the
incoming packet is trusted. For routed ports, the DSCP value of the incoming packet is
trusted.
Command Default Auto-QoS is disabled on the port.
When auto-QoS is enabled, it uses the ingress packet label to categorize traffic, to assign packet labels, and
to configure the ingress and egress queues.
Command Default Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to configure the QoS appropriate for VoIP traffic within the QoS domain. The QoS domain
includes the device, the network interior, and edge devices that can classify incoming traffic for QoS.
Auto-QoS configures the device for VoIP with Cisco IP phones on device and routed ports and for devices
running the Cisco SoftPhone application. These releases support only Cisco IP SoftPhone Version 1.3(3) or
later. Connected devices must use Cisco Call Manager Version 4 or later.
To take advantage of the auto-QoS defaults, you should enable auto-QoS before you configure other QoS
commands. You can fine-tune the auto-QoS configuration after you enable auto-QoS.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1333
QoS
auto qos voip
Note The device applies the auto-QoS-generated commands as if the commands were entered from the command-line
interface (CLI). An existing user configuration can cause the application of the generated commands to fail
or to be overridden by the generated commands. These actions occur without warning. If all the generated
commands are successfully applied, any user-entered configuration that was not overridden remains in the
running configuration. Any user-entered configuration that was overridden can be retrieved by reloading the
device without saving the current configuration to memory. If the generated commands fail to be applied, the
previous running configuration is restored.
If this is the first port on which you have enabled auto-QoS, the auto-QoS-generated global configuration
commands are executed followed by the interface configuration commands. If you enable auto-QoS on another
port, only the auto-QoS-generated interface configuration commands for that port are executed.
When you enter the auto qos voip cisco-phone interface configuration command on a port at the edge of the
network that is connected to a Cisco IP phone, the device enables the trusted boundary feature. The device
uses the Cisco Discovery Protocol (CDP) to detect the presence of a Cisco IP phone. When a Cisco IP phone
is detected, the ingress classification on the port is set to trust the QoS label received in the packet. The device
also uses policing to determine whether a packet is in or out of profile and to specify the action on the packet.
If the packet does not have a DSCP value of 24, 26, or 46 or is out of profile, the device changes the DSCP
value to 0. When a Cisco IP phone is absent, the ingress classification is set to not trust the QoS label in the
packet. The policing is applied to those traffic matching the policy-map classification before the device enables
the trust boundary feature.
• When you enter the auto qos voip cisco-softphone interface configuration command on a port at the
edge of the network that is connected to a device running the Cisco SoftPhone, the device uses policing
to decide whether a packet is in or out of profile and to specify the action on the packet. If the packet
does not have a DSCP value of 24, 26, or 46 or is out of profile, the device changes the DSCP value to
0.
• When you enter the auto qos voip trust interface configuration command on a port connected to the
network interior, the device trusts the CoS value for nonrouted ports or the DSCP value for routed ports
in ingress packets (the assumption is that traffic has already been classified by other edge devices).
You can enable auto-QoS on static, dynamic-access, and voice VLAN access, and trunk ports. When enabling
auto-QoS with a Cisco IP phone on a routed port, you must assign a static IP address to the IP phone.
Note When a device running Cisco SoftPhone is connected to a device or routed port, the device supports only one
Cisco SoftPhone application per port.
After auto-QoS is enabled, do not modify a policy map or aggregate policer that includes AutoQoS in its name.
If you need to modify the policy map or aggregate policer, make a copy of it, and change the copied policy
map or policer. To use the new policy map instead of the generated one, remove the generated policy map
from the interface, and apply the new policy map.
To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging
before you enable auto-QoS. Use the debug auto qos privileged EXEC command to enable auto-QoS
debugging.
The following policy maps and class maps are created and applied when running the auto qos voip trust
command:
Policy maps:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1334
QoS
auto qos voip
• AutoQos-4.0-Trust-Cos-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
The following policy maps and class maps are created and applied when running the auto qos voip
cisco-softphone command:
Policy maps:
• AutoQos-4.0-CiscoSoftPhone-Input-Policy
• AutoQos-4.0-Output-Policy
Class maps:
• AutoQos-4.0-Voip-Data-Class (match-any)
• AutoQos-4.0-Voip-Signal-Class (match-any)
• AutoQos-4.0-Multimedia-Conf-Class (match-any)
• AutoQos-4.0-Bulk-Data-Class (match-any)
• AutoQos-4.0-Transaction-Class (match-any)
• AutoQos-4.0-Scavanger-Class (match-any)
• AutoQos-4.0-Signaling-Class (match-any)
• AutoQos-4.0-Default-Class (match-any)
• class-default (match-any)
• AutoQos-4.0-Output-Priority-Queue (match-any)
• AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
• AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
• AutoQos-4.0-Output-Trans-Data-Queue (match-any)
• AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
• AutoQos-4.0-Output-Scavenger-Queue (match-any)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1335
QoS
auto qos voip
• AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
The following policy maps and class maps are created and applied when running the auto qos voip cisco-phone
command:
Policy maps:
• service-policy input AutoQos-4.0-CiscoPhone-Input-Policy
• service-policy output AutoQos-4.0-Output-Policy
Class maps:
• class AutoQos-4.0-Voip-Data-CiscoPhone-Class
• class AutoQos-4.0-Voip-Signal-CiscoPhone-Class
• class AutoQos-4.0-Default-Class
To disable auto-QoS on a port, use the no auto qos voip interface configuration command. Only the
auto-QoS-generated interface configuration commands for this port are removed. If this is the last port on
which auto-QoS is enabled and you enter the no auto qos voip command, auto-QoS is considered disabled
even though the auto-QoS-generated global configuration commands remain (to avoid disrupting traffic on
other ports affected by the global configuration).
The device configures egress queues on the port according to the settings in this table.
Table 145: Auto-QoS Configuration for the Egress Queues
Egress Queue Queue CoS-to-Queue Queue Weight Queue (Buffer) Size Queue (Buffer) Size
Number Map (Bandwidth) for Gigabit-Capable for 10/100 Ethernet
Ports Ports
Priority 1 4, 5 Up to 100 percent 25 percent 15 percent
(shaped)
SRR shared 2 2, 3, 6, 7 10 percent 25 percent 25 percent
SRR shared 3 0 60 percent 25 percent 40 percent
SRR shared 4 1 20 percent 25 percent 20 percent
Examples The following is an example of the auto qos voip trust command and the applied policies and class
maps:
Device(config)# interface gigabitethernet1/0/31
Device(config-if)# auto qos voip trust
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/31
Gigabitethernet1/0/31
Service-policy input: AutoQos-4.0-Trust-Cos-Input-Policy
Class-map: class-default (match-any)
0 packets
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1336
QoS
auto qos voip
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
cos cos table AutoQos-4.0-Trust-Cos-Table
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1337
QoS
auto qos voip
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1338
QoS
auto qos voip
The following is an example of the auto qos voip cisco-phone command and the applied policies
and class maps:
Device(config)# interface gigabitethernet1/0/5
Device(config-if)# auto qos voip cisco-phone
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/5
Gigabitethernet1/0/5
Service-policy input: AutoQos-4.0-CiscoPhone-Input-Policy
Class-map: AutoQos-4.0-Voip-Data-CiscoPhone-Class (match-any)
0 packets
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp ef
police:
cir 128000 bps, bc 8000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Voip-Signal-CiscoPhone-Class (match-any)
0 packets
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp cs3
police:
cir 32000 bps, bc 8000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Default-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Default
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp default
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1339
QoS
auto qos voip
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1340
QoS
auto qos voip
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
The following is an example of the auto qos voip cisco-softphone command and the applied policies
and class maps:
Device(config)# interface gigabitethernet1/0/20
Device(config-if)# auto qos voip cisco-softphone
Device(config-if)# end
Device# show policy-map interface gigabitethernet1/0/20
Gigabitethernet1/0/20
Service-policy input: AutoQos-4.0-CiscoSoftPhone-Input-Policy
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1341
QoS
auto qos voip
Class-map: AutoQos-4.0-Voip-Data-Class (match-any)
0 packets
Match: dscp ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp ef
police:
cir 128000 bps, bc 8000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Voip-Signal-Class (match-any)
0 packets
Match: dscp cs3 (24)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp cs3
police:
cir 32000 bps, bc 8000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Multimedia-Conf-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-MultiEnhanced-Conf
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp af41
police:
cir 5000000 bps, bc 156250 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Bulk-Data-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Bulk-Data
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp af11
police:
cir 10000000 bps, bc 312500 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1342
QoS
auto qos voip
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Transaction-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Transactional-Data
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp af21
police:
cir 10000000 bps, bc 312500 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Scavanger-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Scavanger
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp cs1
police:
cir 10000000 bps, bc 312500 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Signaling-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Signaling
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp cs3
police:
cir 32000 bps, bc 8000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: AutoQos-4.0-Default-Class (match-any)
0 packets
Match: access-group name AutoQos-4.0-Acl-Default
0 packets, 0 bytes
5 minute rate 0 bps
QoS Set
dscp default
police:
cir 10000000 bps, bc 312500 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
set-dscp-transmit dscp table policed-dscp
conformed 0000 bps, exceed 0000 bps
Class-map: class-default (match-any)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1343
QoS
auto qos voip
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Service-policy output: AutoQos-4.0-Output-Policy
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 0
(bytes output) 0
Class-map: AutoQos-4.0-Output-Priority-Queue (match-any)
0 packets
Match: dscp cs4 (32) cs5 (40) ef (46)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 5
0 packets, 0 bytes
5 minute rate 0 bps
Priority: 30% (300000 kbps), burst bytes 7500000,
Priority Level: 1
Class-map: AutoQos-4.0-Output-Control-Mgmt-Queue (match-any)
0 packets
Match: dscp cs2 (16) cs3 (24) cs6 (48) cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 3
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
queue-limit dscp 16 percent 80
queue-limit dscp 24 percent 90
queue-limit dscp 48 percent 100
queue-limit dscp 56 percent 100
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Conf-Queue (match-any)
0 packets
Match: dscp af41 (34) af42 (36) af43 (38)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 4
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Trans-Data-Queue (match-any)
0 packets
Match: dscp af21 (18) af22 (20) af23 (22)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1344
QoS
auto qos voip
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 2
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Bulk-Data-Queue (match-any)
0 packets
Match: dscp af11 (10) af12 (12) af13 (14)
0 packets, 0 bytes
5 minute rate 0 bps
Match: cos 1
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 4%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Scavenger-Queue (match-any)
0 packets
Match: dscp cs1 (8)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 1%
queue-buffers ratio 10
Class-map: AutoQos-4.0-Output-Multimedia-Strm-Queue (match-any)
0 packets
Match: dscp af31 (26) af32 (28) af33 (30)
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 10%
queue-buffers ratio 10
Class-map: class-default (match-any)
0 packets
Match: any
0 packets, 0 bytes
5 minute rate 0 bps
Queueing
(total drops) 0
(bytes output) 0
bandwidth remaining 25%
queue-buffers ratio 25
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1345
QoS
auto qos voip
You can verify your settings by entering the show auto qos interface interface-id privileged EXEC
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1346
QoS
class
class
To define a traffic classification match criteria for the specified class-map name, use the class command in
policy-map configuration mode. Use the no form of this command to delete an existing class map.
class {class-map-name | class-default}
no class {class-map-name | class-default}
Syntax Description class-map-name The class map name.
class-default Refers to a system default class that matches unclassified packets.
Command Default No policy map class-maps are defined.
Command Modes Policy-map configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Before using the class command, you must use the policy-map global configuration command to identify the
policy map and enter policy-map configuration mode. After specifying a policy map, you can configure a
policy for new classes or modify a policy for any existing classes in that policy map. You attach the policy
map to a port by using the service-policy interface configuration command.
After entering the class command, you enter the policy-map class configuration mode. These configuration
commands are available:
• admit—Admits a request for Call Admission Control (CAC)
• bandwidth—Specifies the bandwidth allocated to the class.
• exit—Exits the policy-map class configuration mode and returns to policy-map configuration mode.
• no—Returns a command to its default setting.
• police—Defines a policer or aggregate policer for the classified traffic. The policer specifies the bandwidth
limitations and the action to take when the limits are exceeded. For more information about this command,
see Cisco IOS Quality of Service Solutions Command Reference available on Cisco.com.
• priority—Assigns scheduling priority to a class of traffic belonging to a policy map.
• queue-buffers—Configures the queue buffer for the class.
• queue-limit—Specifies the maximum number of packets the queue can hold for a class policy configured
in a policy map.
• service-policy—Configures a QoS service policy.
• set—Specifies a value to be assigned to the classified traffic. For more information, see the set command.
• shape—Specifies average or peak rate traffic shaping. For more information about this command, see
Cisco IOS Quality of Service Solutions Command Reference available on Cisco.com.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1347
QoS
class
To return to policy-map configuration mode, use the exit command. To return to privileged EXEC mode, use
the end command.
The class command performs the same function as the class-map global configuration command. Use the
class command when a new classification, which is not shared with any other ports, is needed. Use the
class-map command when the map is shared among many ports.
You can configure a default class by using the class class-default policy-map configuration command.
Unclassified traffic (traffic that does not meet the match criteria specified in the traffic classes) is treated as
default traffic.
You can verify your settings by entering the show policy-map privileged EXEC command.
Examples This example shows how to create a policy map called policy1. When attached to the ingress direction,
it matches all the incoming traffic defined in class1 and polices the traffic at an average rate of 1
Mb/s and bursts at 1000 bytes, marking down exceeding traffic via a table-map.
Device(config)# policy-map policy1
Device(config-pmap)# class class1
Device(config-pmap-c)# police cir 1000000 bc 1000 conform-action
transmit exceed-action set-dscp-transmit dscp table EXEC_TABLE
Device(config-pmap-c)# exit
This example shows how to configure a default traffic class to a policy map. It also shows how the
default traffic class is automatically placed at the end of policy-map pm3 even though class-default
was configured first:
Device# configure terminal
Device(config)# class-map cm-3
Device(config-cmap)# match ip dscp 30
Device(config-cmap)# exit
Device(config)# class-map cm-4
Device(config-cmap)# match ip dscp 40
Device(config-cmap)# exit
Device(config)# policy-map pm3
Device(config-pmap)# class class-default
Device(config-pmap-c)# set dscp 10
Device(config-pmap-c)# exit
Device(config-pmap)# class cm-3
Device(config-pmap-c)# set dscp 4
Device(config-pmap-c)# exit
Device(config-pmap)# class cm-4
Device(config-pmap-c)# set precedence 5
Device(config-pmap-c)# exit
Device(config-pmap)# exit
Device# show policy-map pm3
Policy Map pm3
Class cm-3
set dscp 4
Class cm-4
set precedence 5
Class class-default
set dscp af11
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1348
QoS
class-map
class-map
To create a class map to be used for matching packets to the class whose name you specify and to enter
class-map configuration mode, use the class-map command in global configuration mode. Use the no form
of this command to delete an existing class map and to return to global or policy map configuration mode.
class-map class-map name {match-any | match-all}
no class-map class-map name {match-any | match-all}
Syntax Description match-any (Optional) Perform a logical-OR of the matching statements under this class map. One or
more criteria must be matched.
match-all (Optional) Performs a logical-AND of the matching statements under this class map. All
criterias must match.
class-map-name The class map name.
Command Default No class maps are defined.
Command Modes Global configuration
Policy map configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to specify the name of the class for which you want to create or modify class-map match
criteria and to enter class-map configuration mode.
The class-map command and its subcommands are used to define packet classification, marking, and aggregate
policing as part of a globally named service policy applied on a per-port basis.
After you are in quality of service (QoS) class-map configuration mode, these configuration commands are
available:
• description—Describes the class map (up to 200 characters). The show class-map privileged EXEC
command displays the description and the name of the class map.
• exit—Exits from QoS class-map configuration mode.
• match—Configures classification criteria.
• no—Removes a match statement from a class map.
If you enter the match-any keyword, you can only use it to specify an extended named access control list
(ACL) with the match access-group class-map configuration command.
To define packet classification on a physical-port basis, only one match command per class map is supported.
The ACL can have multiple access control entries (ACEs).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1349
QoS
class-map
Note You cannot configure IPv4 and IPv6 classification criteria simultaneously in the same class-map. However,
they can be configured in different class-maps in the same policy.
Examples This example shows how to configure the class map called class1 with one match criterion, which
is an access list called 103:
Device(config)# access-list 103 permit ip any any dscp 10
Device(config)# class-map class1
Device(config-cmap)# match access-group 103
Device(config-cmap)# exit
This example shows how to delete the class map class1:
Device(config)# no class-map class1
You can verify your settings by entering the show class-map privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1350
QoS
debug auto qos
debug auto qos
To enable debugging of the automatic quality of service (auto-QoS) feature, use the debug auto qos command
in privileged EXEC mode. Use the no form of this command to disable debugging.
debug auto qos
no debug auto qos
Syntax Description This command has no arguments or keywords.
Command Default Auto-QoS debugging is disabled.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging
before you enable auto-QoS. You enable debugging by entering the debug auto qos privileged EXEC
command.
The undebug auto qos command is the same as the no debug auto qos command.
When you enable debugging on a device stack, it is enabled only on the active device. To enable debugging
on a stack member, you can start a session from the active device by using the session switch-number privileged
EXEC command. Then enter the debug command at the command-line prompt of the stack member. You
also can use the remote command stack-member-number LINE privileged EXEC command on the active
device to enable debugging on a member device without first starting a session.
Examples This example shows how to display the QoS configuration that is automatically generated when
auto-QoS is enabled:
Device# debug auto qos
AutoQoS debugging is on
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# auto qos voip cisco-phone
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1351
QoS
match (class-map configuration)
match (class-map configuration)
To define the match criteria to classify traffic, use the match command in class-map configuration mode. Use
the no form of this command to remove the match criteria.
Cisco IOS XE Everest 16.5.x and Earlier Releases
match {access-group{nameacl-name acl-index} | class-map class-map-name | cos cos-value | dscp
dscp-value | [ ip ] dscp dscp-list | [ip] precedence ip-precedence-list | precedence
precedence-value1...value4 | qos-group qos-group-value | vlan vlan-id}
no match {access-group{nameacl-name acl-index} | class-map class-map-name | cos cos-value | dscp
dscp-value | [ ip ] dscp dscp-list | [ip] precedence ip-precedence-list | precedence
precedence-value1...value4 | qos-group qos-group-value | vlan vlan-id}
Cisco IOS XE Everest 16.6.x and Later Releases
match {access-group{name acl-name acl-index} | cos cos-value | dscp dscp-value | [ ip ] dscp dscp-list
| [ ip ] precedence ip-precedence-list | mpls experimental-value | non-client-nrt | precedence
precedence-value1...value4 | protocol protocol-name | qos-group qos-group-value | vlan vlan-id | wlan
wlan-id}
no match {access-group{name acl-name acl-index} | cos cos-value | dscp dscp-value | [ ip ] dscp
dscp-list | [ ip ] precedence ip-precedence-list | mpls experimental-value | non-client-nrt | precedence
precedence-value1...value4 | protocol protocol-name | qos-group qos-group-value | vlan vlan-id | wlan
wlan-id}
Syntax Description access-group Specifies an access group.
name acl-name Specifies the name of an IP standard or extended access
control list (ACL) or MAC ACL.
acl-index Specifies the number of an IP standard or extended access
control list (ACL) or MAC ACL. For an IP standard ACL,
the ACL index range is 1 to 99 and 1300 to 1999. For an
IP extended ACL, the ACL index range is 100 to 199
and 2000 to 2699.
class-map class-map-name Uses a traffic class as a classification policy and specifies
a traffic class name to use as the match criterion.
cos cos-value Matches a packet on the basis of a Layer 2 class of service
(CoS)/Inter-Switch Link (ISL) marking. The cos-value is
from 0 to 7. You can specify up to four CoS values in one
match cos statement, separated by a space.
dscp dscp-value Specifies the parameters for each DSCP value. You can
specify a value in the range 0 to 63 specifying the
differentiated services code point value.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1352
QoS
match (class-map configuration)
ip dscp dscp-list Specifies a list of up to eight IP Differentiated Services
Code Point (DSCP) values to match against incoming
packets. Separate each value with a space. The range is 0
to 63. You also can enter a mnemonic name for a
commonly used value.
ip precedence ip-precedence-list Specifies a list of up to eight IP-precedence values to match
against incoming packets. Separate each value with a space.
The range is 0 to 7. You also can enter a mnemonic name
for a commonly used value.
precedence precedence-value1...value4 Assigns an IP precedence value to the classified traffic.
The range is 0 to 7. You also can enter a mnemonic name
for a commonly used value.
qos-group qos-group-value Identifies a specific QoS group value as a match criterion.
The range is 0 to 31.
vlan vlan-id Identifies a specific VLAN as a match criterion. The range
is 1 to 4094.
mpls experimental-value Specifies Multi Protocol Label Switching specific values.
non-client-nrt Matches a non-client NRT (non-real-time).
protocol protocol-name Specifies the type of protocol.
wlan wlan-id Identifies 802.11 specific values.
Command Default No match criteria are defined.
Command Modes Class-map configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introd
Cisco IOS XE Everest 16.6.1 The class-map class-ma
The mpls experimental-v
added.
Usage Guidelines The match command is used to specify which fields in the incoming packets are examined to classify the
packets. Only the IP access group or the MAC access group matching to the Ether Type/Len are supported.
If you enter the class-map match-anyclass-map-name global configuration command, you can enter the
following match commands:
• match access-group name acl-name
Note The ACL must be an extended named ACL.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1353
QoS
match (class-map configuration)
• match ip dscp dscp-list
• match ip precedence ip-precedence-list
The match access-group acl-index command is not supported.
To define packet classification on a physical-port basis, only one match command per class map is supported.
In this situation, the match-any keyword is equivalent.
For the match ip dscp dscp-list or the match ip precedence ip-precedence-list command, you can enter a
mnemonic name for a commonly used value. For example, you can enter the match ip dscp af11 command,
which is the same as entering the match ip dscp 10 command. You can enter the match ip precedence critical
command, which is the same as entering the match ip precedence 5 command. For a list of supported
mnemonics, enter the match ip dscp ? or the match ip precedence ? command to see the command-line help
strings.
Use the input-interface interface-id-list keyword when you are configuring an interface-level class map in
a hierarchical policy map. For the interface-id-list, you can specify up to six entries.
Examples This example shows how to create a class map called class2, which matches all the incoming traffic
with DSCP values of 10, 11, and 12:
Device(config)# class-map class2
Device(config-cmap)# match ip dscp 10 11 12
Device(config-cmap)# exit
This example shows how to create a class map called class3, which matches all the incoming traffic
with IP-precedence values of 5, 6, and 7:
Device(config)# class-map class3
Device(config-cmap)# match ip precedence 5 6 7
Device(config-cmap)# exit
This example shows how to delete the IP-precedence match criteria and to classify traffic using acl1:
Device(config)# class-map class2
Device(config-cmap)# match ip precedence 5 6 7
Device(config-cmap)# no match ip precedence
Device(config-cmap)# match access-group acl1
Device(config-cmap)# exit
This example shows how to specify a list of physical ports to which an interface-level class map in
a hierarchical policy map applies:
Device(config)# class-map match-any class4
Device(config-cmap)# match cos 4
Device(config-cmap)# exit
This example shows how to specify a range of physical ports to which an interface-level class map
in a hierarchical policy map applies:
Device(config)# class-map match-any class4
Device(config-cmap)# match cos 4
Device(config-cmap)# exit
You can verify your settings by entering the show class-map privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1354
QoS
policy-map
policy-map
To create or modify a policy map that can be attached to multiple physical ports or switch virtual interfaces
(SVIs) and to enter policy-map configuration mode, use the policy-map command in global configuration
mode. Use the no form of this command to delete an existing policy map and to return to global configuration
mode.
policy-map policy-map-name
no policy-map policy-map-name
Syntax Description policy-map-name Name of the policy map.
Command Default No policy maps are defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines After entering the policy-map command, you enter policy-map configuration mode, and these configuration
commands are available:
• class—Defines the classification match criteria for the specified class map.
• description—Describes the policy map (up to 200 characters).
• exit—Exits policy-map configuration mode and returns you to global configuration mode.
• no—Removes a previously defined policy map.
• sequence-interval—Enables sequence number capability.
To return to global configuration mode, use the exit command. To return to privileged EXEC mode, use the
end command.
Before configuring policies for classes whose match criteria are defined in a class map, use the policy-map
command to specify the name of the policy map to be created, added to, or modified. Entering the policy-map
command also enables the policy-map configuration mode in which you can configure or modify the class
policies for that policy map.
You can configure class policies in a policy map only if the classes have match criteria defined for them. To
configure the match criteria for a class, use the class-map global configuration and match class-map
configuration commands. You define packet classification on a physical-port basis.
Only one policy map per ingress port is supported. You can apply the same policy map to multiple physical
ports.
You can apply a nonhierarchical policy maps to physical ports. A nonhierarchical policy map is the same as
the port-based policy maps in the device.
A hierarchical policy map has two levels in the format of a parent-child policy. The parent policy cannot be
modified but the child policy (port-child policy) can be modified to suit the QoS configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1355
QoS
policy-map
In VLAN-based QoS, a service policy is applied to an SVI interface.
Note Not all MQC QoS combinations are supported for wired ports. For information about these restrictions, see
chapters "Restrictions for QoS on Wired Targets" in the QoS configuration guide.
Examples This example shows how to create a policy map called policy1. When attached to the ingress port,
it matches all the incoming traffic defined in class1, sets the IP DSCP to 10, and polices the traffic
at an average rate of 1 Mb/s and bursts at 20 KB. Traffic less than the profile is sent.
Device(config)# policy-map policy1
Device(config-pmap)# class class1
Device(config-pmap-c)# set dscp 10
Device(config-pmap-c)# police 1000000 20000 conform-action transmit
Device(config-pmap-c)# exit
This example show you how to configure hierarchical polices:
Device# configure terminal
Device(config)# class-map c1
Device(config-cmap)# exit
Device(config)# class-map c2
Device(config-cmap)# exit
Device(config)# policy-map child
Device(config-pmap)# class c1
Device(config-pmap-c)# priority level 1
Device(config-pmap-c)# police rate percent 20 conform-action transmit exceed action drop
Device(config-pmap-c-police)# exit
Device(config-pmap-c)# exit
Device(config-pmap)# class c2
Device(config-pmap-c)# bandwidth 20000
Device(config-pmap-c)# exit
Device(config-pmap)# class class-default
Device(config-pmap-c)# bandwidth 20000
Device(config-pmap-c)# exit
Device(config-pmap)# exit
Device(config)# policy-map parent
Device(config-pmap)# class class-default
Device(config-pmap-c)# shape average 1000000
Device(config-pmap-c)# service-policy child
Deviceconfig-pmap-c)# end
This example shows how to delete a policy map:
Device(config)# no policy-map policymap2
You can verify your settings by entering the show policy-map privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1356
QoS
priority
priority
To assign priority to a class of traffic belonging to a policy map, use the priority command in policy-map
class configuration mode. To remove a previously specified priority for a class, use the no form of this
command.
priority [Kbps [burst -in-bytes] | level level-value [Kbps [burst -in-bytes] ] | percent
percentage [Kb/s [burst -in-bytes] ] ]
no priority [Kb/s [burst -in-bytes] | level level value [Kb/s [burst -in-bytes] ] | percent
percentage [Kb/s [burst -in-bytes] ] ]
Syntax Description Kb/s (Optional) Guaranteed allowed bandwidth, in kilobits per second
(kbps), for the priority traffic. The amount of guaranteed bandwidth
varies according to the interface and platform in use. Beyond the
guaranteed bandwidth, the priority traffic will be dropped in the event
of congestion to ensure that the nonpriority traffic is not starved. The
value must be between 1 and 2,000,000 kbps.
burst -in-bytes (Optional) Burst size in bytes. The burst size configures the network
to accommodate temporary bursts of traffic. The default burst value,
which is computed as 200 milliseconds of traffic at the configured
bandwidth rate, is used when the burst argument is not specified.
The range of the burst is from 32 to 2000000 bytes.
level level-value (Optional) Assigns priority level. Available values for level-value
are 1 and 2. Level 1 is a higher priority than Level 2. Level 1 reserves
bandwidth and goes first, so latency is very low.
percent percentage (Optional) Specifies the amount of guaranteed bandwidth to be
specified by the percent of available bandwidth.
Command Default No priority is set.
Command Modes Policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The bandwidth and priority commands cannot be used in the same class, within the same policy map. However,
these commands can be used together in the same policy map.
When the policy map containing class policy configurations is attached to the interface to stipulate the service
policy for that interface, available bandwidth is assessed. If a policy map cannot be attached to a particular
interface because of insufficient interface bandwidth, the policy is removed from all interfaces to which it
was successfully attached.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1357
QoS
priority
Example
The following example shows how to configure the priority of the class in policy map policy1:
Device(config)# class-map cm1
Device(config-cmap)#match precedence 2
Device(config-cmap)#exit
Device(config)#class-map cm2
Device(config-cmap)#match dscp 30
Device(config-cmap)#exit
Device(config)# policy-map policy1
Device(config-pmap)# class cm1
Device(config-pmap-c)# priority level 1
Device(config-pmap-c)# police 1m
Device(config-pmap-c-police)#exit
Device(config-pmap-c)#exit
Device(config-pmap)#exit
Device(config)#policy-map policy1
Device(config-pmap)#class cm2
Device(config-pmap-c)#priority level 2
Device(config-pmap-c)#police 1m
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1358
QoS
qos stack-buffer
qos stack-buffer
To change the stacking mode of the device use the qos stack-buffer command in the global configuration
mode.
qos stack-buffer {enable |disable}
Syntax Description enable Enables stacking mode on the device.
disable Disables stacking on the device and puts it to standalone
mode.
Command Default By default, the device boots up with stacking mode enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines
Note This command is introduced only on the C9300-24UB and C9300-48UB switches. Ensure that you save the
configuration and then reload the switches after executing the command.
C9300-24UXB does not support this command and is always in the stacking mode.
By default, the switch comes up in the stacking mode, when it is booted. Run the qos stack-buffer disable
comamnd, save the configuration (write memory) and then reload the switch to bring it up in the standalone
mode.
Examples The following example puts the device in the standalone mode:
Device#configure terminal
Device(config)#qos stack-buffer disable
Device(config)#
*Jul 2 09:56:21.642: %FMANRP_QOS-4-STACKBUFFER: Stack-buffer configuration has been modified.
Current setting is stack-buffer Disabled. This change will take an effect once the
configuration is written in flash (write memory) and then reload the switch.
*Jul 2 09:56:21.643: %FED_QOS_ERRMSG-4-STACK_BUFFER_CONFIG_MGIG: Switch 1 R0/0: fed: mGIG
platform's default is stack-buffer enabled. Configured stack-buffer disabled (1).
Related Commands Command Description
show platform software fed switch switch_no qos Displays the status of stack-buffer.
stack-buffer
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1359
QoS
qos queue-softmax-multiplier
qos queue-softmax-multiplier
To increase the value of the soft buffers used by an interface, use the qos queue-softmax-multiplier command
in the global configuration mode.
qos queue-softmax-multiplier range-of-multiplier
no qos queue-softmax-multiplier range-of-multiplier
Syntax Description range-of-multiplier You can specify a value in the range of 100 to 1200. The
default value is 100.
Command Default None
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples This example shows how to set the value of softmax buffer to 500:
Device> enable
Device# configure terminal
Device(config)# qos queue-softmax-multiplier 500
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1360
QoS
queue-buffers ratio
queue-buffers ratio
To configure the queue buffer for the class, use the queue-buffers ratio command in policy-map class
configuration mode. Use the no form of this command to remove the ratio limit.
queue-buffers ratio ratio limit
no queue-buffers ratio ratio limit
Syntax Description ratio limit (Optional) Configures the queue buffer for the class. Enter the queue buffers ratio limit (0-100).
Command Default No queue buffer for the class is defined.
Command Modes Policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Either the bandwidth, shape, or priority command must be used before using this command. For more
information about these commands, see Cisco IOS Quality of Service Solutions Command Reference available
on Cisco.com
The device allows you to allocate buffers to queues. If buffers are not allocated, then they are divided equally
amongst all queues. You can use the queue-buffer ratio to divide it in a particular ratio. The buffers are soft
buffers because Dynamic Threshold and Scaling (DTS) is active on all queues by default.
Example
The following example sets the queue buffers ratio to 10 percent:
Device(config)# policy-map policy_queuebuf01
Device(config-pmap)# class-map class_queuebuf01
Device(config-cmap)# exit
Device(config)# policy policy_queuebuf01
Device(config-pmap)# class class_queuebuf01
Device(config-pmap-c)# bandwidth percent 80
Device(config-pmap-c)# queue-buffers ratio 10
Device(config-pmap)# end
You can verify your settings by entering the show policy-map privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1361
QoS
queue-limit
queue-limit
To specify or modify the maximum number of packets the queue can hold for a class policy configured in a
policy map, use the queue-limit policy-map class configuration command. To remove the queue packet limit
from a class, use the no form of this command.
queue-limit queue-limit-size [{packets}] {cos cos-value | dscp dscp-value} percent percentage-of-packets
no queue-limit queue-limit-size [{packets}] {cos cos-value | dscp dscp-value} percent
percentage-of-packets
Syntax Description queue-limit-size The maximum size of the queue. The maximum varies
according to the optional unit of measure keyword
specified ( bytes, ms, us, or packets).
cos cos-value Specifies parameters for each cos value. CoS values are
from 0 to 7.
dscp dscp-value Specifies parameters for each DSCP value.
You can specify a value in the range 0 to 63 specifying
the differentiated services code point value for the type
of queue limit .
percent percentage-of-packets A percentage in the range 1 to 100 specifying the
maximum percentage of packets that the queue for this
class can accumulate.
Command Default None
Command Modes Policy-map class configuration (policy-map-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Although visible in the command line help-strings, the packets unit of measure is not supported; use the
percent unit of measure.
Note This command is supported only on wired ports in the egress direction.
Weighted fair queuing (WFQ) creates a queue for every class for which a class map is defined. Packets
satisfying the match criteria for a class accumulate in the queue reserved for the class until they are sent, which
occurs when the queue is serviced by the fair queuing process. When the maximum packet threshold you
defined for the class is reached, queuing of any further packets to the class queue causes tail drop.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1362
QoS
queue-limit
You use queue limits to configure Weighted Tail Drop (WTD). WTD ensures the configuration of more than
one threshold per queue. Each class of service is dropped at a different threshold value to provide for QoS
differentiation.
You can configure the maximum queue thresholds for the different subclasses of traffic, that is, DSCP and
CoS and configure the maximum queue thresholds for each subclass.
Example
The following example configures a policy map called port-queue to contain policy for a class called
dscp-1. The policy for this class is set so that the queue reserved for it has a maximum packet limit
of 20 percent:
Device(config)# policy-map policy11
Device(config-pmap)# class dscp-1
Device(config-pmap-c)# bandwidth percent 20
Device(config-pmap-c)# queue-limit dscp 1 percent 20
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1363
QoS
random-detect cos
random-detect cos
To change the minimum and maximum packet thresholds for the Class of service (CoS) value, use the
random-detect cos command in QoS policy-map class configuration mode. To return the minimum and
maximum packet thresholds to the default for the CoS value, use the no form of this command.
random-detect cos cos-value percent min-threshold max-threshold
no random-detect cos cos-value percentmin-threshold max-threshold
Syntax Description cos-value The CoS value, which is IEEE 802.1Q/ISL class of service/user priority value. The CoS
value can be a number from 0 to 7.
percent Specifies that the minimum and threshold values are in percentage.
min-threshold Minimum threshold in number of packets. The value range of this argument is from 1 to
512000000. When the average queue length reaches the minimum threshold, Weighted
Random Early Detection (WRED) randomly drop some packets with the specified CoS
value.
max-threshold Maximum threshold in number of packets. The value range of this argument is from the
value of the min-threshold argument to 512000000. When the average queue length exceeds
the maximum threshold, WRED or dWRED drop all packets with the specified CoS value.
Command Modes
QoS policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the random-detect cos command in conjunction with the random-detect command in QoS policy-map
class configuration mode.
The random-detect cos command is available only if you have specified the cos-based argument when using
the random-detect command in interface configuration mode.
Examples The following example enables WRED to use the CoS value 8. The minimum threshold for the CoS
value 8 is 20, the maximum threshold is 40.
random-detect cos-based
random-detect cos percent 5 20 40
Related Commands Command Description
random-detect Enables WRED
show queueing Lists all or selected configured queueing strategies.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1364
QoS
random-detect cos-based
random-detect cos-based
To enable weighted random early detection (WRED) on the basis of the class of service (CoS) value of a
packet, use the random-detectcos-based command in policy-map class configuration mode. To disable
WRED, use the no form of this command.
random-detect cos-based
no random-detect cos-based
Command Default When WRED is configured, the default minimum and maximum thresholds are determined on the basis of
output buffering capacity and the transmission speed for the interface.
Command Modes
Policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples In the following example, WRED is configured on the basis of the CoS value.
Device> enable
Device# configure terminal
Device(config)# policy-map policymap1
Device(config-pmap)# class class1
Device(config-pmap-c)# random-detect cos-based
Device(config-pmap-c)#
end
Related Commands Command Description
random-detect cos Specifies the CoS value of a packet, the minimum and maximum thresholds,
and the maximum probability denominator used for enabling WRED.
show policy-map Displays the configuration of all classes for a specified service policy map
or all classes for all existing policy maps.
show policy-map interface Displays the packet statistics of all classes that are configured for all service
policies either on the specified interface or subinterface or on a specific PVC
on the interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1365
QoS
random-detect dscp
random-detect dscp
To change the minimum and maximum packet thresholds for the differentiated services code point (DSCP)
value, use the random-detect dscp command in QoS policy-map class configuration mode. To return the
minimum and maximum packet thresholds to the default for the DSCP value, use the no form of this command.
random-detect dscp dscp-value percent min-threshold max-threshold
no random-detect dscp dscp-value percentmin-threshold max-threshold
Syntax Description dscp-value The DSCP value. The DSCP value can be a number from 0 to 63, or it can be one of the
following keywords: af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43,
cs1, cs2, cs3, cs4, cs5, cs7, ef, or rsvp.
percent Specifies that the minimum and threshold values are in percentage.
min-threshold Minimum threshold in number of packets. The value range of this argument is from 1 to
512000000. When the average queue length reaches the minimum threshold, Weighted
Random Early Detection (WRED) randomly drop some packets with the specified DSCP
value.
max-threshold Maximum threshold in number of packets. The value range of this argument is from the
value of the min-threshold argument to 512000000. When the average queue length exceeds
the maximum threshold, WRED or dWRED drop all packets with the specified DSCP
value.
Command Modes
QoS policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the random-detect dscp command in conjunction with the random-detect command in QoS policy-map
class configuration mode.
The random-detect dscp command is available only if you specified the dscp-based argument when using
the random-detect command in interface configuration mode.
Specifying the DSCP Value
The random-detect dscp command allows you to specify the DSCP value per traffic class. The DSCP value
can be a number from 0 to 63, or it can be one of the following keywords: af11, af12, af13, af21, af22, af23,
af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs7, ef, or rsvp.
On a particular traffic class, eight DSCP values can be configured per traffic class. Overall, 29 values can be
configured on a traffic class: 8 precedence values, 12 Assured Forwarding (AF) code points, 1 Expedited
Forwarding code point, and 8 user-defined DSCP values.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1366
QoS
random-detect dscp
Assured Forwarding Code Points
The AF code points provide a means for a domain to offer four different levels (four different AF classes) of
forwarding assurances for IP packets received from other (such as customer) domains. Each one of the four
AF classes is allocated a certain amount of forwarding services (buffer space and bandwidth).
Within each AF class, IP packets are marked with one of three possible drop precedence values (binary 2{010},
4{100}, or 6{110}), which exist as the three lowest bits in the DSCP header. In congested network
environments, the drop precedence value of the packet determines the importance of the packet within the
AF class. Packets with higher drop precedence values are discarded before packets with lower drop precedence
values.
The upper three bits of the DSCP value determine the AF class; the lower three values determine the drop
probability.
Examples The following example enables WRED to use the DSCP value 8. The minimum threshold for the
DSCP value 8 is 20, the maximum threshold is 40, and the mark probability is 1/10.
random-detect dscp percent 8 20 40
Related Commands Command Description
random-detect Enables WRED
show queueing Lists all or selected configured queueing strategies.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1367
QoS
random-detect dscp-based
random-detect dscp-based
To base weighted random early detection (WRED) on the Differnciated Services Code Point (dscp) value of
a packet, use the random-detectdscp-based command in policy-map class configuration mode. To disable
this feature, use the no form of this command.
random-detect dscp-based
no random-detect dscp-based
Syntax Description This command has no arguments or keywords.
Command Default WRED is disabled by default.
Command Modes
Policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines With the random-detectdscp-based command, WRED is based on the dscp value of the packet.
Use the random-detectdscp-based command before configuring the random-detectdscp command.
Examples The following example shows that random detect is based on the precedence value of a packet:
Device> enable
Device# configure terminal
Device(config)#
policy-map policy1
Device(config-pmap)# class class1
Device(config-pmap-c)# bandwidth percent 80
Device(config-pmap-c)# random-detect dscp-based
Device(config-pmap-c)# random-detect dscp 2 percent 10 40
Device(config-pmap-c)# exit
Related Commands Command Description
random-detect Enables WRED.
random-detect dscp Configures the WRED parameters for a particular DSCP value for a class policy in
a policy map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1368
QoS
random-detect precedence
random-detect precedence
To configure Weighted Random Early Detection (WRED) parameters for a particular IP precedence for a
class policy in a policy map, use the random-detect precedence command in QoS policy-map class
configuration mode. To return the values to the default for the precedence, use the no form of this command.
random-detect precedence precedence percent min-threshold max-threshold
no random-detect precedence
Syntax Description precedence IP precedence number. The value range is from 0 to 7; see Table 1 in the “Usage Guidelines”
section.
percent Indicates that the threshold values are in percentage.
min-threshold Minimum threshold in number of packets. The value range of this argument is from 1 to
512000000. When the average queue length reaches the minimum threshold, WRED
randomly drops some packets with the specified IP precedence.
max-threshold Maximum threshold in number of packets. The value range of this argument is from the
value of the min-threshold argument to 512000000. When the average queue length exceeds
the maximum threshold, WRED or dWRED drop all packets with the specified IP
precedence.
Command Default The default min-threshold value depends on the precedence. The min-threshold value for IP precedence 0
corresponds to half of the max-threshold value. The values for the remaining precedences fall between half
the max-threshold value and the max-threshold value at evenly spaced intervals. See the table in the “Usage
Guidelines” section of this command for a list of the default minimum threshold values for each IP precedence.
Command Modes Interface configuration (config-if)
QoS policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines WRED is a congestion avoidance mechanism that slows traffic by randomly dropping packets when congestion
exists.
When you configure the random-detect command on an interface, packets are given preferential treatment
based on the IP precedence of the packet. Use the random-detect precedence command to adjust the treatment
for different precedences.
If you want WRED to ignore the precedence when determining which packets to drop, enter this command
with the same parameters for each precedence. Remember to use appropriate values for the minimum and
maximum thresholds.
Note that if you use the random-detect precedence command to adjust the treatment for different precedences
within class policy, you must ensure that WRED is not configured for the interface to which you attach that
service policy.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1369
QoS
random-detect precedence
Note Although the range of values for the min-threshold and max-threshold arguments is from 1 to 512000000,
the actual values that you can specify depend on the type of random detect you are configuring. For example,
the maximum threshold value cannot exceed the queue limit.
Examples The following example shows the configuration to enable WRED on the interface and to specify
parameters for the different IP precedences:
interface FortyGigE1/0/1
description 45Mbps to R1
ip address 10.200.14.250 255.255.255.252
random-detect
random-detect precedence 7 percent 20 50
Related Commands Command Description
bandwidth (policy-map class) Specifies or modifies the bandwidth allocated for a class belonging to a
policy map.
random-detect dscp Changes the minimum and maximum packet thresholds for the DSCP
value.
show policy-map interface Displays the configuration of all classes configured for all service policies
on the specified interface or displays the classes for the service policy for
a specific PVC on the interface.
show queuing Lists all or selected configured queuing strategies.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1370
QoS
random-detect precedence-based
random-detect precedence-based
To base weighted random early detection (WRED) on the precedence value of a packet, use the random-detect
precedence-based command in policy-map class configuration mode. To disable this feature, use the no form
of this command.
random-detect precedence-based
no random-detect precedence-based
Syntax Description This command has no arguments or keywords.
Command Default WRED is disabled by default.
Command Modes
Policy-map class configuration (config-pmap-c)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines With the random-detect precedence-based command, WRED is based on the IP precedence value of the
packet.
Use the random-detect precedence-based command before configuring the random-detect precedence-based
command.
Examples The following example shows that random detect is based on the precedence value of a packet:
Device> enable
Device# configure terminal
Device(config)#
policy-map policy1
Device(config-pmap)# class class1
Device(config-pmap-c)# bandwidth percent 80
Device(config-pmap-c)# random-detect precedence-based
Device(config-pmap-c)# random-detect precedence 2 percent 30 50
Device(config-pmap-c)# exit
Related Commands Command Description
random-detect Enables WRED.
random-detect precedence Configures the WRED parameters for a particular IP precedence for a class
policy in a policy map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1371
QoS
service-policy (Wired)
service-policy (Wired)
To apply a policy map to a physical port or a switch virtual interface (SVI), use the service-policy command
in interface configuration mode. Use the no form of this command to remove the policy map and port
association.
service-policy {input | output} policy-map-name
no service-policy {input | output} policy-map-name
Syntax Description input policy-map-name Apply the specified policy map to the input of a physical port or an SVI.
output policy-map-name Apply the specified policy map to the output of a physical port or an SVI.
Command Default No policy maps are attached to the port.
Command Modes WLAN interface configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines A policy map is defined by the policy map command.
Only one policy map is supported per port, per direction. In other words, only one input policy and one output
policy is allowed on any one port.
You can apply a policy map to incoming traffic on a physical port or on an SVI.
Examples This example shows how to apply plcmap1 to an physical ingress port:
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# service-policy input plcmap1
This example shows how to remove plcmap2 from a physical port:
Device(config)# interface gigabitethernet 2/0/2
Device(config-if)# no service-policy input plcmap2
The following example displays a VLAN policer configuration. At the end of this configuration, the
VLAN policy map is applied to an interface for QoS:
Device# configure terminal
Device(config)# class-map vlan100
Device(config-cmap)# match vlan 100
Device(config-cmap)# exit
Device(config)# policy-map vlan100
Device(config-pmap)# policy-map class vlan100
Device(config-pmap-c)# police 100000 bc conform-action transmit exceed-action drop
Device(config-pmap-c-police)# end
Device# configure terminal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1372
QoS
service-policy (Wired)
Device(config)# interface gigabitethernet 1/0/5
Device(config-if)# service-policy input vlan100
You can verify your settings by entering the show running-config privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1373
QoS
set
set
To classify IP traffic by setting a Differentiated Services Code Point (DSCP) or an IP-precedence value in
the packet, use the set command in policy-map class configuration mode. Use the no form of this command
to remove traffic classification.
set
cos | dscp | precedence | ip | qos-group
set cos
{cos-value } | {cos | dscp | precedence | qos-group} [{table table-map-name}]
set dscp
{dscp-value } | {cos | dscp | precedence | qos-group} [{table table-map-name}]
set ip {dscp | precedence}
set precedence {precedence-value } | {cos | dscp | precedence | qos-group} [{table table-map-name}]
set qos-group
{qos-group-value | dscp [{table table-map-name}] | precedence [{table table-map-name}]}
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1374
QoS
set
Syntax Description cos Sets the Layer 2 class of service (CoS) value or user priority
of an outgoing packet. You can specify these values:
• cos-value—CoS value from 0 to 7. You also can enter
a mnemonic name for a commonly used value.
• Specify a packet-marking category to set the CoS
value of the packet. If you also configure a table map
for mapping and converting packet-marking values,
this establishes the "map from" packet-marking
category. Packet-marking category keywords:
• cos—Sets a value from the CoS value or user
priority.
• dscp—Sets a value from packet differentiated
services code point (DSCP).
• precedence—Sets a value from packet
precedence.
• qos-group—Sets a value from the QoS group.
• (Optional)table table-map-name—Indicates that the
values set in a specified table map are used to set the
CoS value. Enter the name of the table map used to
specify the CoS value. The table map name can be a
maximum of 64 alphanumeric characters.
If you specify a packet-marking category but do not
specify the table map, the default action is to copy the
value associated with the packet-marking category as
the CoS value. For example, if you enter the set cos
precedence command, the precedence
(packet-marking category) value is copied and used
as the CoS value.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1375
QoS
set
dscp Sets the differentiated services code point (DSCP) value
to mark IP(v4) and IPv6 packets. You can specify these
values:
• cos-value—Number that sets the DSCP value. The
range is from 0 to 63. You also can enter a mnemonic
name for a commonly used value.
• Specify a packet-marking category to set the DSCP
value of the packet. If you also configure a table map
for mapping and converting packet-marking values,
this establishes the "map from" packet-marking
category. Packet-marking category keywords:
• cos—Sets a value from the CoS value or user
priority.
• dscp—Sets a value from packet differentiated
services code point (DSCP).
• precedence—Sets a value from packet
precedence.
• qos-group—Sets a value from the QoS group.
• (Optional)table table-map-name—Indicates that the
values set in a specified table map will be used to set
the DSCP value. Enter the name of the table map used
to specify the DSCP value. The table map name can
be a maximum of 64 alphanumeric characters.
If you specify a packet-marking category but do not
specify the table map, the default action is to copy the
value associated with the packet-marking category as
the DSCP value. For example, if you enter the set
dscp cos command, the CoS value (packet-marking
category) is copied and used as the DSCP value.
ip Sets IP values to the classified traffic. You can specify
these values:
• dscp—Specify an IP DSCP value from 0 to 63 or a
packet marking category.
• precedence—Specify a precedence-bit value in the
IP header; valid values are from 0 to 7 or specify a
packet marking category.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1376
QoS
set
precedence Sets the precedence value in the packet header. You can
specify these values:
• precedence-value— Sets the precedence bit in the
packet header; valid values are from 0 to 7. You also
can enter a mnemonic name for a commonly used
value.
• Specify a packet marking category to set the
precedence value of the packet.
• cos—Sets a value from the CoS or user priority.
• dscp—Sets a value from packet differentiated
services code point (DSCP).
• precedence—Sets a value from packet
precedence.
• qos-group—Sets a value from the QoS group.
• (Optional)table table-map-name—Indicates that the
values set in a specified table map will be used to set
the precedence value. Enter the name of the table map
used to specify the precedence value. The table map
name can be a maximum of 64 alphanumeric
characters.
If you specify a packet-marking category but do not
specify the table map, the default action is to copy the
value associated with the packet-marking category as
the precedence value. For example, if you enter the
set precedence cos command, the CoS value
(packet-marking category) is copied and used as the
precedence value.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1377
QoS
set
qos-group Assigns a QoS group identifier that can be used later to
classify packets.
• qos-group-value—Sets a QoS value to the classified
traffic. The range is 0 to 31. You also can enter a
mnemonic name for a commonly used value.
• dscp—Sets the original DSCP field value of the packet
as the QoS group value.
• precedence—Sets the original precedence field value
of the packet as the QoS group value.
• (Optional)table table-map-name—Indicates that the
values set in a specified table map will be used to set
the DSCP or precedence value. Enter the name of the
table map used to specify the value. The table map
name can be a maximum of 64 alphanumeric
characters.
If you specify a packet-marking category (dscp or
precedence) but do not specify the table map, the
default action is to copy the value associated with the
packet-marking category as the QoS group value. For
example, if you enter the set qos-group precedence
command, the precedence value (packet-marking
category) is copied and used as the QoS group value.
Command Default No traffic classification is defined.
Command Modes Policy-map class configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was intro
Usage Guidelines For the set dscp dscp-value command, the set cos cos-value command, and the set ip precedence
precedence-value command, you can enter a mnemonic name for a commonly used value. For example, you
can enter the set dscp af11 command, which is the same as entering the set dscp 10 command. You can enter
the set ip precedence critical command, which is the same as entering the set ip precedence 5 command.
For a list of supported mnemonics, enter the set dscp ? or the set ip precedence ? command to see the
command-line help strings.
When you configure the set dscp coscommand, note the following: The CoS value is a 3-bit field, and the
DSCP value is a 6-bit field. Only the three bits of the CoS field are used.
When you configure the set dscp qos-group command, note the following:
• The valid range for the DSCP value is a number from 0 to 63. The valid value range for the QoS group
is a number from 0 to 99.
• If a QoS group value falls within both value ranges (for example, 44), the packet-marking value is copied
and the packets is marked.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1378
QoS
set
• If QoS group value exceeds the DSCP range (for example, 77), the packet-marking value is not be copied
and the packet is not marked. No action is taken.
The set qos-group command cannot be applied until you create a service policy in policy-map configuration
mode and then attach the service policy to an interface or ATM virtual circuit (VC).
To return to policy-map configuration mode, use the exit command. To return to privileged EXEC mode, use
the end command.
Examples This example shows how to assign DSCP 10 to all FTP traffic without any policers:
Device(config)# policy-map policy_ftp
Device(config-pmap)# class-map ftp_class
Device(config-cmap)# exit
Device(config)# policy policy_ftp
Device(config-pmap)# class ftp_class
Device(config-pmap-c)# set dscp 10
Device(config-pmap)# exit
You can verify your settings by entering the show policy-map privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1379
QoS
show auto qos
show auto qos
To display the quality of service (QoS) commands entered on the interfaces on which automatic QoS (auto-QoS)
is enabled, use the show auto qos command in privileged EXEC mode.
show auto qos [interface [interface-id]]
Syntax Description interface (Optional) Displays auto-QoS information for the specified port or for all ports. Valid
[interface-id] interfaces include physical ports.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show auto qos command output shows only the auto qos command entered on each interface. The show
auto qos interface interface-id command output shows the auto qos command entered on a specific interface.
Use the show running-config privileged EXEC command to display the auto-QoS configuration and the user
modifications.
Examples This is an example of output from the show auto qos command after the auto qos voip cisco-phone
and the auto qos voip cisco-softphone interface configuration commands are entered:
Device# show auto qos
Gigabitethernet 2/0/4
auto qos voip cisco-softphone
Gigabitethernet 2/0/5
auto qos voip cisco-phone
Gigabitethernet 2/0/6
auto qos voip cisco-phone
This is an example of output from the show auto qos interface interface-id command when the auto
qos voip cisco-phone interface configuration command is entered:
Device# show auto qos interface Gigabitethernet 2/0/5
Gigabitethernet 2/0/5
auto qos voip cisco-phone
These are examples of output from the show auto qos interface interface-id command when auto-QoS
is disabled on an interface:
Device# show auto qos interface Gigabitethernet 3/0/1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1380
QoS
show auto qos
AutoQoS is disabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1381
QoS
show class-map
show class-map
To display quality of service (QoS) class maps, which define the match criteria to classify traffic, use the
show class-map command in EXEC mode.
show class-map [class-map-name | type control subscriber {all | class-map-name}]
Syntax Description class-map-name (Optional) Class map name.
type control subscriber (Optional) Displays information about control class maps.
all (Optional) Displays information about all control class maps.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples This is an example of output from the show class-map command:
Device# show class-map
Class Map match-any videowizard_10-10-10-10 (id 2)
Match access-group name videowizard_10-10-10-10
Class Map match-any class-default (id 0)
Match any
Class Map match-any dscp5 (id 3)
Match ip dscp 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1382
QoS
show platform hardware fed switch
show platform hardware fed switch
To display device-specific hardware information, use the show platform hardware fed switchswitch_number
command.
This topic elaborates only the QoS-specific options, that is, the options available with the show platform
hardware fed switch {switch_num | active | standby } qos command.
show platform hardware fed switch {switch_num | active | standby} qos {afd | {config type type | [{asic
asic_num}] | stats clients {all | bssid id | wlanid id }} | dscp-cos counters {iifd_id id | interfacetype number}
| le-info | {iifd_id id | interface type number} | policer config {iifd_id id | interface type number} | queue
| {config | {iifd_id id | interface type number | internal port-type type {asic number [{port_num}]}} |
label2qmap | [{aqmrepqostbl | iqslabeltable | sqslabeltable}] | {asicnumber} | stats | {iifd_id id | interface
type number | internal {cpu policer | port-type type asic number}{asicnumber [{port_num}]}}} | resource}
Syntax Description switch {switch_num | Switch for which you want to display information. You have the following options:
active | standby }
• switch_num—ID of the switch.
• active—Displays information relating to the active switch.
• standby—Displays information relating to the standby switch, if available.
qos Displays QoS hardware information. You must choose from the following options:
• afd —Displays Approximate Fair Drop (AFD) information in hardware.
• dscp-cos—Displays information dscp-cos counters for each port.
• leinfo—Displays logical entity information.
• policer—Displays QoS policer information in hardware.
• queue—Displays queue information in hardware.
• resource—Displays hardware resource information.
afd {config type | You must choose from the options under config type or stats client :
stats client }
config type:
• client—Displays wireless client information
• port—Displays port-specific information
• radio—Displays wireless radio information
• ssid—Displays wireless SSID information
stats client :
• all—Displays statistics of all client.
• bssid—Valid range is from 1 to 4294967295.
• wlanid—Valid range is from to 1 4294967295
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1383
QoS
show platform hardware fed switch
asicasic_num (Optional) ASIC number. Valid range is from 0 to 255.
dscp-cos counters { Displays per port dscp-cos counters. You must choose from the following options
iifd_id id | interface under dscp-cos counters:
type number }
• iif_id id—The target interface ID. Valid range is from 1 to 4294967295.
• interface type number—Target interface type and ID.
leinfo You must choose from the following options under dscp-cos counters:
• iif_id id—The target interface ID. Valid range is from 1 to 4294967295.
• interface type number—Target interface type and ID.
policer config Displays configuration information related to policers in hardware. You must
choose from the following options:
• iif_id id—The target interface ID. Valid range is from 1 to 4294967295.
• interface type number—Target interface type and ID.
queue {config {iif_id Displays queue information in hardware. You must choose from the following
id | interface type options:
number | internal}
• config—Configuration information. You must choose from the following
| label2qmap |
options:
stats}
• iif_id id—The target interface ID. Valid range is from 1 to 4294967295.
• interface type number—Target interface type and ID.
• internal—Displays internal queue related information.
• label2qmap—Displays hardware label to queue mapping information. You
can choose from the following options:
• (Optional) aqmrepqostbl— AQM REP QoS label table lookup.
• (Optional) iqslabeltable—IQS QoS label table lookup.
• (Optional) sqslabeltable—SQS and local QoS label table lookup.
• stats—Displays queue statistics. You must choose from the following options:
• iif_id id—The target interface ID. Valid range is from 1 to 4294967295.
• interface type number—Target interface type and ID.
• internal {cpu policer | port_type port_type asic asic_num [
port_num port_num ] }—Displays internal queue related information.
resource Displays hardware resource usage information. You must enter the following
keyword: usage
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1384
QoS
show platform hardware fed switch
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of output from theshow platform hardware fed switchswitch_numberqos queue
stats internal cpu policer command
Device#show platform hardware fed switch 3 qos queue stats internal cpu policer
(default) (set)
QId PlcIdx Queue Name Enabled Rate Rate Drop
------------------------------------------------------------------------
0 11 DOT1X Auth No 1000 1000 0
1 1 L2 Control No 500 500 0
2 14 Forus traffic No 1000 1000 0
3 0 ICMP GEN Yes 200 200 0
4 2 Routing Control Yes 1800 1800 0
5 14 Forus Address resolution No 1000 1000 0
6 3 ICMP Redirect No 500 500 0
7 6 WLESS PRI-5 No 1000 1000 0
8 4 WLESS PRI-1 No 1000 1000 0
9 5 WLESS PRI-2 No 1000 1000 0
10 6 WLESS PRI-3 No 1000 1000 0
11 6 WLESS PRI-4 No 1000 1000 0
12 0 BROADCAST Yes 200 200 0
13 10 Learning cache ovfl Yes 100 100 0
14 13 Sw forwarding Yes 1000 1000 0
15 8 Topology Control No 13000 13000 0
16 12 Proto Snooping No 500 500 0
17 16 DHCP Snooping No 1000 1000 0
18 9 Transit Traffic Yes 500 500 0
19 10 RPF Failed Yes 100 100 0
20 15 MCAST END STATION Yes 2000 2000 0
21 13 LOGGING Yes 1000 1000 0
22 7 Punt Webauth No 1000 1000 0
23 10 Crypto Control Yes 100 100 0
24 10 Exception Yes 100 100 0
25 3 General Punt No 500 500 0
26 10 NFL SAMPLED DATA Yes 100 100 0
27 2 SGT Cache Full Yes 1800 1800 0
28 10 EGR Exception Yes 100 100 0
29 16 Show frwd No 1000 1000 0
30 9 MCAST Data Yes 500 500 0
31 10 Gold Pkt Yes 100 100 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1385
QoS
show platform software fed switch qos
show platform software fed switch qos
To display device-specific software information, use the show platform hardware fed switch switch_number
command.
This topic elaborates only the QoS-specific options available with the show platform software fed switch
{switch_num | active | standby } qos command.
show platform software fed switch{switch number | active | standby }qos{avc | internal | label2qmap |
nflqos | policer | policy | qsb | tablemap}
Syntax Description switch The device for which you want to display information.
{switch_num |
• switch_num—Enter the switch ID. Displays information for the specified switch.
active | standby
} • active—Displays information for the active switch.
• standby—Displays information for the standby switch, if available.
qos Displays QoS software information. Choose one the following options:
• avc : Displays Application Visibility and Control (AVC) QoS information.
• internal: Displays internal queue-related information.
• label2qmap: Displays label to queue map table information.
• nflqos: Displays NetFlow QoS information.
• policer: Displays QoS policer information in hardware.
• policy: Displays QoS policy information.
• qsb: Displays QoS sub-block information.
• tablemap: Displays table mapping information for QoS egress and ingress queues.
• stack-buffer: Displays information on the stacking mode of the device. If the
stacking mode is disabled, the device is in standalone mode.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.12.1 Introduced the keyword
stack-buffer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1386
QoS
show platform software fed switch qos qsb
show platform software fed switch qos qsb
To display QoS sub-block information, use the show platform software fed switch switch_number qos qsb
command.
show platform software fed switch{switch number | active | standby}qosqsb{brief | [{all | type |
{clientclient_id | port port_number | radioradio_type | ssidssid}}] | iif_idid | interface |
{Auto-Templateinterface_number | BDIinterface_number | Capwapinterface_number |
GigabitEthernetinterface_number | InternalInterfaceinterface_number | Loopbackinterface_number |
Nullinterface_number | Port-channelinterface_number | TenGigabitEthernetinterface_number |
Tunnelinterface_number | Vlaninterface_number}}
Syntax Description switch The switch for which you want to display information.
{switch_num |
• switch_num—Enter the ID of the switch. Displays information for the specified
active | standby
switch.
}
• active—Displays information for the active switch.
• standby—Displays information for the standby switch, if available.
qos qsb Displays QoS sub-block software information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1387
QoS
show platform software fed switch qos qsb
qsb {brief | iif_id | brief
interface}
• all—Displays information for all client.
• type—Displays qsb information for the specified target type:
• client—Displays QoS qsb information for wireless clients
• port—Displays port-specific information
• radio—Displays QoS qsb information for wireless radios
• ssid—Displays QoS qsb information for wireless networks
iif_id—Displays information for the iif_ID
interface—Displays QoS qsb information for the specified interface:
• Auto-Template—Auto-template interface between 1 and 999.
• BDI—Bridge-domain interface between 1 and 16000.
• Capwap—CAPWAP interface between 0 and 2147483647.
• GigabitEthernet—GigabitEthernet interface between 0 and 9.
• InternalInterface—Internal interface between 0 and 9.
• Loopback—Loopback interface between 0 and 2147483647.
• Null—Null interface 0-0
• Port-Channel—Port-channel interface between 1 and 128.
• TenGigabitEthernet—TenGigabitEthernet interface between 0 and 9.
• Tunnel—Tunnel interface between 0 and 2147483647.
• Vlan—VLAN interface between 1 and 4094.
Command Modes User EXEC
Privileged EXEC
Command History Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of the output for theshow platform software fed switchswitch_numberqos qsb
command
Device#sh pl so fed sw 3 qos qsb interface g3/0/2
QoS subblock information:
Name:GigabitEthernet3/0/2 iif_id:0x0000000000007b iif_type:ETHER(146)
qsb ptr:0xffd8573350
Port type = Wired port
asic_num:0 is_uplink:false init_done:true
FRU events: Active-0, Inactive-0
def_qos_label:0 def_le_priority:13
trust_enabled:false trust_type:TRUST_DSCP ifm_trust_type:1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1388
QoS
show platform software fed switch qos qsb
LE priority:13 LE trans_index(in, out): (0,0)
Stats (plc,q) export counters (in/out): 0/0
Policy Info:
Ingress Policy: pmap::{(0xffd8685180,AutoQos-4.0-CiscoPhone-Input-Policy,1083231504,)}
tcg::{0xffd867ad10,GigabitEthernet3/0/2 tgt(0x7b,IN) level:0 num_tccg:4 num_child:0},
status:VALID,SET_INHW
Egress Policy: pmap::{(0xffd86857d0,AutoQos-4.0-Output-Policy,1076629088,)}
tcg::{0xffd8685b40,GigabitEthernet3/0/2 tgt(0x7b,OUT) level:0 num_tccg:8 num_child:0},
status:VALID,SET_INHW
TCG(in,out):(0xffd867ad10, 0xffd8685b40) le_label_id(in,out):(2, 1)
Policer Info:
num_ag_policers(in,out)[1r2c,2r3c]: ([0,0],[0,0])
num_mf_policers(in,out): (0,0)
num_afd_policers:0
[ag_plc_handle(in,out) = (0xd8688220,0)]
[mf_plc_handle(in,out)=((nil),(nil)) num_mf_policers:(0,0)
base:(0xffffffff,0xffffffff) rc:(0,0)]
Queueing Info:
def_queuing = 0, shape_rate:0 interface_rate_kbps:1000000
Port shaper:false
lbl_to_qmap_index:1
Physical qparams:
Queue Config: NodeType:Physical Id:0x40000049 parent:0x40000049 qid:0 attr:0x1 defq:0
PARAMS: Excess Ratio:1 Min Cir:1000000 QBuffer:0
Queue Limit Type:Single Unit:Percent Queue Limit:44192
SHARED Queue
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1389
QoS
show policy-map
show policy-map
To display quality of service (QoS) policy maps, which define classification criteria for incoming traffic, use
the show policy-map command in EXEC mode.
show policy-map [{policy-map-name | interface interface-id}]
show policy-map interface {Auto-template | Capwap | GigabitEthernet | GroupVI |
InternalInterface | Loopback | Lspvif | Null | Port-channel | TenGigabitEthernet | Tunnel
| Vlan | brief | class | input | output}
show policy-map type control subscriber detail
Syntax Description policy-map-name (Optional) Name of the policy-map.
interface interface-id (Optional) Displays the statistics and the configurations of the input and
output policies that are attached to the interface.
type control subscriber detail (Optional) Identifies the type of QoS policy and the statistics.
Command Modes User EXEC
Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command w
Usage Guidelines Policy maps can include policers that specify the bandwidth limitations and the action to take if the limits are
exceeded.
Note Though visible in the command-line help string, the control-plane, session, and type keywords are not
supported, and the statistics shown in the display should be ignored.
This is an example of the output for the show policy-map interface command.
Device# show policy-map interface gigabitethernet 1/0/48
Service-policy output: port_shape_parent
Class-map: class-default (match-any)
191509734 packets
Match: any
Queueing
(total drops) 524940551420
(bytes output) 14937264500
shape (average) cir 250000000, bc 2500000, be 2500000
target shape rate 250000000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1390
QoS
show policy-map
Service-policy : child_trip_play
queue stats for all priority classes:
Queueing
priority level 1
(total drops) 524940551420
(bytes output) 14937180648
queue stats for all priority classes:
Queueing
priority level 2
(total drops) 0
(bytes output) 0
Class-map: dscp56 (match-any)
191508445 packets
Match: dscp cs7 (56)
0 packets, 0 bytes
5 minute rate 0 bps
Priority: Strict,
Priority Level: 1
police:
cir 10 %
cir 25000000 bps, bc 781250 bytes
conformed 0 bytes; actions: >>>>>counters not supported
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceeded 0000 bps >>>>>counters not supported
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1391
QoS
show tech-support qos
show tech-support qos
To display quality of service (QoS)-related information for use by technical support, use the show tech-support
qos command in privileged EXEC mode.
show tech-support qos [{switch {switch-number | active | all | standby} | [{control-plane | interface
{interface-name | all}}]}]
Syntax Description switch switch-number (Optional) Displays QoS-related
information for a specific switch.
active (Optional) Displays QoS-related
information for the active instance
of the switch.
all (Optional) Displays QoS-related
information for all instances of the
switch.
standby (Optional) Displays QoS-related
information for the standby instance
of the switch.
control-plane (Optional) Displays QoS-related
information for the control-plane.
interface interface-name (Optional) Displays QoS-related
information for a specified interface.
all (Optional) Displays QoS-related
information for all interfaces.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Usage Guidelines The output of this command is very long. To better manage this output, you can redirect the output to an
external file (for example, show tech-support qos | redirect flash: filename) in the local writable storage
file system or remote file system.
The output of the show tech-support qos command displays a list of commands and their output. These
commands differ based on the platform.
Examples The following is sample output from the show tech-support qos command:
Device# show tech-support qos
.
.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1392
QoS
show tech-support qos
.
------------------ show platform software fed switch 1 qos policy target brief
------------------
TCG summary for policy: system-cpp-policy
Loc Interface IIF-ID Dir tccg Child #m/p/q State:(cfg,opr)
--- --------------------- ---------------- --- ---- ----- ------- ---------------
?:255 Control Plane 0x00000001000001 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4da31c8
?:0 CoPP-Queue-0 0x0000000100000d OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4da41e8
?:0 CoPP-Queue-1 0x0000000100000e OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dbede8
?:0 CoPP-Queue-2 0x0000000100000f OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dc2df8
?:0 CoPP-Queue-3 0x00000001000010 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dc6e08
?:0 CoPP-Queue-4 0x00000001000011 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dcae18
?:0 CoPP-Queue-5 0x00000001000012 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dcee28
?:0 CoPP-Queue-6 0x00000001000013 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dd2e38
?:0 CoPP-Queue-7 0x00000001000014 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dd6e48
?:0 CoPP-Queue-8 0x00000001000015 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4ddae58
?:0 CoPP-Queue-9 0x00000001000016 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4ddee68
?:0 CoPP-Queue-10 0x00000001000017 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4de2e78
?:0 CoPP-Queue-11 0x00000001000018 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4de6e88
?:0 CoPP-Queue-12 0x00000001000019 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4deae98
?:0 CoPP-Queue-13 0x0000000100001a OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4deeea8
?:0 CoPP-Queue-14 0x0000000100001b OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4df2eb8
?:0 CoPP-Queue-15 0x0000000100001c OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4df6ec8
?:0 CoPP-Queue-16 0x0000000100001d OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dfaed8
?:0 CoPP-Queue-17 0x0000000100001e OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4dfeee8
?:0 CoPP-Queue-18 0x0000000100001f OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e02ef8
?:0 CoPP-Queue-19 0x00000001000020 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e06f08
?:0 CoPP-Queue-20 0x00000001000021 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e0ae88
?:0 CoPP-Queue-21 0x00000001000022 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e0ee98
?:0 CoPP-Queue-22 0x00000001000023 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e12ea8
?:0 CoPP-Queue-23 0x00000001000024 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e16eb8
?:0 CoPP-Queue-24 0x00000001000025 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e1aec8
?:0 CoPP-Queue-25 0x00000001000026 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e1eed8
?:0 CoPP-Queue-26 0x00000001000027 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e22ee8
?:0 CoPP-Queue-27 0x00000001000028 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e26ef8
?:0 CoPP-Queue-28 0x00000001000029 OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e2af08
?:0 CoPP-Queue-29 0x0000000100002a OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e2ef18
?:0 CoPP-Queue-30 0x0000000100002b OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e32f28
?:0 CoPP-Queue-31 0x0000000100002c OUT 22 0 0/17/0 VALID,SET_INHW 0xffe4e36f38
------------------ show platform software fed switch 1 qos policy summary ------------------
Policymap Summary: (counters)
CGID Clases Targets Child CfgErr InHw OpErr Policy Name
---------- ------ ------- ----- ------ ----- ----- ------------------
15212688 22 33 0 0 33 0 system-cpp-policy
.
.
.
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1393
QoS
trust device
trust device
To configure trust for supported devices connected to an interface, use the trust device command in interface
configuration mode. Use the no form of this command to disable trust for the connected device.
trust device {cisco-phone | cts | ip-camera | media-player}
no trust device {cisco-phone | cts | ip-camera | media-player}
Syntax Description cisco-phone Configures a Cisco IP phone
cts Configures a Cisco TelePresence System
ip-camera Configures an IP Video Surveillance Camera (IPVSC)
media-player Configures a Cisco Digital Media Player (DMP)
Command Default Trust disabled
Command Modes Interface configuration
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the trust device command on the following types of interfaces:
• Auto— auto-template interface
• Capwap—CAPWAP tunnel interface
• GigabitEthernet—Gigabit Ethernet IEEE 802
• GroupVI—Group virtual interface
• Internal Interface—Internal interface
• Loopback—Loopback interface
• Null—Null interface
• Port-channel—Ethernet Channel interface
• TenGigabitEthernet--10-Gigabit Ethernet
• Tunnel—Tunnel interface
• Vlan—Catalyst VLANs
• range—interface range command
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1394
QoS
trust device
Example
The following example configures trust for a Cisco IP phone in Interface GigabitEthernet 1/0/1:
Device(config)# interface gigabitethernet 1/0/1
Device(config-if)# trust device cisco-phone
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1395
QoS
trust device
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1396
PA R T X
Routing
• IP Routing Commands, on page 1399
IP Routing Commands
• accept-lifetime, on page 1401
• address-family ipv6 (OSPF), on page 1404
• address-family l2vpn, on page 1405
• aggregate-address, on page 1408
• area nssa, on page 1411
• area virtual-link, on page 1413
• auto-summary (BGP), on page 1416
• authentication (BFD), on page 1419
• bfd, on page 1420
• bfd all-interfaces, on page 1422
• bfd check-ctrl-plane-failure, on page 1423
• bfd echo, on page 1424
• bfd slow-timers, on page 1426
• bfd template, on page 1428
• bfd-template single-hop, on page 1429
• bgp graceful-restart, on page 1430
• clear proximity ip bgp, on page 1432
• default-information originate (OSPF), on page 1436
• default-metric (BGP), on page 1438
• distance (OSPF), on page 1440
• eigrp log-neighbor-changes, on page 1443
• ip authentication key-chain eigrp, on page 1445
• ip authentication mode eigrp, on page 1446
• ip bandwidth-percent eigrp, on page 1447
• ip cef load-sharing algorithm, on page 1448
• ip community-list, on page 1449
• ip prefix-list, on page 1454
• ip hello-interval eigrp, on page 1457
• ip hold-time eigrp, on page 1458
• ip load-sharing, on page 1459
• ip network-broadcast, on page 1460
• ip ospf database-filter all out, on page 1461
• ip ospf name-lookup, on page 1462
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1399
Routing
• ip split-horizon eigrp, on page 1463
• ip summary-address eigrp, on page 1464
• ip route static bfd, on page 1466
• ipv6 route static bfd, on page 1468
• metric weights (EIGRP), on page 1469
• neighbor advertisement-interval, on page 1471
• neighbor default-originate, on page 1473
• neighbor description, on page 1475
• neighbor ebgp-multihop, on page 1476
• neighbor maximum-prefix (BGP), on page 1477
• neighbor peer-group (assigning members), on page 1479
• neighbor peer-group (creating), on page 1481
• neighbor route-map, on page 1484
• neighbor update-source, on page 1486
• network (BGP and multiprotocol BGP), on page 1488
• network (EIGRP), on page 1490
• nsf (EIGRP), on page 1492
• offset-list (EIGRP), on page 1494
• redistribute (IP), on page 1496
• redistribute (IPv6), on page 1504
• redistribute maximum-prefix (OSPF), on page 1507
• rewrite-evpn-rt-asn, on page 1509
• route-map, on page 1510
• router-id, on page 1513
• router bgp, on page 1514
• router eigrp, on page 1517
• router ospf, on page 1518
• router ospfv3, on page 1520
• send-lifetime, on page 1521
• set community, on page 1524
• set ip next-hop (BGP), on page 1526
• show ip bgp, on page 1528
• show ip bgp neighbors, on page 1540
• show ip bgp ipv6 unicast, on page 1555
• show ip eigrp interfaces, on page 1557
• show ip eigrp neighbors, on page 1560
• show ip eigrp topology, on page 1563
• show ip eigrp traffic, on page 1568
• show ip ospf, on page 1570
• show ip ospf border-routers, on page 1578
• show ip ospf database, on page 1579
• show ip ospf interface, on page 1588
• show ip ospf neighbor, on page 1591
• show ip ospf virtual-links, on page 1597
• summary-address (OSPF), on page 1598
• timers throttle spf, on page 1600
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1400
Routing
accept-lifetime
accept-lifetime
To set the time period during which the authentication key on a key chain is received as valid, use the
accept-lifetime command in key chain key configuration mode. To revert to the default value, use the no
form of this command.
accept-lifetime [ local ] start-time { infinite end-time | duration seconds }
no accept-lifetime
Syntax Description local Specifies the time in local timezone.
start-time Beginning time that the key specified by the key command is valid to be received. The
syntax can be either of the following:
hh : mm : ss month date year
hh : mm : ss date month year
• hh: Hours
• mm: Minutes
• ss: Seconds
• month: First three letters of the month
• date: Date (1-31)
• year: Year (four digits)
The default start time and the earliest acceptable date is January 1, 1993.
infinite Key is valid to be received from the start-time value on.
end-time Key is valid to be received from the start-time value until the end-timevalue. The syntax
is the same as that for the start-timevalue. The end-time value must be after the
start-timevalue. The default end time is an infinite time period.
duration seconds Length of time (in seconds) that the key is valid to be received. The range is from 1 to
2147483646.
Command Default The authentication key on a key chain is received as valid forever (the starting time is January 1, 1993, and
the ending time is infinite).
Command Modes Key chain key configuration (config-keychain-key)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Bengaluru 17.5.1 The new range of the duration keyword is from 1 to 2147483646.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1401
Routing
accept-lifetime
Usage Guidelines Only DRP Agent, Enhanced Interior Gateway Routing Protocol (EIGRP), and Routing Information Protocol
( RIP) Version 2 use key chains.
Specify a start-time value and one of the following values: infinite, end-time, or duration seconds.
We recommend running Network Time Protocol (NTP) or some other time synchronization method if you
assign a lifetime to a key.
If the last key expires, authentication will continue and an error message will be generated. To disable
authentication, you must manually delete the last valid key.
Examples The following example configures a key chain named chain1. The key named key1 will be accepted
from 1:30 p.m. to 3:30 p.m. and will be sent from 2:00 p.m. to 3:00 p.m. The key named key2 will
be accepted from 2:30 p.m. to 4:30 p.m. and will be sent from 3:00 p.m. to 4:00 p.m. The overlap
allows for migration of keys or a discrepancy in the set time of the router. There is a 30-minute
leeway on each side to handle time differences.
Device(config)# interface GigabitEthernet1/0/1
Device(config-if)# ip rip authentication key-chain chain1
Device(config-if)# ip rip authentication mode md5
Device(config-if)# exit
Device(config)# router rip
Device(config-router)# network 172.19.0.0
Device(config-router)# version 2
Device(config-router)# exit
Device(config)# key chain chain1
Device(config-keychain)# key 1
Device(config-keychain-key)# key-string key1
Device(config-keychain-key)# accept-lifetime 13:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 14:00:00 Jan 25 1996 duration 3600
Device(config-keychain-key)# exit
Device(config-keychain)# key 2
Device(config-keychain)# key-string key2
Device(config-keychain)# accept-lifetime 14:30:00 Jan 25 1996 duration 7200
Device(config-keychain)# send-lifetime 15:00:00 Jan 25 1996 duration 3600
The following example configures a key chain named chain1 for EIGRP address-family. The key
named key1 will be accepted from 1:30 p.m. to 3:30 p.m. and be sent from 2:00 p.m. to 3:00 p.m.
The key named key2 will be accepted from 2:30 p.m. to 4:30 p.m. and be sent from 3:00 p.m. to 4:00
p.m. The overlap allows for migration of keys or a discrepancy in the set time of the router. There
is a 30-minute leeway on each side to handle time differences.
Device(config)# router eigrp 10
Device(config-router)# address-family ipv4 autonomous-system 4453
Device(config-router-af)# network 10.0.0.0
Device(config-router-af)# af-interface ethernet0/0
Device(config-router-af-interface)# authentication key-chain trees
Device(config-router-af-interface)# authentication mode md5
Device(config-router-af-interface)# exit
Device(config-router-af)# exit
Device(config-router)# exit
Device(config)# key chain chain1
Device(config-keychain)# key 1
Device(config-keychain-key)# key-string key1
Device(config-keychain-key)# accept-lifetime 13:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 14:00:00 Jan 25 1996 duration 3600
Device(config-keychain-key)# exit
Device(config-keychain)# key 2
Device(config-keychain-key)# key-string key2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1402
Routing
accept-lifetime
Device(config-keychain-key)# accept-lifetime 14:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 15:00:00 Jan 25 1996 duration 3600
Related Commands Command Description
key Identifies an authentication key on a key chain.
key chain Defines an authentication key-chain needed to enable authentication for
routing protocols.
key-string (authentication) Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain is
valid to be sent.
show key chain Displays authentication key information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1403
Routing
address-family ipv6 (OSPF)
address-family ipv6 (OSPF)
To enter the address family configuration mode for configuring routing sessions, such as Open Shortest Path
First (OSPF), that uses the standard IPv6 address prefixes, use the address-family ipv6 command in the router
configuration mode. To disable the address family configuration mode, use the no form of this command.
address-family ipv6 [unicast ][{vrf vrf-name }]
no address-family ipv6 [unicast ][{vrf vrf-name }]
Syntax Description unicast (Optional) Specifies the IPv6 unicast address prefixes.
vrf (Optional) Specifies all the VPN routing and forwarding (VRF) instance tables or a specific VRF
table for an IPv6 address.
vrf-name (Optional) A specific VRF table for an IPv6 address.
Command Default IPv6 address prefixes are not enabled. Unicast address prefixes are the default when the IPv6 address prefixes
are configured.
Command Modes Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command w
Usage Guidelines The address-family ipv6 command places the router in address family configuration mode (prompt:
config-router-af), from which you can configure routing sessions that use the standard IPv6 address prefixes.
Examples The following example shows how to place the router in address family configuration mode:
Device> enable
Device# configure terminal
Device(config)# router ospfv3 1
Device(config-router)# address-family ipv6 unicast
Device(config-router-af)#
Related Commands Command Description
router ospfv3 Enters OSPFv3 router configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1404
Routing
address-family l2vpn
address-family l2vpn
To enter address family configuration mode to configure a routing session using Layer 2 Virtual Private
Network (VPN) endpoint provisioning address information, use the address-family l2vpn command in router
configuration mode. To remove the Layer 2 VPN address family configuration from the running configuration,
use the no form of this command.
address-family l2vpn [{evpn | vpls}]
no address-family l2vpn [{evpn | vpls}]
Syntax Description evpn (Optional) Specifies L2VPN Ethernet Virtual Private
Network (EVPN) endpoint provisioning address
information.
vpls (Optional) Specifies L2VPN Virtual Private LAN
Service (VPLS) endpoint provisioning address
information.
Command Default No Layer 2 VPN endpoint provisioning support is enabled.
Command Modes
Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was
introduced.
Usage Guidelines The address-family l2vpn command places the device in address family configuration mode (prompt:
config-router-af), from which you can configure routing sessions that support Layer 2 VPN endpoint
provisioning.
BGP support for the Layer 2 VPN address family introduces a BGP-based autodiscovery mechanism to
distribute Layer 2 VPN endpoint provisioning information. BGP uses a separate Layer 2 VPN routing
information base (RIB) to store endpoint provisioning information, which is updated each time any Layer 2
virtual forwarding instance (VFI) is configured. Prefix and path information is stored in the Layer 2 VPN
database, allowing BGP to make best-path decisions. When BGP distributes the endpoint provisioning
information in an update message to all its BGP neighbors, the endpoint information is used to set up a
pseudowire mesh to support Layer 2 VPN-based services.
The BGP autodiscovery mechanism facilitates the setting up of Layer 2 VPN services, which are an integral
part of the Cisco IOS Virtual Private LAN Service (VPLS) feature. VPLS enables flexibility in deploying
services by connecting geographically dispersed sites as a large LAN over high-speed Ethernet in a robust
and scalable IP MPLS network.
The multiprotocol capability for address family Layer 2 VPN EVPN is advertised when the Address Family
Identifier (AFI) is enabled under the internal BGP (iBGP) and external BGP (eBGP) neighbors for both IPv4
and IPv6 neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1405
Routing
address-family l2vpn
Note Routing information for address family IPv4 is advertised by default for each BGP routing session configured
with the neighbor remote-as command unless you configure the no bgp default ipv4-unicast command
before configuring the neighbor remote-as command.
Examples In this example, two provider edge (PE) devices are configured with VPLS endpoint provisioning
information that includes Layer 2 VFI, VPN, and VPLS IDs. BGP neighbors are configured and
activated under Layer 2 VPN address family to ensure that the VPLS endpoint provisioning
information is saved to a separate Layer 2 VPN RIB and then distributed to other BGP peers in BGP
update messages. When the endpoint information is received by the BGP peers, a pseudowire mesh
is set up to support Layer 2 VPN-based services.
Device A
Device> enable
Device# configure terminal
Device(config)# l2 vfi customerA autodiscovery
Device(config-vfi)# vpn id 100
Device(config-vfi)# vpls-id 45000:100
Device(config-vfi)# exit
Device(config)# l2 vfi customerB autodiscovery
Device(config-vfi)# vpn id 200
Device(config-vfi)# vpls-id 45000:200
Device(config-vfi)# exit
Device(config)# router bgp 45000
Device(config-router)# no bgp default ipv4-unicast
Device(config-router)# bgp log-neighbor-changes
Device(config-router)# neighbor 172.16.1.2 remote-as 45000
Device(config-router)# neighbor 172.21.1.2 remote-as 45000
Device(config-router)# address-family l2vpn vpls
Device(config-router-af)# neighbor 172.16.1.2 activate
Device(config-router-af)# neighbor 172.16.1.2 send-community extended
Device(config-router-af)# neighbor 172.21.1.2 activate
Device(config-router-af)# neighbor 172.21.1.2 send-community extended
Device(config-router-af)# end
Device B
Device> enable
Device# configure terminal
Device(config)# l2 vfi customerA autodiscovery
Device(config-vfi)# vpn id 100
Device(config-vfi)# vpls-id 45000:100
Device(config-vfi)# exit
Device(config)# l2 vfi customerB autodiscovery
Device(config-vfi)# vpn id 200
Device(config-vfi)# vpls-id 45000:200
Device(config-vfi)# exit
Device(config)# router bgp 45000
Device(config-router)# no bgp default ipv4-unicast
Device(config-router)# bgp log-neighbor-changes
Device(config-router)# neighbor 172.16.1.1 remote-as 45000
Device(config-router)# neighbor 172.22.1.1 remote-as 45000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1406
Routing
address-family l2vpn
Device(config-router)# address-family l2vpn vpls
Device(config-router-af)# neighbor 172.16.1.1 activate
Device(config-router-af)# neighbor 172.16.1.1 send-community extended
Device(config-router-af)# neighbor 172.22.1.1 activate
Device(config-router-af)# neighbor 172.22.1.1 send-community extended
Device(config-router-af)# end
Related Commands Command Description
neighbor activate Enables the exchange of information with a BGP
neighboring router.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1407
Routing
aggregate-address
aggregate-address
To create an aggregate entry in a Border Gateway Protocol (BGP) database, use the aggregate-address
command in address family or router configuration mode. To disable this function, use the no form of this
command.
aggregate-address address mask [as-set] [as-confed-set] [summary-only] [suppress-map map-name]
[advertise-map map-name] [attribute-map map-name]
no aggregate-address address mask [as-set] [as-confed-set] [summary-only] [suppress-map
map-name] [advertise-map map-name] [attribute-map map-name]
Syntax Description address Aggregate address.
mask Aggregate mask.
as-set (Optional) Generates autonomous system set path information.
as-confed-set (Optional) Generates autonomous confederation set path information.
summary-only (Optional) Filters all more-specific routes from updates.
suppress-map map-name (Optional) Specifies the name of the route map used to select the routes to be
suppressed.
advertise-map map-name (Optional) Specifies the name of the route map used to select the routes to
create AS_SET origin communities.
attribute-map map-name (Optional) Specifies the name of the route map used to set the attribute of the
aggregate route.
Command Default The atomic aggregate attribute is set automatically when an aggregate route is created with this command
unless the as-set keyword is specified.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 146:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can implement aggregate routing in BGP and Multiprotocol BGP (mBGP) either by redistributing an
aggregate route into BGP or mBGP, or by using the conditional aggregate routing feature.
Using the aggregate-addresscommand with no keywords will create an aggregate entry in the BGP or mBGP
routing table if any more-specific BGP or mBGP routes are available that fall within the specified range. (A
longer prefix that matches the aggregate must exist in the Routing Information Base (RIB).) The aggregate
route will be advertised as coming from your autonomous system and will have the atomic aggregate attribute
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1408
Routing
aggregate-address
set to show that information might be missing. (By default, the atomic aggregate attribute is set unless you
specify the as-set keyword.)
Using the as-setkeyword creates an aggregate entry using the same rules that the command follows without
this keyword, but the path advertised for this route will be an AS_SET consisting of all elements contained
in all paths that are being summarized. Do not use this form of the aggregate-addresscommand when
aggregating many paths, because this route must be continually withdrawn and updated as autonomous system
path reachability information for the summarized routes changes.
Using the as-confed-set keyword creates an aggregate entry using the same rules that the command follows
without this keyword. This keyword performs the same function as the as-set keyword, except that it generates
autonomous confed set path information.
Using the summary-onlykeyword not only creates the aggregate route (for example, 192.*.*.*) but also
suppresses advertisements of more-specific routes to all neighbors. If you want to suppress only advertisements
to certain neighbors, you may use the neighbor distribute-list command, with caution. If a more-specific
route leaks out, all BGP or mBGP routers will prefer that route over the less-specific aggregate you are
generating (using longest-match routing).
Using the suppress-mapkeyword creates the aggregate route but suppresses advertisement of specified routes.
You can use the match clauses of route maps to selectively suppress some more-specific routes of the aggregate
and leave others unsuppressed. IP access lists and autonomous system path access lists match clauses are
supported.
Using the advertise-mapkeyword selects specific routes that will be used to build different components of
the aggregate route, such as AS_SET or community. This form of the aggregate-addresscommand is useful
when the components of an aggregate are in separate autonomous systems and you want to create an aggregate
with AS_SET, and advertise it back to some of the same autonomous systems. You must remember to omit
the specific autonomous system numbers from the AS_SET to prevent the aggregate from being dropped by
the BGP loop detection mechanism at the receiving router. IP access lists and autonomous system path access
lists match clauses are supported.
Using the attribute-mapkeyword allows attributes of the aggregate route to be changed. This form of the
aggregate-addresscommand is useful when one of the routes forming the AS_SET is configured with an
attribute such as the community no-export attribute, which would prevent the aggregate route from being
exported. An attribute map route map can be created to change the aggregate attributes.
AS-Set Example
In the following example, an aggregate BGP address is created in router configuration mode. The
path advertised for this route will be an AS_SET consisting of all elements contained in all paths
that are being summarized.
Device(config)#router bgp 50000
Device(config-router)#aggregate-address 10.0.0.0 255.0.0.0 as-set
Summary-Only Example
In the following example, an aggregate BGP address is created in address family configuration mode
and applied to the multicast database under the IP Version 4 address family. Because the
summary-only keyword is configured, more-specific routes are filtered from updates.
Device(config)#router bgp 50000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1409
Routing
aggregate-address
Device(config-router)#address-family ipv4 multicast
Device(config-router-af)#aggregate-address 10.0.0.0 255.0.0.0 summary-only
Conditional Aggregation Example
In the following example, a route map called MAP-ONE is created to match on an AS-path access
list. The path advertised for this route will be an AS_SET consisting of elements contained in paths
that are matched in the route map.
Device(config)#ip as-path access-list 1 deny ^1234_
Device(config)#ip as-path access-list 1 permit .*
Device(config)#!
Device(config)#route-map MAP-ONE
Device(config-route-map)#match ip as-path 1
Device(config-route-map)#exit
Device(config)#router bgp 50000
Device(config-router)#address-family ipv4
Device(config-router-af)#aggregate-address 10.0.0.0 255.0.0.0 as-set advertise-map
MAP-ONE
Router(config-router-af)#end
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard IPv4
address prefixes.
ip as-path access-list Defines a BGP autonomous system path access list.
match ip address Distributes any routes that have a destination network number address that
is permitted by a standard or extended access list, and performs policy routing
on packets.
neighbor distribute-list Distributes BGP neighbor information in an access list.
route-map (IP) Defines the conditions for redistributing routes from one routing protocol
into another, or enables policy routing.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1410
Routing
area nssa
area nssa
To configure a not-so-stubby area ( NSSA), use the area nssa command in router address family topology
or router configuration mode. To remove the NSSA distinction from the area, use the no form of this command.
area nssa commandarea area-id nssa [no-redistribution] [default-information-originate [metric]
[metric-type]] [no-summary] [nssa-only]
no area area-id nssa [no-redistribution] [default-information-originate [metric] [metric-type]]
[no-summary] [nssa-only]
Syntax Description area-id Identifier for the stub area or NSSA. The identifier can be specified as either
a decimal value or an IP address.
no-redistribution (Optional) Used when the router is an NSSA Area Border Router (ABR) and
you want the redistribute command to import routes only into the normal
areas, but not into the NSSA area.
default-information- (Optional) Used to generate a Type 7 default into the NSSA area. This
originate keyword takes effect only on the NSSA ABR or the NSSA Autonomous
System Boundary Router (ASBR).
metric (Optional) Specifies the OSPF default metric.
metric-type (Optional) Specifies the OSPF metric type for default routes.
no-summary (Optional) Allows an area to be an NSSA but not have summary routes
injected into it.
nssa-only (Optional) Limits the default advertisement to this NSSA area by setting the
propagate (P) bit in the type-7 LSA to zero.
Command Default No NSSA area is defined.
Command Modes Router address family topology configuration (config-router-af-topology) Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To remove the specified area from the software configuration, use the no area area-idcommand (with no
other keywords). That is, the no area area-id command removes all area options, including area
authentication, area default-cost, area nssa, area range, area stub, and area virtual-link.
Release 12.2(33)SRB
If you plan to configure the Multi-Topology Routing (MTR) feature, you need to enter the area nssacommand
in router address family topology configuration mode in order for this OSPF router configuration command
to become topology-aware.
Examples The following example makes area 1 an NSSA area:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1411
Routing
area nssa
router ospf 1
redistribute rip subnets
network 172.19.92.0 0.0.0.255 area 1
area 1 nssa
Related Commands Command Description
redistribute Redistributes routes from one routing domain into another routing domain.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1412
Routing
area virtual-link
area virtual-link
To define an Open Shortest Path First (OSPF) virtual link, use the area virtual-link command in router
address family topology, router configuration, or address family configuration mode. To remove a virtual
link, use the no form of this command.
area area-id virtual-link router-id authentication key-chain chain-name [hello-interval seconds]
[retransmit-interval seconds] [transmit-delay seconds] [dead-interval seconds] [ttl-security hops
hop-count]
no area area-id virtual-link router-id authentication key-chain chain-name
Table 147:
Syntax Description
area-id Area ID assigned to the virtual link. This can be either
a decimal value or a valid IPv6 prefix. There is no
default.
router-id Router ID associated with the virtual link neighbor.
The router ID appears in the show ip ospf or show
ipv6 display command. There is no default.
authentication Enables virtual link authentication.
key-chain Configures a key-chain for cryptographic
authentication keys.
chain-name Name of the authentication key that is valid.
hello-interval seconds (Optional) Specifies the time (in seconds) between
the hello packets that the Cisco IOS software sends
on an interface. The hello interval is an unsigned
integer value to be advertised in the hello packets.
The value must be the same for all routers and access
servers attached to a common network. The range is
from 1 to 8192. The default is 10.
retransmit-interval seconds (Optional) Specifies the time (in seconds) between
link-state advertisement (LSA) retransmissions for
adjacencies belonging to the interface. The retransmit
interval is the expected round-trip delay between any
two routers on the attached network. The value must
be greater than the expected round-trip delay. The
range is from 1 to 8192. The default is 5.
transmit-delay seconds (Optional) Specifies the estimated time (in seconds)
required to send a link-state update packet on the
interface. The integer value that must be greater than
zero. LSAs in the update packet have their age
incremented by this amount before transmission. The
range is from 1 to 8192. The default value is 1.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1413
Routing
area virtual-link
dead-interval seconds (Optional) Specifies the time (in seconds) that hello
packets are not seen before a neighbor declares the
router down. The dead interval is an unsigned integer
value. The default is four times the hello interval, or
40 seconds. As with the hello interval, this value must
be the same for all routers and access servers attached
to a common network.
ttl-security hops hop-count (Optional) Configures Time-to-Live (TTL) security
on a virtual link. The hop-count argument range is
from 1 to 254.
Command Default No OSPF virtual link is defined.
Command Modes Router address family topology configuration (config-router-af-topology)
Router configuration (config-router)
Address family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines In OSPF, all areas must be connected to a backbone area. A lost connection to the backbone can be repaired
by establishing a virtual link.
The shorter the hello interval, the faster topological changes will be detected, but more routing traffic will
ensue. The setting of the retransmit interval should be conservative, or needless retransmissions will result.
The value should be larger for serial lines and virtual links.
You should choose a transmit delay value that considers the transmission and propagation delays for the
interface.
To configure a virtual link in OSPF for IPv6, you must use a router ID instead of an address. In OSPF for
IPv6, the virtual link takes the router ID rather than the IPv6 prefix of the remote router.
Use the ttl-security hops hop-count keywords and argument to enable checking of TTL values on OSPF
packets from neighbors or to set TTL values sent to neighbors. This feature adds an extra layer of protection
to OSPF.
Note In order for a virtual link to be properly configured, each virtual link neighbor must include the transit area
ID and the corresponding virtual link neighbor router ID. To display the router ID, use the show ip ospf or
the show ipv6 ospf command in privileged EXEC mode.
Note To remove the specified area from the software configuration, use the no area area-id command (with no
other keywords). That is, the no area area-id command removes all area options, such as area default-cost,
area nssa, area range, area stub, and area virtual-link.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1414
Routing
area virtual-link
Release 12.2(33)SRB
If you plan to configure the Multitopology Routing (MTR) feature, you need to enter the area virtual-link
command in router address family topology configuration mode in order for this OSPF router configuration
command to become topology-aware.
Examples The following example establishes a virtual link with default values for all optional parameters:
Device(config)# ipv6 router ospf 1
Device(config)# log-adjacency-changes
Device(config)# area 1 virtual-link 192.168.255.1
The following example establishes a virtual link in OSPF for IPv6:
Device(config)# ipv6 router ospf 1
Device(config)# log-adjacency-changes
Device(config)# area 1 virtual-link 192.168.255.1 hello-interval 5
The following example shows how to configure TTL security for a virtual link in OSPFv3 for IPv6:
Device(config)# router ospfv3 1
Device(config-router)# address-family ipv6 unicast vrf vrf1
Device(config-router-af)# area 1 virtual-link 10.1.1.1 ttl-security hops 10
The following example shows how to configure the authentication using a key chain for virtual-links:
Device(config)# area 1 virtual-link 192.168.255.1 authentication key-chain ospf-chain-1
Related Commands Command Description
area Configures OSPFv3 area parameters.
show ip ospf Enables the display of general information about OSPF routing processes.
show ipv6 ospf Enables the display of general information about OSPF routing processes.
ttl-security hops Enables checking of TTL values on OSPF packets from neighbors or setting TTL values
sent to neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1415
Routing
auto-summary (BGP)
auto-summary (BGP)
To configure automatic summarization of subnet routes into network-level routes, use the auto-summary
command in address family or router configuration mode. To disable automatic summarization and send
subprefix routing information across classful network boundaries, use the no form of this command.
auto-summary
no auto-summary
Syntax Description This command has no arguments or keywords.
Command Default Automatic summarization is disabled by default (the software sends subprefix routing information across
classful network boundaries).
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines BGP automatically summarizes routes to classful network boundaries when this command is enabled. Route
summarization is used to reduce the amount of routing information in routing tables. Automatic summarization
applies to connected, static, and redistributed routes.
Note The MPLS VPN Per VRF Label feature does not support auto-summary.
By default, automatic summarization is disabled and BGP accepts subnets redistributed from an Interior
Gateway Protocol (IGP). To block subnets and create summary subprefixes to the classful network boundary
when crossing classful network boundaries, use the auto-summary command.
To advertise and carry subnet routes in BGP when automatic summarization is enabled, use an explicit network
command to advertise the subnet. The auto-summarycommand does not apply to routes injected into BGP
via the network command or through iBGP or eBGP.
Why auto-summary for BGP Is Disabled By Default
When auto-summary is enabled, routes injected into BGP via redistribution are summarized on a classful
boundary. Remember that a 32-bit IP address consists of a network address and a host address. The subnet
mask determines the number of bits used for the network address and the number of bits used for the host
address. The IP address classes have a natural or standard subnet mask, as shown in the table below.
Table 148: IP Address Classes
Class Address Range Standard Mask
A 1.0.0.0 to 126.0.0.0 255.0.0.0 or /8
B 128.1.0.0 to 191.254.0.0 255.255.0.0 or /16
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1416
Routing
auto-summary (BGP)
Class Address Range Standard Mask
C 192.0.1.0 to 223.255.254.0 255.255.255.0 or /24
Reserved addresses include 128.0.0.0, 191.255.0.0, 192.0.0.0, and 223.255.255.0.
When using the standard subnet mask, Class A addresses have one octet for the network, Class B addresses
have two octets for the network, and Class C addresses have three octets for the network.
Consider the Class B address 156.26.32.1 with a 24-bit subnet mask, for example. The 24-bit subnet mask
selects three octets, 156.26.32, for the network. The last octet is the host address. If the network 156.26.32.1/24
is learned via an IGP and is then redistributed into BGP, if auto-summary were enabled, the network would
be automatically summarized to the natural mask for a Class B network. The network that BGP would advertise
is 156.26.0.0/16. BGP would be advertising that it can reach the entire Class B address space from 156.26.0.0
to 156.26.255.255. If the only network that can be reached via the BGP router is 156.26.32.0/24, BGP would
be advertising 254 networks that cannot be reached via this router. This is why the auto-summary
(BGP)command is disabled by default.
Examples In the following example, automatic summarization is enabled for IPv4 address family prefixes:
Device(config)#router bgp 50000
Device(config-router)#address-family ipv4 unicast
Device(config-router-af)#auto-summary
Device(config-router-af)#network 7.7.7.7 255.255.255.255
In the example, there are different subnets, such as 7.7.7.6 and 7.7.7.7 on Loopback interface 6 and
Loopback interface 7, respectively. Both auto-summary and a network command are configured.
Device#show ip interface brief
Interface IP-Address OK? Method Status Protocol
Ethernet0/0 100.0.1.7 YES NVRAM up up
Ethernet0/1 unassigned YES NVRAM administratively down down
Ethernet0/2 unassigned YES NVRAM administratively down down
Ethernet0/3 unassigned YES NVRAM administratively down down
Ethernet1/0 108.7.9.7 YES NVRAM up up
Ethernet1/1 unassigned YES NVRAM administratively down down
Ethernet1/2 unassigned YES NVRAM administratively down down
Ethernet1/3 unassigned YES NVRAM administratively down down
Loopback6 7.7.7.6 YES NVRAM up up
Loopback7 7.7.7.7 YES NVRAM up up
Note that in the output below, because of the auto-summary command, the BGP routing table
displays the summarized route 7.0.0.0 instead of 7.7.7.6. The 7.7.7.7/32 network is displayed because
it was configured with the network command, which is not affected by the auto-summary command.
Device#show ip bgp
BGP table version is 10, local router ID is 7.7.7.7
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale, m multipath, b backup-path, x best-external
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 6.6.6.6/32 100.0.1.6 0 0 6 i
*> 7.0.0.0 0.0.0.0 0 32768 ? <-- summarization
*> 7.7.7.7/32 0.0.0.0 0 32768 i <-- network command
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1417
Routing
auto-summary (BGP)
r>i9.9.9.9/32 108.7.9.9 0 100 0 i
*> 100.0.0.0 0.0.0.0 0 32768 ?
r> 100.0.1.0/24 100.0.1.6 0 0 6 ?
*> 108.0.0.0 0.0.0.0 0 32768 ?
r>i108.7.9.0/24 108.7.9.9 0 100 0 ?
*>i200.0.1.0 108.7.9.9
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard IPv4 address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard VPNv4 address prefixes.
network (BGP and multiprotocol Specifies the networks to be advertised by BGP and multiprotocol BGP.
BGP)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1418
Routing
authentication (BFD)
authentication (BFD)
To configure authentication in a Bidirectional Forwarding Detection (BFD) template for single hop sessions,
use the authentication command in BFD configuration mode. To disable authentication in BFD template for
single-hop sessions, use the no form of this command
authentication authentication-type keychain keychain-name
no authentication authentication-type keychain keychain-name
Syntax Description authentication-type Authentication type. Valid values are md5, meticulous-md5, meticulous-sha1, and
sha-1.
keychain keychain-name Configures an authentication key chain with the specified name. The maximum
number of characters allowed in the name is 32.
Command Default Authentication in BFD template for single hop sessions is not enabled.
Command Modes BFD configuration (config-bfd)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines You can configure authentication in single hop templates. We recommend that you configure authentication
to enhance security. Authentication must be configured on each BFD source-destination pair, and authentication
parameters must match on both devices.
Examples The following example shows how to configure authentication for the template1 BFD single-hop
template:
Device>enable
Device#configuration terminal
Device(config)#bfd-template single-hop template1
Device(config-bfd)#authentication sha-1 keychain bfd-singlehop
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1419
Routing
bfd
bfd
To set the baseline Bidirectional Forwarding Detection (BFD) session parameters on an interface, use the bfd
interface configuration mode. To remove the baseline BFD session parameters, use the no form of this
command
bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
no bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
Syntax Description interval milliseconds Specifies the rate, in milliseconds, at which BFD control packets will be sent to
BFD peers. The valid range for the milliseconds argument is from 50 to 9999.
min_rx milliseconds Specifies the rate, in milliseconds, at which BFD control packets will be expected
to be received from BFD peers. The valid range for the milliseconds argument
is from 50 to 9999.
multiplier Specifies the number of consecutive BFD control packets that must be missed
multiplier-value from a BFD peer before BFD declares that the peer is unavailable and the Layer
3 BFD peer is informed of the failure. The valid range for the
multiplier-valueargument is from 3 to 50.
Command Default No baseline BFD session parameters are set.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The bfd command can be configured on SVI, Ethernet and port-channel interfaces.
If BFD runs on a port channel interface, BFD has a timer value restriction of 750 * 3 milliseconds.
The bfd interval configuration is not removed when:
• an IPv4 address is removed from an interface
• an IPv6 address is removed from an interface
• IPv6 is disabled from an interface
• an interface is shutdown
• IPv4 CEF is disabled globally or locally on an interface
• IPv6 CEF is disabled globally or locally on an interface
The bfd interval configuration is removed when the subinterface on which its is configured is removed.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1420
Routing
bfd
Note If we configure bfd interval command in interface config mode, then bfd echo mode is enabled by default.
We need to enable either no ip redirect (if BFD echo is needed) or no bfd echo in interface config mode.
Before using BFD echo mode, you must disable sending Internet Control Message Protocol (ICMP) redirect
messages by entering the no ip redirect command, in order to avoid high CPU utilization.
Examples The following example shows the BFD session parameters set for Gigabit Ethernet 1/0/3:
Device>enable
Device#configuration terminal
Device(config)#interface gigabitethernet 1/0/3
Device(config-if)#bfd interval 100 min_rx 100 multiplier 3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1421
Routing
bfd all-interfaces
bfd all-interfaces
To enable Bidirectional Forwarding Detection (BFD) for all interfaces participating in the routing process,
use the bfd all-interfaces command in router configuration or address family interface configuration mode.
To disable BFD for all neighbors on a single interface, use the no form of this command
bfd all-interfaces
no bfd all-interfaces
Syntax Description This command has no arguments or keywords.
Command Default BFD is disabled on the interfaces participating in the routing process.
Command Modes Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines To enable BFD for all interfaces, enter the bfd all-interfaces command in router configuration mode
Examples The following example shows how to enable BFD for all Enhanced Interior Gateway Routing Protocol
(EIGRP) neighbors:
Device>enable
Device#configuration terminal
Device(config)#router eigrp 123
Device(config-router)#bfd all-interfaces
Device(config-router)#end
The following example shows how to enable BFD for all Intermediate System-to-Intermediate System
(IS-IS) neighbors:
Device> enable
Device#configuration terminal
Device(config)#router isis tag1
Device(config-router)#bfd all-interfaces
Device(config-router)#end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1422
Routing
bfd check-ctrl-plane-failure
bfd check-ctrl-plane-failure
To enable Bidirectional Forwarding Detection (BFD) control plane failure checking for the Intermediate
System-to-Intermediate System (IS-IS) routing protocol, use the bfd check-control-plane-failure command
in router configuration mode. To disable control plane failure detection, use the no form of this command
bfd check-ctrl-plane-failure
no bfd check-ctrl-plane-failure
Syntax Description This command has no arguments or keywords.
Command Default BFD control plane failure checking is disabled.
Command Modes Router configuration (config-router)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The bfd check-ctrl-plane-failure command can be configured for an IS-IS routing process only. The command
is not supported on other protocols.
When a switch restarts, a false BFD session failure can occur, where neighboring routers behave as if a true
forwarding failure has occurred. However, if the bfd check-ctrl-plane-failure command is enabled on a switch,
the router can ignore control plane related BFD session failures. We recommend that you add this command
to the configuration of all neighboring routers just prior to a planned router restart, and that you remove the
command from all neighboring routers when the restart is complete.
Examples The following example enables BFD control plane failure checking for the IS-IS routing protocol:
Device>enable
Device#configuration terminal
Device(config)#router isis
Device(config-router)#bfd check-ctrl-plane-failure
Device(config-router)#end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1423
Routing
bfd echo
bfd echo
To enable Bidirectional Forwarding Detection (BFD) echo mode, use the bfd echo command in interface
configuration mode. To disable BFD echo mode, use the no form of this command
bfd echo
no bfd echo
Syntax Description This command has no arguments or keywords.
Command Default BFD echo mode is enabled by default if BFD is configured using bfd interval command in interface
configuration mode.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Echo mode is enabled by default. Entering the no bfd echo command without any keywords turns off the
sending of echo packets and signifies that the switch is unwilling to forward echo packets received from BFD
neighbor switches.
When echo mode is enabled, the desired minimum echo transmit interval and required minimum transmit
interval values are taken from the bfd interval milliseconds min_rx milliseconds parameters, respectively.
Note Before using BFD echo mode, you must disable sending Internet Control Message Protocol (ICMP) redirect
messages by entering the no ip redirects command, in order to avoid high CPU utilization.
Examples The following example configures echo mode between BFD neighbors:
Device>enable
Device#configuration terminal
Device(config)#interface GigabitEthernet 1/0/3
Device(config-if)#bfd echo
The following output from the show bfd neighbors details command shows that the BFD session
neighbor is up and using BFD echo mode. The relevant command output is shown in bold in the
output.
Device#show bfd neighbors details
OurAddr NeighAddr LD/RD RH/RS Holdown(mult) State Int
172.16.1.2 172.16.1.1 1/6 Up 0 (3 ) Up Fa0/1
Session state is UP and using echo function with 100 ms interval.
Local Diag: 0, Demand mode: 0, Poll bit: 0
MinTxInt: 1000000, MinRxInt: 1000000, Multiplier: 3
Received MinRxInt: 1000000, Received Multiplier: 3
Holdown (hits): 3000(0), Hello (hits): 1000(337)
Rx Count: 341, Rx Interval (ms) min/max/avg: 1/1008/882 last: 364 ms ago
Tx Count: 339, Tx Interval (ms) min/max/avg: 1/1016/886 last: 632 ms ago
Registered protocols: EIGRP
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1424
Routing
bfd echo
Uptime: 00:05:00
Last packet: Version: 1 - Diagnostic: 0
State bit: Up - Demand bit: 0
Poll bit: 0 - Final bit: 0
Multiplier: 3 - Length: 24
My Discr.: 6 - Your Discr.: 1
Min tx interval: 1000000 - Min rx interval: 1000000
Min Echo interval: 50000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1425
Routing
bfd slow-timers
bfd slow-timers
To configure the Bidirectional Forwarding Detection (BFD) slow timers value, use the bfd slow-timers
command in interface configuration mode. To change the slow timers used by BFD, use the no form of this
command
bfd slow-timers [milliseconds]
no bfd slow-timers
Command Default The BFD slow timer value is 1000 milliseconds
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Examples The following example shows how to configure the BFD slow timers value to 14,000 milliseconds:
Device(config)#bfd slow-timers 14000
The following output from the show bfd neighbors details command shows that the BFD slow timers
value of 14,000 milliseconds has been implemented. The values for the MinTxInt and MinRxInt will
correspond to the configured value for the BFD slow timers. The relevant command output is shown
in bold.
Device#show bfd neighbors details
OurAddr NeighAddr LD/RD RH/RS Holdown(mult) State Int
172.16.1.2 172.16.1.1 1/6 Up 0 (3 ) Up Fa0/1
Session state is UP and using echo function with 100 ms interval.
Local Diag: 0, Demand mode: 0, Poll bit: 0
MinTxInt: 14000, MinRxInt: 14000, Multiplier: 3
Received MinRxInt: 1000000, Received Multiplier: 3
Holdown (hits): 3600(0), Hello (hits): 1200(337)
Rx Count: 341, Rx Interval (ms) min/max/avg: 1/1008/882 last: 364 ms ago
Tx Count: 339, Tx Interval (ms) min/max/avg: 1/1016/886 last: 632 ms ago
Registered protocols: EIGRP
Uptime: 00:05:00
Last packet: Version: 1 - Diagnostic: 0
State bit: Up - Demand bit: 0
Poll bit: 0 - Final bit: 0
Multiplier: 3 - Length: 24
My Discr.: 6 - Your Discr.: 1
Min tx interval: 1000000 - Min rx interval: 1000000
Min Echo interval: 50000
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1426
Routing
bfd slow-timers
Note • If the BFD session is down, then the BFD control packets will be sent with the slow timer
interval.
• If the BFD session is up, then if echo is enabled, then BFD control packets will be sent in
negotiated slow timer interval and echo packets will be sent in negotiated configured BFD
interval. If echo is not enabled, then BFD control packets will be sent in negotiated configured
interval.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1427
Routing
bfd template
bfd template
To create a Bidirectional Forwarding Detection (BFD) template and to enter BFD configuration mode, use
the bfd-template command in global configuration mode. To remove a BFD template, use the no form of
this command
bfd template template-name
no bfd template template-name
Command Default A BFD template is not bound to an interface.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Even if you have not created the template by using the bfd-template command, you can configure the name
of the template under an interface, but the template is considered invalid until you define the template. You
do not have to reconfigure the template name again. It becomes valid automatically.
Examples Device> enable
Device#configuration terminal
Device(config)#interface Gigabitethernet 1/3/0
Device(config-if)#bfd template template1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1428
Routing
bfd-template single-hop
bfd-template single-hop
To bind a single hop Bidirectional Forwarding Detection (BFD) template to an interface, use the bfd template
command in interface configuration mode. To unbind single-hop BFD template from an interface, use the no
form of this command
bfd-template single-hop template-name
no bfd-template single-hop template-name
Syntax Description single-hop Creates the single-hop BFD template.
template-name Template name.
Command Default A BFD template does not exist.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The bfd-template command allows you to create a BFD template and places the device in BFD configuration
mode. The template can be used to specify a set of BFD interval values. BFD interval values specified as part
of the BFD template are not specific to a single interface.
Examples The following example shows how to create a BFD template and specify BFD interval values:
Device>enable
Device#configuration terminal
Device(config)#bfd-template single-hop node1
Device(bfd-config)#interval min-tx 100 min-rx 100 multiplier 3
Device(bfd-config)#echo
The following example shows how to create a BFD single-hop template and configure BFD interval
values and an authentication key chain:
Device> enable
Device#configuration terminal
Device(config)#bfd-template single-hop template1
Device(bfd-config)#interval min-tx 200 min-rx 200 multiplier 3
Device(bfd-config)#authentication keyed-sha-1 keychain bfd_singlehop
Note BFD echo is not enabled by default in the bfd-template configuration. This needs to configured
explicitly.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1429
Routing
bgp graceful-restart
bgp graceful-restart
To enable the Border Gateway Protocol (BGP) graceful restart capability globally for all BGP neighbors, use
the bgp graceful-restart command in address family or in router configuration mode. To disable the BGP
graceful restart capability globally for all BGP neighbors, use the no form of this command.
bgp graceful-restart [{extended | restart-time seconds | stalepath-time seconds}] [all]
no bgp graceful-restart
Syntax Description extended (Optional) Enables BGP graceful restart extension.
restart-time seconds (Optional) Sets the maximum time period that the
local router will wait for a graceful-restart-capable
neighbor to return to normal operation after a restart
event occurs. The default value for this argument is
120 seconds. The configurable range of values is from
1 to 3600 seconds.
stalepath-time seconds (Optional) Sets the maximum time period that the
local router will hold stale paths for a restarting peer.
All stale paths are deleted after this timer expires. The
default value for this argument is 360 seconds. The
configurable range of values is from 1 to 3600 seconds
all (Optional) Enables BGP graceful restart capability
for all address family modes.
Command Default The following default values are used when this command is entered without any keywords or arguments:
restart-time : 120 seconds stalepath-time: 360 seconds
Note Changing the restart and stalepath timer values is not required to enable the BGP graceful restart capability.
The default values are optimal for most network deployments, and these values should be adjusted only by
an experienced network operator.
Command Modes Address-family configuration (config-router-af)
Router configuration (config-router)
Table 149:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The bgp graceful-restart command is used to enable or disable the graceful restart capability globally for
all BGP neighbors in a BGP network. The graceful restart capability is negotiated between nonstop forwarding
(NSF)-capable and NSF-aware peers in OPEN messages during session establishment. If the graceful restart
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1430
Routing
bgp graceful-restart
capability is enabled after a BGP session has been established, the session will need to be restarted with a
hard reset.
The graceful restart capability is supported by NSF-capable and NSF-aware routers. A router that is NSF-capable
can perform a stateful switchover (SSO) operation (graceful restart) and can assist restarting peers by holding
routing table information during the SSO operation. A router that is NSF-aware functions like a router that is
NSF-capable but cannot perform an SSO operation.
The BGP graceful restart capability is enabled by default when a supporting version of Cisco IOS software
is installed. The default timer values for this feature are optimal for most network deployments. We recommend
that they are adjusted only by experienced network operators. When adjusting the timer values, the restart
timer should not be set to a value greater than the hold time that is carried in the OPEN message. If consecutive
restart operations occur, routes (from a restarting router) that were previously marked as stale will be deleted.
Note Changing the restart and stalepath timer values is not required to enable the BGP graceful restart capability.
The default values are optimal for most network deployments, and these values should be adjusted only by
an experienced network operator.
Examples In the following example, the BGP graceful restart capability is enabled:
Device#configure terminal
Device(config)#router bgp 65000
Device(config-router)#bgp graceful-restart
In the following example, the restart timer is set to 130 seconds:
Device#configure terminal
Device(config)#router bgp 65000
Device(config-router)#bgp graceful-restart restart-time 130
In the following example, the stalepath timer is set to 350 seconds:
Device#configure terminal
Device(config)#router bgp 65000
Device(config-router)#bgp graceful-restart stalepath-time 350
In the following example, the extended keyword is used:
Device#configure terminal
Device(config)#router bgp 65000
Device(config-router)#bgp graceful-restart extended
Table 150:
Related Commands
Command Description
show ip bgp Displays entries in the BGP routing table.
show ip bgp neighbors Displays information about the TCP and BGP
connections to neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1431
Routing
clear proximity ip bgp
clear proximity ip bgp
To reset Border Gateway Protocol (BGP) connections using hard or soft reconfiguration, use the clear
proximity ip bgp command in privileged EXEC mode.
clear proximity ip bgp {* | allautonomous-system-numberneighbor-address | peer-group group-name}
[{in [prefix-filter] | out | slow | soft [{in [prefix-filter] | out | slow}]}]
Syntax Description * Specifies that all current BGP sessions will be reset.
all (Optional) Specifies the reset of all address family sessions.
autonomous-system-number Number of the autonomous system in which all BGP peer sessions will be reset.
Number in the range from 1 to 65535.
• In Cisco IOS Release 12.0(32)SY8, 12.0(33)S3, 12.2(33)SRE,
12.2(33)XNE, 12.2(33)SXI1, Cisco IOS XE Release 2.4, and later releases,
4-byte autonomous system numbers are supported in the range from 65536
to 4294967295 in asplain notation and in the range from 1.0 to 65535.65535
in asdot notation.
• In Cisco IOS Release 12.0(32)S12, 12.4(24)T, and Cisco IOS XE Release
2.3, 4-byte autonomous system numbers are supported in the range from
1.0 to 65535.65535 in asdot notation only.
For more details about autonomous system number formats, see the router bgp
command.
neighbor-address Specifies that only the identified BGP neighbor will be reset. The value for this
argument can be an IPv4 or IPv6 address.
peer-group group-name Specifies that only the identified BGP peer group will be reset.
in (Optional) Initiates inbound reconfiguration. If neither the in nor out keywords
are specified, both inbound and outbound sessions are reset.
prefix-filter (Optional) Clears the existing outbound route filter (ORF) prefix list to trigger
a new route refresh or soft reconfiguration, which updates the ORF prefix list.
out (Optional) Initiates inbound or outbound reconfiguration. If neither the in nor
out keywords are specified, both inbound and outbound sessions are reset.
slow (Optional) Clears slow-peer status forcefully and moves it to original update
group.
soft (Optional) Initiates a soft reset. Does not tear down the session.
Command Modes
Privileged EXEC (#)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1432
Routing
clear proximity ip bgp
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Theclearproximity ip bgp command can be used to initiate a hard reset or soft reconfiguration. A hard reset
tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft
reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing
down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional
memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft
reconfiguration can be configured for inbound or outbound sessions.
Note Due to the complexity of some of the keywords available for the clear proximityip bgp command, some of
the keywords are documented as separate commands. All of the complex keywords that are documented
separately start with clear ip bgp. For example, for information on resetting BGP connections using hard or
soft reconfiguration for all BGP neighbors in IPv4 address family sessions, refer to the clear ip bgp ipv4
command.
Generating Updates from Stored Information
To generate new inbound updates from stored update information (rather than dynamically) without resetting
the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration
inboundcommand. This preconfiguration causes the software to store all received updates without modification
regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and
should be avoided if possible.
Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You
can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy
take effect.
Use this command whenever any of the following changes occur:
• Additions or changes to the BGP-related access lists
• Changes to BGP-related weights
• Changes to BGP-related distribution lists
• Changes to BGP-related route maps
Dynamic Inbound Soft Reset
The route refresh capability, as defined in RFC 2918, allows the local router to reset inbound routing tables
dynamically by exchanging route refresh requests to supporting peers. The route refresh capability does not
store update information locally for non-disruptive policy changes. It instead relies on dynamic exchange
with supporting peers. Route refresh is advertised through BGP capability negotiation. All BGP routers must
support the route refresh capability.
To determine if a BGP router supports this capability, use the show ip bgp neighborscommand. The following
message is displayed in the output when the router supports the route refresh capability:
Received route refresh capability from peer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1433
Routing
clear proximity ip bgp
If all BGP routers support the route refresh capability, use the clear proximityip bgpcommand with the in
keyword. You need not use the soft keyword, because soft reset is automatically assumed when the route
refresh capability is supported.
Note After configuring a soft reset (inbound or outbound), it is normal for the BGP routing process to hold memory.
The amount of memory that is held depends on the size of routing tables and the percentage of the memory
chunks that are utilized. Partially used memory chunks will be used or released before more memory is
allocated from the global router pool.
Examples In the following example, a soft reconfiguration is initiated for the inbound session with the neighbor
10.100.0.1, and the outbound session is unaffected:
Device#clear proximity ip bgp 10.100.0.1 soft in
In the following example, the route refresh capability is enabled on the BGP neighbor routers and a
soft reconfiguration is initiated for the inbound session with the neighbor 172.16.10.2, and the
outbound session is unaffected:
Device#clear proximity ip bgp 172.16.10.2 in
In the following example, a hard reset is initiated for sessions with all routers in the autonomous
system numbered 35700:
Device#clear proximity ip bgp 35700
In the following example, a hard reset is initiated for sessions with all routers in the 4-byte autonomous
system numbered 65538 in asplain notation. This example requires Cisco IOS Release 12.0(32)SY8,
12.0(33)S3, 12.2(33)SRE, 12.2(33)XNE, 12.2(33)SXI1, Cisco IOS XE Release 2.4, or a later release.
Device#clear proximity ip bgp 65538
In the following example, a hard reset is initiated for sessions with all routers in the 4-byte autonomous
system numbered 1.2 in asdot notation. This example requires Cisco IOS Release 12.0(32)SY8,
12.0(32)S12, 12.2(33)SRE, 12.2(33)XNE, 12.2(33)SXI1, 12.4(24)T, and Cisco IOS XE Release 2.3,
or a later release.
Device#clear proximity ip bgp 1.2
Related Commands Command Description
bgp slow-peer split-update-group Moves a dynamically detected slow peer to a slow update group.
dynamic permanent
clear ip bgp ipv4 Resets BGP connections using hard or soft reconfiguration for
IPv4 address family sessions.
clear ip bgp ipv6 Resets BGP connections using hard or soft reconfiguration for
IPv6 address family sessions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1434
Routing
clear proximity ip bgp
Command Description
clear ip bgp vpnv4 Resets BGP connections using hard or soft reconfiguration for
VPNv4 address family sessions.
clear ip bgp vpnv6 Resets BGP connections using hard or soft reconfiguration for
VPNv6 address family sessions.
neighbor slow-peer split-update-group Moves a dynamically detected slow peer to a slow update group.
dynamic permanent
neighbor soft-reconfiguration Configures the Cisco IOS software to start storing updates.
router bgp Configures the BGP routing process.
show ip bgp Displays entries in the BGP routing table.
show ip bgp neighbors Displays information about BGP and TCP connections to
neighbors.
slow-peer split-update-group dynamic Moves a dynamically detected slow peer to a slow update group.
permanent
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1435
Routing
default-information originate (OSPF)
default-information originate (OSPF)
To generate a default external route into an Open Shortest Path First (OSPF) routing domain, use the
default-information originate command in router configuration or router address family topology configuration
mode. To disable this feature, use the no form of this command.
default-information originate [always] [metric metric-value] [metric-type type-value] [route-map
map-name]
no default-information originate [always] [metric metric-value] [metric-type type-value] [route-map
map-name]
Syntax Description always (Optional) Always advertises the default route regardless of whether the software
has a default route.
Note The always keyword includes the following exception when the
route map is used. When a route map is used, the origination of the
default route by OSPF is not bound to the existence of a default route
in the routing table and the always keyword is ignored.
metric metric-value (Optional) Metric used for generating the default route. If you omit a value and
do not specify a value using the default-metric router configuration command,
the default metric value is 10. The value used is specific to the protocol.
metric-type (Optional) External link type associated with the default route that is advertised
type-value into the OSPF routing domain. It can be one of the following values:
• Type 1 external route.
• Type 2 external route.
The default is type 2 external route.
route-map map-name (Optional) The routing process will generate the default route if the route map is
satisfied.
Command Default This command is disabled by default. No default external route is generated into the OSPF routing domain.
Command Modes Router configuration (config-router) Router address family topology configuration (config-router-af-topology)
Command History Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Whenever you use the redistribute or the default-information router configuration command to redistribute
routes into an OSPF routing domain, the Cisco IOS software automatically becomes an Autonomous System
Boundary Router (ASBR). However, an ASBR does not, by default, generate a default route into the OSPF
routing domain. The software must still have a default route for itself before it generates one, except when
you have specified the always keyword.
When a route map is used, the origination of the default route by OSPF is not bound to the existence of a
default route in the routing table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1436
Routing
default-information originate (OSPF)
Release 12.2(33)SRB
If you plan to configure the Multi-Topology Routing (MTR) feature, you need to enter the default-information
originatecommand in router address family topology configuration mode in order for this OSPF router
configuration command to become topology-aware.
Examples The following example specifies a metric of 100 for the default route that is redistributed into the
OSPF routing domain and specifies an external metric type of 1:
router ospf 109
redistribute eigrp 108 metric 100 subnets
default-information originate metric 100 metric-type 1
Related Commands Command Description
default-information Accepts exterior or default information into Enhanced Interior Gateway Routing
Protocol (EIGRP) processes.
default-metric Sets default metric values for routes.
redistribute (IP) Redistributes routes from one routing domain into another routing domain.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1437
Routing
default-metric (BGP)
default-metric (BGP)
To set a default metric for routes redistributed into Border Gateway Protocol (BGP), use the default-metric
command in address family or router configuration mode. To remove the configured value and return BGP
to default operation, use the no form of this command.
default-metric number
no default-metric number
Syntax Description number Default metric value applied to the redistributed route. The range of values for this argument is
from 1 to 4294967295.
Command Default The following is default behavior if this command is not configured or if the no form of this command is
entered:
• The metric of redistributed interior gateway protocol (IGP) routes is set to a value that is equal to the
interior BGP (iBGP) metric.
• The metric of redistributed connected and static routes is set to 0.
When this command is enabled, the metric for redistributed connected routes is set to 0.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 151:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The default-metric command is used to set the metric value for routes redistributed into BGP and can be
applied to any external BGP (eBGP) routes received and subsequently advertised internally to iBGP peers.
This value is the Multi Exit Discriminator (MED) that is evaluated by BGP during the best path selection
process. The MED is a non-transitive value that is processed only within the local autonomous system and
adjacent autonomous systems. The default metric is not set if the received route has a MED value.
Note When enabled, the default-metric command applies a metric value of 0 to redistributed connected routes.
The default-metric command does not override metric values that are applied with the redistribute command.
Examples In the following example, a metric of 1024 is set for routes redistributed into BGP from OSPF:
Device(config)#router bgp 50000
Device(config-router)#address-family ipv4 unicast
Device(config-router-af)#default-metric 1024
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1438
Routing
default-metric (BGP)
Device(config-router-af)#redistribute ospf 10
Device(config-router-af)#end
In the following configuration and output examples, a metric of 300 is set for eBGP routes received
and advertised internally to an iBGP peer.
Device(config)#router bgp 65501
Device(config-router)#no synchronization
Device(config-router)#bgp log-neighbor-changes
Device(config-router)#network 172.16.1.0 mask 255.255.255.0
Device(config-router)#neighbor 172.16.1.1 remote-as 65501
Device(config-router)#neighbor 172.16.1.1 soft-reconfiguration inbound
Device(config-router)#neighbor 192.168.2.2 remote-as 65502
Device(config-router)#neighbor 192.168.2.2 soft-reconfiguration inbound
Device(config-router)#default-metric 300
Device(config-router)#no auto-summary
After the above configuration, some routes are received from the eBGP peer at 192.168.2.2 as shown
in the output from the show ip bgp neighbors received-routes command.
Device#show ip bgp neighbors 192.168.2.2 received-routes
BGP table version is 7, local router ID is 192.168.2.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 172.17.1.0/24 192.168.2.2 0 65502 i
After the received routes from the eBGP peer at 192.168.2.2 are advertised internally to iBGP peers,
the output from the show ip bgp neighbors received-routes command shows that the metric (MED)
has been set to 300 for these routes.
Device#show ip bgp neighbors 172.16.1.2 received-routes
BGP table version is 2, local router ID is 172.16.1.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
* i172.16.1.0/24 172.16.1.2 0 100 0 i
* i172.17.1.0/24 192.168.2.2 300 100 0 65502 i
Total number of prefixes 2
Related Commands Command Description
redistribute (IP) Redistributes routes from one routing domain into another routing domain.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1439
Routing
distance (OSPF)
distance (OSPF)
To define an administrative distance, use the distance command in router configuration mode or VRF
configuration mode. To remove the distance command and restore the system to its default condition, use
the no form of this command.
distance weight
[ip-address wildcard-mask [access-list name]]
no distance weight ip-address wildcard-mask [access-list-name]
Syntax Description weight Administrative distance. Range is 10 to 255. Used alone, the weight argument specifies a
default administrative distance that the software uses when no other specification exists
for a routing information source. Routes with a distance of 255 are not installed in the
routing table. The table in the “Usage Guidelines” section lists the default administrative
distances.
ip-address (Optional) IP address in four-part dotted-decimal notation.
wildcard-mask (Optional) Wildcard mask in four-part, dotted-decimal format. A bit set to 1 in the
wildcard-mask argument instructs the software to ignore the corresponding bit in the address
value.
access-list-name (Optional) Name of an IP access list to be applied to incoming routing updates.
Command Default If this command is not specified, the administrative distance is the default. The table in the “Usage Guidelines”
section lists the default administrative distances.
Command Modes Router configuration (config-router)
VRF configuration (config-vrf)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To use this command, you must be in a user group associated with a task group that includes the appropriate
task IDs. If the user group assignment is preventing you from using a command contact your AAA administrator
for assistance.
An administrative distance is an integer from 10 to 255. In general, the higher the value, the lower the trust
rating. An administrative distance of 255 means that the routing information source cannot be trusted at all
and should be ignored. Weight values are subjective; no quantitative method exists for choosing weight values.
If an access list is used with this command, it is applied when a network is being inserted into the routing
table. This behavior allows you to filter networks based on the IP prefix supplying the routing information.
For example, you could filter possibly incorrect routing information from networking devices not under your
administrative control.
The order in which you enter distance commands can affect the assigned administrative distances, as shown
in the “Examples” section. The following table lists default administrative distances.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1440
Routing
distance (OSPF)
Table 152: Default Administrative Distances
Rate Source Default Distance
Connected interface 0
Static route out on interface 0
Static route to next hop 1
EIGRP summary route 5
External BGP 20
Internal EIGRP 90
OSPF 110
IS-IS 115
RIP version 1 and 2 120
External EIGRP 170
Internal BGP 200
Unknown 255
Task ID
Task ID Operations
ospf read, write
Examples In the following example, the router ospf command sets up Open Shortest Path First (OSPF) routing
instance 1. The first distance command sets the default administrative distance to 255, which instructs
the software to ignore all routing updates from networking devices for which an explicit distance
has not been set. The second distance command sets the administrative distance for all devices on
the network 192.168.40.0 to 90.
Device#configure terminal
Device(config)#router ospf 1
Device(config-ospf)#distance 255
Device(config-ospf)#distance 90 192.168.40.0 0.0.0.255
Related Commands Command Description
distance bgp Allows the use of external, internal, and local administrative distances that could be a better
route to a BGP node.
distance Allows the use of external, internal, and local administrative distances that could be a better
ospf route to an OSPF node.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1441
Routing
distance (OSPF)
Command Description
router ospf Configures the OSPF routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1442
Routing
eigrp log-neighbor-changes
eigrp log-neighbor-changes
To enable the logging of changes in Enhanced Interior Gateway Routing Protocol (EIGRP) neighbor
adjacencies, use the eigrp log-neighbor-changes command in router configuration mode, address-family
configuration mode, or service-family configuration mode. To disable the logging of changes in EIGRP
neighbor adjacencies, use the noform of thiscommand.
eigrp log-neighbor-changes
no eigrp log-neighbor-changes
Syntax Description This command has no arguments or keywords.
Command Default Adjacency changes are logged.
Command Modes Router configuration (config-router) Address-family configuration (config-router-af) Service-family
configuration (config-router-sf)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command enables the logging of neighbor adjacency changes to monitor the stability of the routing
system and to help detect problems. Logging is enabled by default. To disable the logging of neighbor adjacency
changes, use the no form of this command.
To enable the logging of changes for EIGRP address-family neighbor adjacencies, use the eigrp
log-neighbor-changescommand in address-family configuration mode.
To enable the logging of changes for EIGRP service-family neighbor adjacencies, use the eigrp
log-neighbor-changescommand in service-family configuration mode.
Examples The following configuration disables logging of neighbor changes for EIGRP process 209:
Device(config)# router eigrp 209
Device(config-router)# no eigrp log-neighbor-changes
The following configuration enables logging of neighbor changes for EIGRP process 209:
Device(config)# router eigrp 209
Device(config-router)# eigrp log-neighbor-changes
The following example shows how to disable logging of neighbor changes for EIGRP address-family
with autonomous-system 4453:
Device(config)# router eigrp virtual-name
Device(config-router)# address-family ipv4 autonomous-system 4453
Device(config-router-af)# no eigrp log-neighbor-changes
Device(config-router-af)# exit-address-family
The following configuration enables logging of neighbor changes for EIGRP service-family process
209:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1443
Routing
eigrp log-neighbor-changes
Device(config)# router eigrp 209
Device(config-router)# service-family ipv4 autonomous-system 4453
Device(config-router-sf)# eigrp log-neighbor-changes
Device(config-router-sf)# exit-service-family
Related Commands Command Description
address-family (EIGRP) Enters address-family configuration mode to configure an EIGRP routing
instance.
exit-address-family Exits address-family configuration mode.
exit-service-family Exits service-family configuration mode.
router eigrp Configures the EIGRP routing process.
service-family Specifies service-family configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1444
Routing
ip authentication key-chain eigrp
ip authentication key-chain eigrp
To enable authentication of Enhanced Interior Gateway Routing Protocol (EIGRP) packets, use the ip
authentication key-chain eigrpcommand in interface configuration mode. To disable such authentication,
use the no form of this command.
ip authentication key-chain eigrp as-number key-chain
no ip authentication key-chain eigrp as-number key-chain
Syntax Description as-number Autonomous system number to which the authentication applies.
key-chain Name of the authentication key chain.
Command Default No authentication is provided for EIGRP packets.
Command Modes Interface configuration (config-if) Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example applies authentication to autonomous system 2 and identifies a key chain
named SPORTS:
Device(config-if)#ip authentication key-chain eigrp 2 SPORTS
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key chain is
received as valid.
ip authentication mode eigrp Specifies the type of authentication used in EIGRP packets.
key Identifies an authentication key on a key chain.
key chain Enables authentication of routing protocols.
key-string (authentication) Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain is
valid to be sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1445
Routing
ip authentication mode eigrp
ip authentication mode eigrp
To specify the type of authentication used in Enhanced Interior Gateway Routing Protocol (EIGRP) packets,
use the ip authentication mode eigrpcommand in interface configuration mode. To disable that type of
authentication, use the no form of this command.
ip authentication mode eigrp as-number md5
no ip authentication mode eigrp as-number md5
Syntax Description as-number Autonomous system number.
md5 Keyed Message Digest 5 ( MD5) authentication.
Command Default No authentication is provided for EIGRP packets.
Command Modes Interface configuration (config-if) Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Configure authentication to prevent unapproved sources from introducing unauthorized or false routing
messages. When authentication is configured, an MD5 keyed digest is added to each EIGRP packet in the
specified autonomous system.
Examples The following example configures the interface to use MD5 authentication in EIGRP packets in
autonomous system 10:
Device(config-if)#ip authentication mode eigrp 10 md5
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key
chain is received as valid.
ip authentication key-chain eigrp Enables authentication of EIGRP packets.
key Identifies an authentication key on a key chain.
key chain Enables authentication of routing protocols.
key-string (authentication) Specifies the authentication string for a key.
send-lifetime Sets the time period during which an authentication key on a key chain
is valid to be sent.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1446
Routing
ip bandwidth-percent eigrp
ip bandwidth-percent eigrp
To configure the percentage of bandwidth that may be used by Enhanced Interior Gateway Routing Protocol
(EIGRP) on an interface, use the ip bandwidth-percent eigrpcommand in interface configuration mode. To
restore the default value, use the no form of this command.
ip bandwidth-percent eigrp as-number percent
no ip bandwidth-percent eigrp as-number percent
Syntax Description as-number Autonomous system number.
percent Percent of bandwidth that EIGRP may use.
Command Default EIGRP may use 50 percent of available bandwidth.
Command Modes Interface configuration (config-if) Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines EIGRP will use up to 50 percent of the bandwidth of a link, as defined by the bandwidth interface configuration
command. This command may be used if some other fraction of the bandwidth is desired. Note that values
greater than 100 percent may be configured. The configuration option may be useful if the bandwidth is set
artificially low for other reasons.
Examples The following example allows EIGRP to use up to 75 percent (42 kbps) of a 56-kbps serial link in
autonomous system 209:
Device(config)#interface serial 0
Device(config-if)#bandwidth 56
Device(config-if)#ip bandwidth-percent eigrp 209 75
Related Commands Command Description
bandwidth (interface) Sets a bandwidth value for an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1447
Routing
ip cef load-sharing algorithm
ip cef load-sharing algorithm
To select a Cisco Express Forwarding load-balancing algorithm, use theip cef load-sharing algorithm
command in global configuration mode. To return to the default universal load-balancing algorithm, use the
no form of this command.
ip cef load-sharing algorithm {original | [universal [id]]}
no ip cef load-sharing algorithm
Syntax Description original Sets the load-balancing algorithm to the original algorithm based on a source and destination
hash.
universal Sets the load-balancing algorithm to the universal algorithm that uses a source and destination
and an ID hash.
id (Optional) Fixed identifier.
Command Default The universal load-balancing algorithm is selected by default. If you do not configure the fixed identifier for
a load-balancing algorithm, the router automatically generates a unique ID.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The original Cisco Express Forwarding load-balancing algorithm produced distortions in load sharing across
multiple devices because of the use of the same algorithm on every device. When the load-balancing algorithm
is set to universal mode, each device on the network can make a different load sharing decision for each
source-destination address pair, and that resolves load-balancing distortions.
Examples The following example shows how to enable the Cisco Express Forwarding original load-balancing
algorithm:
Device> enable
Device# configure terminal
Device(config)# ip cef load-sharing algorithm original
Device(config)# exit
Related Commands Command Description
ip load-sharing Enables load balancing for Cisco Express Forwarding.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1448
Routing
ip community-list
ip community-list
To configure a BGP community list and to control which routes are permitted or denied based on their
community values, use the ip community-list command in global configuration mode. To delete the
community list, use the no form of this command.
Standard Community Lists
ip community-list {standard | standard list-name} {deny | permit} [community-number] [AA:NN]
[internet] [local-as] [no-advertise] [no-export] [gshut]
no ip community-list {standard | standard list-name}
Expanded Community Lists
ip community-list {expanded | expanded list-name} {deny | permit} regexp
no ip community-list {expanded | expanded list-name}
Syntax Description standard Standard community list
number from 1 to 99 to
identify one or more permit or
deny groups of communities.
standard list-name Configures a named standard
community list.
deny Denies routes that match the
specified community or
communities.
permit Permits routes that match the
specified community or
communities.
community-number (Optional) 32-bit number from
1 to 4294967200. A single
community can be entered or
multiple communities can be
entered, each separated by a
space.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1449
Routing
ip community-list
AA :NN (Optional) Autonomous
system number and network
number entered in the 4-byte
new community format. This
value is configured with two
2-byte numbers separated by
a colon. A number from 1 to
65535 can be entered for each
2-byte number. A single
community can be entered or
multiple communities can be
entered, each separated by a
space.
internet (Optional) Specifies the
Internet community. Routes
with this community are
advertised to all peers (internal
and external).
local-as (Optional) Specifies the
local-as community. Routes
with community are advertised
to only peers that are part of
the local autonomous system
or to only peers within a
subautonomous system of a
confederation. These routes
are not advertised to external
peers or to other
subautonomous systems
within a confederation.
no-advertise (Optional) Specifies the
no-advertise community.
Routes with this community
are not advertised to any peer
(internal or external).
no-export (Optional) Specifies the
no-export community. Routes
with this community are
advertised to only peers in the
same autonomous system or
to only other subautonomous
systems within a
confederation. These routes
are not advertised to external
peers.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1450
Routing
ip community-list
gshut (Optional) Specifies the
Graceful Shutdown (GSHUT)
community.
expanded Expanded community list
number from 100 to 500 to
identify one or more permit or
deny groups of communities.
expanded list-name Configures a named expanded
community list.
regexp Regular expression that is used
to specify a pattern to match
against an input string.
Note Regular
expressions can
be used only
with expanded
community lists.
Command Default BGP community exchange is not enabled by default.
Command Modes
Global configuration (config)
Table 153:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The ip community-list command is used to filter BGP routes based on one or more community values. BGP
community values are configured as a 32-bit number (old format) or as a 4-byte number (new format). The
new community format is enabled when the ip bgp-community new-format command is entered in global
configuration mode. The new community format consists of a 4-byte value. The first two bytes represent the
autonomous system number, and the trailing two bytes represent a user-defined network number. Named and
numbered community lists are supported.
BGP community exchange is not enabled by default. The exchange of BGP community attributes between
BGP peers is enabled on a per-neighbor basis with the neighbor send-community command. The BGP
community attribute is defined in RFC 1997 and RFC 1998.
The Internet community is applied to all routes or prefixes by default, until any other community value is
configured with this command or the set community command.
Use a route map to reference a community list and thereby apply policy routing or set values.
Community List Processing
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1451
Routing
ip community-list
Once a permit value has been configured to match a given set of communities, the community list defaults
to an implicit deny for all other community values. Unlike an access list, it is feasible for a community list to
contain only deny statements.
• When multiple communities are configured in the same ip community-list statement, a logical AND
condition is created. All community values for a route must match the communities in the community
list statement to satisfy an AND condition.
• When multiple communities are configured in separate ip community-list statements, a logical OR
condition is created. The first list that matches a condition is processed.
Standard Community Lists
Standard community lists are used to configure well-known communities and specific community numbers.
A maximum of 16 communities can be configured in a standard community list. If you attempt to configure
more than 16 communities, the trailing communities that exceed the limit are not processed or saved to the
running configuration file.
Expanded Community Lists
Expanded community lists are used to filter communities using a regular expression. Regular expressions are
used to configure patterns to match community attributes. The order for matching using the * or + character
is longest construct first. Nested constructs are matched from the outside in. Concatenated constructs are
matched beginning at the left side. If a regular expression can match two different parts of an input string, it
will match the earliest part first. For more information about configuring regular expressions, see the “Regular
Expressions” appendix of the Terminal Services Configuration Guide.
Examples In the following example, a standard community list is configured that permits routes from network
10 in autonomous system 50000:
Device(config)#ip community-list 1 permit 50000:10
In the following example, a standard community list is configured that permits only routes from
peers in the same autonomous system or from subautonomous system peers in the same confederation:
Device(config)#ip community-list 1 permit no-export
In the following example, a standard community list is configured to deny routes that carry
communities from network 40 in autonomous system 65534 and from network 60 in autonomous
system 65412. This example shows a logical AND condition; all community values must match in
order for the list to be processed.
Device(config)#ip community-list 2 deny 65534:40 65412:60
In the following example, a named, standard community list is configured that permits all routes
within the local autonomous system or permits routes from network 20 in autonomous system 40000.
This example shows a logical OR condition; the first match is processed.
Device(config)#ip community-list standard RED permit local-as
Device(config)#ip community-list standard RED permit 40000:20
In the following example, a standard community list is configured that denies routes with the GSHUT
community and permits routes with the local-AS community. This example shows a logical OR
condition; the first match is processed.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1452
Routing
ip community-list
Device(config)#ip community-list 18 deny gshut
Device(config)#ip community-list 18 permit local-as
In the following example, an expanded community list is configured that denies routes that carry
communities from any private autonomous system:
Device(config)#ip community-list 500 deny _64[6-9][0-9][0-9]_|_65[0-9][0-9][0-9]_
In the following example, a named expanded community list is configured that denies routes from
network 1 to 99 in autonomous system 50000:
Device(config)#ip community-list expanded BLUE deny 50000:[0-9][0-9]_
Related Commands Command Description
match community Defines a BGP community that must match the community of a route.
neighbor send-community Allows BGP community exchange with a neighbor.
neighbor shutdown graceful Configures the BGP Graceful Shutdown feature.
route-map (IP) Defines the conditions for redistributing routes from one routing protocol
into another, or enables policy routing.
set community Sets the BGP communities attribute.
set comm-list delete Removes communities from the community attribute of an inbound or
outbound update.
show ip bgp community Displays routes that belong to specified BGP communities.
show ip bgp regexp Displays routes that match a locally configured regular expression.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1453
Routing
ip prefix-list
ip prefix-list
To create a prefix list or to add a prefix-list entry, use the ip prefix-list command in global configuration
mode. To delete a prefix-list entry, use the no form of this command.
ip prefix-list {list-name [seq number] {deny | permit} network/length [ge ge-length] [le le-length]
| description description | sequence-number}
no ip prefix-list {list-name [seq number] [{deny | permit} network/length [ge ge-length] [le
le-length]] | description description | sequence-number}
Syntax Description list-name Configures a name to identify the prefix list. Do not use the word “detail” or “summary”
as a list name because they are keywords in the show ip prefix-list command.
seq (Optional) Applies a sequence number to a prefix-list entry.
number (Optional) Integer from 1 to 4294967294. If a sequence number is not entered when
configuring this command, default sequence numbering is applied to the prefix list.
The number 5 is applied to the first prefix entry, and subsequent unnumbered entries
are incremented by 5.
deny Denies access for a matching condition.
permit Permits access for a matching condition.
network / length Configures the network address and the length of the network mask in bits. The network
number can be any valid IP address or prefix. The bit mask can be a number from 1
to 32.
ge (Optional) Specifies the lesser value of a range (the “from” portion of the range
description) by applying the ge-length argument to the range specified.
Note The ge keyword represents the greater than or equal to operator.
ge-length (Optional) Represents the minimum prefix length to be matched.
le (Optional) Specifies the greater value of a range (the “to” portion of the range
description) by applying the le-length argument to the range specified.
Note The le keyword represents the less than or equal to operator.
le-length (Optional) Represents the maximum prefix length to be matched.
description (Optional) Configures a descriptive name for the prefix list.
description (Optional) Descriptive name of the prefix list, from 1 to 80 characters in length.
sequence-number (Optional) Enables or disables the use of sequence numbers for prefix lists.
Command Default No prefix lists or prefix-list entries are created.
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1454
Routing
ip prefix-list
Table 154:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the ip prefix-list command to configure IP prefix filtering. Prefix lists are configured with permit or
deny keywords to either permit or deny a prefix based on a matching condition. An implicit deny is applied
to traffic that does not match any prefix-list entry.
A prefix-list entry consists of an IP address and a bit mask. The IP address can be for a classful network, a
subnet, or a single host route. The bit mask is a number from 1 to 32.
Prefix lists are configured to filter traffic based on a match of an exact prefix length or a match within a range
when the ge and le keywords are used. The ge and le keywords are used to specify a range of prefix lengths
and provide more flexible configuration than using only the network/length argument. A prefix list is processed
using an exact match when neither the ge nor le keyword is specified. If only the ge value is specified, the
range is the value entered for the ge ge-length argument to a full 32-bit length. If only the le value is specified,
the range is from the value entered for the network/length argument to the le le-length argument. If both the
ge ge-length and le le-length keywords and arguments are entered, the range is between the values used for
the ge-length and le-length arguments.
The following formula shows this behavior:
length <ge ge-length <le le-length <= 32
If the seq keyword is configured without a sequence number, the default sequence number is 5. In this scenario,
the first prefix-list entry is assigned the number 5 and subsequent prefix list entries increment by 5. For
example, the next two entries would have sequence numbers 10 and 15. If a sequence number is entered for
the first prefix list entry but not for subsequent entries, the subsequent entry numbers increment by 5. For
example, if the first configured sequence number is 3, subsequent entries will be 8, 13, and 18. Default sequence
numbers can be suppressed by entering the no ip prefix-list command with the seq keyword.
Evaluation of a prefix list starts with the lowest sequence number and continues down the list until a match
is found. When an IP address match is found, the permit or deny statement is applied to that network and the
remainder of the list is not evaluated.
Tip For best performance, the most frequently processed prefix list statements should be configured with the
lowest sequence numbers. The seq number keyword and argument can be used for resequencing.
A prefix list is applied to inbound or outbound updates for a specific peer by entering the neighbor prefix-list
command. Prefix list information and counters are displayed in the output of the show ip prefix-list command.
Prefix-list counters can be reset by entering the clear ip prefix-list command.
Examples In the following example, a prefix list is configured to deny the default route 0.0.0.0/0:
Device(config)#ip prefix-list RED deny 0.0.0.0/0
In the following example, a prefix list is configured to permit traffic from the 172.16.1.0/24 subnet:
Device(config)#ip prefix-list BLUE permit 172.16.1.0/24
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1455
Routing
ip prefix-list
In the following example, a prefix list is configured to permit routes from the 10.0.0.0/8 network
that have a mask length that is less than or equal to 24 bits:
Device(config)#ip prefix-list YELLOW permit 10.0.0.0/8 le 24
In the following example, a prefix list is configured to deny routes from the 10.0.0.0/8 network that
have a mask length that is greater than or equal to 25 bits:
Device(config)#ip prefix-list PINK deny 10.0.0.0/8 ge 25
In the following example, a prefix list is configured to permit routes from any network that have a
mask length from 8 to 24 bits:
Device(config)#ip prefix-list GREEN permit 0.0.0.0/0 ge 8 le 24
In the following example, a prefix list is configured to deny any route with any mask length from
the 10.0.0.0/8 network:
Device(config)#ip prefix-list ORANGE deny 10.0.0.0/8 le 32
Related Commands Command Description
clear ip prefix-list Resets the prefix list entry counters.
ip prefix-list description Adds a text description of a prefix list.
ip prefix-list sequence Enables or disables default prefix-list sequencing.
match ip address Distributes any routes that have a destination network number address that is
permitted by a standard or extended access list, and performs policy routing on
packets.
neighbor prefix-list Filters routes from the specified neighbor using a prefix list.
show ip prefix-list Displays information about a prefix list or prefix list entries.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1456
Routing
ip hello-interval eigrp
ip hello-interval eigrp
To configure the hello interval for an Enhanced Interior Gateway Routing Protocol (EIGRP) process, use the
ip hello-interval eigrp command in interface configuration mode. To restore the default value, use the no
form of this command.
ip hello-interval eigrp as-number seconds
no ip hello-interval eigrp as-number [seconds]
Syntax Description as-number Autonomous system number.
seconds Hello interval (in seconds). The range is from 1 to 65535.
Command Default The hello interval for low-speed, nonbroadcast multiaccess (NBMA) networks is 60 seconds and 5 seconds
for all other networks.
Command Modes Interface configuration (config-if) Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The default of 60 seconds applies only to low-speed, NBMA media. Low speed is considered to be a rate of
T1 or slower, as specified with the bandwidth interface configuration command. Note that for the purposes
of EIGRP, Frame Relay and Switched Multimegabit Data Service (SMDS) networks may be considered to
be NBMA. These networks are considered NBMA if the interface has not been configured to use physical
multicasting; otherwise, they are considered not to be NBMA.
Examples The following example sets the hello interval for Ethernet interface 0 to 10 seconds:
Device(config)#interface ethernet 0
Device(config-if)#ip hello-interval eigrp 109 10
Related Commands Command Description
bandwidth (interface) Sets a bandwidth value for an interface.
ip hold-time eigrp Configures the hold time for a particular EIGRP routing process designated by
the autonomous system number.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1457
Routing
ip hold-time eigrp
ip hold-time eigrp
To configure the hold time for an Enhanced Interior Gateway Routing Protocol (EIGRP) process, use the ip
hold-time eigrp command in interface configuration mode. To restore the default value, use the no form of
this command.
ip hold-time eigrp as-number seconds
no ip hold-time eigrp as-number seconds
Syntax Description as-number Autonomous system number.
seconds Hold time (in seconds). The range is from 1 to 65535.
Command Default The EIGRP hold time is 180 seconds for low-speed, nonbroadcast multiaccess (NBMA) networks and 15
seconds for all other networks.
Command Modes Interface configuration (config-if) Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines On very congested and large networks, the default hold time might not be sufficient time for all routers and
access servers to receive hello packets from their neighbors. In this case, you may want to increase the hold
time.
We recommend that the hold time be at least three times the hello interval. If a router does not receive a hello
packet within the specified hold time, routes through this router are considered unavailable.
Increasing the hold time delays route convergence across the network.
The default of 180 seconds hold time and 60 seconds hello interval apply only to low-speed, NBMA media.
Low speed is considered to be a rate of T1 or slower, as specified with the bandwidth interface configuration
command.
Examples The following example sets the hold time for Ethernet interface 0 to 40 seconds:
Device(config)#interface ethernet 0
Device(config-if)#ip hold-time eigrp 109 40
Related Commands Command Description
bandwidth (interface) Sets a bandwidth value for an interface.
ip hello-interval eigrp Configures the hello interval for the EIGRP routing process designated by an
autonomous system number.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1458
Routing
ip load-sharing
ip load-sharing
To enable load balancing for Cisco Express Forwarding on an interface, use the ip load-sharing command
in interface configuration mode. To disable load balancing for Cisco Express Forwarding on the interface,
use the no form of this command.
ip load-sharing { per-destination }
no ip load-sharing
Syntax Description per-destination Enables per-destination load balancing for Cisco Express Forwarding on the interface.
Command Default Per-destination load balancing is enabled by default when you enable Cisco Express Forwarding.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Per-destination load balancing allows the device to use multiple, equal-cost paths to achieve load sharing.
Packets for a given source-destination host pair are guaranteed to take the same path, even if multiple, equal-cost
paths are available. Traffic for different source-destination host pairs tends to take different paths.
Examples The following example shows how to enable per-destination load balancing:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/0/1
Device(config-if)# ip load-sharing per-destination
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1459
Routing
ip network-broadcast
ip network-broadcast
To receive and accept the network-prefix-directed broadcast packets, configure the ip network-broadcast
command at the interface of the device.
ip network-broadcast
Syntax Description This command has no arguments or keywords.
Command Default This command is disabled by default.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Amsterdam 17.3.1 This command was introduced.
Usage Guidelines Configure the ip network-broadcast command at the ingress interface before configuring the ip
directed-broadcast command at the egress interface. This ensures that the network-prefix-directed broadcast
packets are received and accepted.
The ip network-broadcast command is disabled by default. If you do not configure this command, the
network-prefix-directed broadcast packets are silently discarded.
Example
The following example shows how to enable the network to accept the network-prefix-directed
broadcast packets at ingress and then configure the directed broadcast-to-physical broadcast translation
on the egress interface.
Device# configure terminal
Device(config)#interface gigabitethernet 1/0/2
Device(config-if)#ip network-broadcast
Device(config-if)#exit
Device(config)#interface gigabitethernet 1/0/3
Device(config-if)#ip directed-broadcast
Device(config-if)#exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1460
Routing
ip ospf database-filter all out
ip ospf database-filter all out
To filter outgoing link-state advertisements (LSAs) to an Open Shortest Path First (OSPF) interface, use the
ip ospf database-filter all out command in interface or virtual network interface configuration modes. To
restore the forwarding of LSAs to the interface, use the no form of this command.
ip ospf database-filter all out [disable]
no ip ospf database-filter all out
Syntax Description disable (Optional) Disables the filtering of outgoing LSAs to an OSPF interface; all outgoing LSAs are
flooded to the interface.
Note This keyword is available only in virtual network interface mode.
Command Default This command is disabled by default. All outgoing LSAs are flooded to the interface.
Command Modes Interface configuration (config-if)
Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command performs the same function that the neighbor database-filter command performs on a neighbor
basis.
If the ip ospf database-filter all out command is enabled for a virtual network and you want to disable it,
use the disable keyword in virtual network interface configuration mode.
Examples The following example prevents filtering of OSPF LSAs to broadcast, nonbroadcast, or point-to-point
networks reachable through Ethernet interface 0:
Device(config)#interface ethernet 0
Device(config-if)#ip ospf database-filter all out
Related Commands Command Description
neighbor database-filter Filters outgoing LSAs to an OSPF neighbor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1461
Routing
ip ospf name-lookup
ip ospf name-lookup
To configure Open Shortest Path First (OSPF) to look up Domain Name System (DNS) names for use in all
OSPF show EXEC command displays, use the ip ospf name-lookup command in global configuration mode.
To disable this function, use the no form of this command.
ip ospf name-lookup
noipospfname-lookup
Syntax Description This command has no arguments or keywords.
Command Default This command is disabled by default.
Command Modes Global configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command makes it easier to identify a router because the router is displayed by name rather than by its
router ID or neighbor ID.
Examples The following example configures OSPF to look up DNS names for use in all OSPF show EXEC
command displays:
Device(config)#ip ospf name-lookup
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1462
Routing
ip split-horizon eigrp
ip split-horizon eigrp
To enable Enhanced Interior Gateway Routing Protocol (EIGRP) split horizon, use the ip split-horizon eigrp
command in interface configuration mode. To disable split horizon, use the no form of this command.
ip split-horizon eigrp as-number
no ip split-horizon eigrp as-number
Syntax Description as-number Autonomous system number.
Command Default The behavior of this command is enabled by default.
Command Modes Interface configuration (config-if)
Virtual network interface (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the no ip split-horizon eigrp command to disable EIGRP split horizon in your configuration.
Examples The following is an example of how to enable EIGRP split horizon:
Device(config-if)#ip split-horizon eigrp 101
Related Commands Command Description
ip split-horizon (RIP) Enables the split horizon mechanism.
neighbor (EIGRP) Defines a neighboring router with which to exchange routing information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1463
Routing
ip summary-address eigrp
ip summary-address eigrp
To configure address summarization for the Enhanced Interior Gateway Routing Protocol (EIGRP) on a
specified interface, use the ip summary-address eigrp command in interface configuration or virtual network
interface configuration mode. To disable the configuration, use the no form of this command.
ip summary-address eigrp as-number ip-address mask [admin-distance] [leak-map name]
no ip summary-address eigrp as-number ip-address mask
Syntax Description as-number Autonomous system number.
ip-address Summary IP address to apply to an interface.
mask Subnet mask.
admin-distance (Optional) Administrative distance. Range: 0 to 255.
Note Starting with Cisco IOS XE Release 3.2S, the admin-distance argument
was removed. Use the summary-metric command to configure the
administrative distance.
leak-map name (Optional) Specifies the route-map reference that is used to configure the route leaking
through the summary.
Command Default • An administrative distance of 5 is applied to EIGRP summary routes.
• EIGRP automatically summarizes to the network level, even for a single host route.
• No summary addresses are predefined.
• The default administrative distance metric for EIGRP is 90.
Command Modes Interface configuration (config-if)
Virtual network interface configuration (config-if-vnet)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The ip summary-address eigrp command is used to configure interface-level address summarization. EIGRP
summary routes are given an administrative-distance value of 5. The administrative-distance metric is used
to advertise a summary without installing it in the routing table.
By default, EIGRP summarizes subnet routes to the network level. The no auto-summary command can be
entered to configure the subnet-level summarization.
The summary address is not advertised to the peer if the administrative distance is configured as 255.
EIGRP Support for Leaking Routes
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1464
Routing
ip summary-address eigrp
Configuring the leak-map keyword allows a component route that would otherwise be suppressed by the
manual summary to be advertised. Any component subset of the summary can be leaked. A route map and
access list must be defined to source the leaked route.
The following is the default behavior if an incomplete configuration is entered:
• If the leak-map keyword is configured to reference a nonexistent route map, the configuration of this
keyword has no effect. The summary address is advertised but all component routes are suppressed.
• If the leak-map keyword is configured but the access list does not exist or the route map does not reference
the access list, the summary address and all component routes are advertised.
If you are configuring a virtual-network trunk interface and you configure the ip summary-address eigrp
command, the admin-distance value of the command is not inherited by the virtual networks running on the
trunk interface because the administrative distance option is not supported in the ip summary-address eigrp
command on virtual network subinterfaces.
Examples The following example shows how to configure an administrative distance of 95 on Ethernet interface
0/0 for the 192.168.0.0/16 summary address:
Device(config)#router eigrp 1
Device(config-router)#no auto-summary
Device(config-router)#exit
Device(config)#interface Ethernet 0/0
Device(config-if)#ip summary-address eigrp 1 192.168.0.0 255.255.0.0 95
The following example shows how to configure the 10.1.1.0/24 subnet to be leaked through the
10.2.2.0 summary address:
Device(config)#router eigrp 1
Device(config-router)#exit
Device(config)#access-list 1 permit 10.1.1.0 0.0.0.255
Device(config)#route-map LEAK-10-1-1 permit 10
Device(config-route-map)#match ip address 1
Device(config-route-map)#exit
Device(config)#interface Serial 0/0
Device(config-if)#ip summary-address eigrp 1 10.2.2.0 255.0.0.0 leak-map LEAK-10-1-1
Device(config-if)#end
The following example configures GigabitEthernet interface 0/0/0 as a virtual network trunk interface:
Device(config)#interface gigabitethernet 0/0/0
Device(config-if)#vnet global
Device(config-if-vnet)#ip summary-address eigrp 1 10.3.3.0 255.0.0.0 33
Related Commands Command Description
auto-summary (EIGRP) Configures automatic summarization of subnet routes to network-level routes
(default behavior).
summary-metric Configures fixed metrics for an EIGRP summary aggregate address.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1465
Routing
ip route static bfd
ip route static bfd
To specify static route bidirectional forwarding detection (BFD) neighbors, use the ip route static bfd
command in global configuration mode. To remove a static route BFD neighbor, use theno form of this
command
ip route static bfd {interface-type interface-number ip-address | vrf vrf-name} [group group-name]
[passive] [unassociate]
no ip route static bfd {interface-type interface-number ip-address | vrf vrf-name} [group group-name]
[passive] [unassociate]
Syntax Description interface-type interface-number Interface type and number.
ip-address IP address of the gateway, in
A.B.C.D format.
vrf vrf-name Specifies Virtual Routing and
Forwarding (VRF) instance and the
destination vrf name.
group group-name (Optional) Assigns a BFD group.
The group-name is a character
string of up to 32 characters
specifying the BFD group name.
unassociate (Optional) Unassociates the static
route configured for a BFD.
Command Default No static route BFD neighbors are specified.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the ip route static bfd command to specify static route BFD neighbors. All static routes that have the same
interface and gateway specified in the configuration share the same BFD session for reachability notification.
All static routes that specify the same values for the interface-type, interface-number, and ip-address arguments
will automatically use BFD to determine gateway reachability and take advantage of fast failure detection.
The group keyword assigns a BFD group. The static BFD configuration is added to the VPN routing and
forwarding (VRF) instance with which the interface is associated. The passive keyword specifies the passive
member of the group. Adding static BFD in a group without the passive keyword makes the BFD an active
member of the group. A static route should be tracked by the active BFD configuration in order to trigger a
BFD session for the group. To remove all the static BFD configurations (active and passive) of a specific
group, use the no ip route static bfd command and specify the BFD group name.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1466
Routing
ip route static bfd
The unassociate keyword specifies that a BFD neighbor is not associated with static route, and the BFD
sessions are requested if an interface has been configured with BFD. This is useful in bringing up a BFDv4
session in the absence of an IPv4 static route. If the unassociate keyword is not provided, then the IPv4 static
routes are associated with BFD sessions.
BFD requires that BFD sessions are initiated on both endpoint devices. Therefore, this command must be
configured on each endpoint device.
The BFD static session on a switch virtual interface (SVI) is established only after the bfd interval milliseconds
min_rx milliseconds multiplier multiplier-value command is disabled and enabled on that SVI.
To enable the static BFD sessions, perform the following steps:
1. Enable BFD timers on the SVI.
bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
2. Enable BFD for the static IP route
ip route static bfd interface-type interface-number ip-address
3. Disable and enable the BFD timers on the SVI again.
no bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
bfd interval milliseconds min_rx milliseconds multiplier multiplier-value
Examples The following example shows how to configure BFD for all static routes through a specified neighbor,
group, and active member of the group:
Device#configuration terminal
Device(config)#ip route static bfd GigabitEthernet 1/0/1 10.1.1.1 group group1
The following example shows how to configure BFD for all static routes through a specified neighbor,
group, and passive member of the group:
Device#configuration terminal
Device(config)#ip route static bfd GigabitEthernet 1/0/1 10.2.2.2 group group1 passive
The following example shows how to configure BFD for all static routes in an unassociated mode
without the group and passive keywords:
Device#configuration terminal
Device(config)#ip route static bfd GigabitEthernet 1/0/1 10.2.2.2 unassociate
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1467
Routing
ipv6 route static bfd
ipv6 route static bfd
To specify static route Bidirectional Forwarding Detection for IPv6 (BFDv6) neighbors, use the ipv6 route
static bfd command in global configuration mode. To remove a static route BFDv6 neighbor, use theno form
of this command
ipv6 route static bfd [vrf vrf-name] interface-type interface-number ipv6-address [unassociated]
no ipv6 route static bfd
Syntax Description vrf vrf-name (Optional) Name of the virtual
routing and forwarding (VRF)
instance by which static routes
should be specified.
interface-type interface-number Interface type and number.
ipv6-address IPv6 address of the neighbor.
unassociated (Optional) Moves a static BFD
neighbor from associated mode to
unassociated mode.
Command Default No static route BFDv6 neighbors are specified.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the ipv6 route static bfd command to specify static route neighbors. All of the static routes that have the
same interface and gateway specified in the configuration share the same BFDv6 session for reachability
notification. BFDv6 requires that BFDv6 sessions are initiated on both endpoint routers. Therefore, this
command must be configured on each endpoint router. An IPv6 static BFDv6 neighbor must be fully specified
(with the interface and the neighbor address) and must be directly attached.
All static routes that specify the same values for vrf vrf-name, interface-type interface-number , and ipv6-address
will automatically use BFDv6 to determine gateway reachability and take advantage of fast failure detection.
Examples The following example creates a neighbor on Ethernet interface 0/0 with an address of 2001::1:
Device#configuration terminal
Device(config)#ipv6 route static bfd ethernet 0/0 2001::1
The following example converts the neighbor to unassociated mode:
Device#configuration terminal
Device(config)#ipv6 route static bfd ethernet 0/0 2001::1 unassociated
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1468
Routing
metric weights (EIGRP)
metric weights (EIGRP)
To tune the Enhanced Interior Gateway Routing Protocol (EIGRP) metric calculations, use the metric weights
command in router configuration mode or address family configuration mode. To reset the values to their
defaults, use the no form of this command.
Router Configuration
metric weights tos k1 k2 k3 k4 k5
no metric weights
Address Family Configuration
metric weights tos [k1 [k2 [k3 [k4 [k5 [k6]]]]]]
no metric weights
Syntax Description tos Type of service. This value must always be zero.
k1 k2 k3 k4 k5 k6 (Optional) Constants that convert an EIGRP metric vector into a scalar quantity. Valid
values are 0 to 255. Given below are the default values:
• k1: 1
• k2: 0
• k3: 1
• k4: 0
• k5: 0
• k6: 0
Note In address family configuration mode, if the values are not specified, default
values are configured. The k6 argument is supported only in address family
configuration mode.
Command Default EIGRP metric K values are set to their default values.
Command Modes Router configuration (config-router)
Address family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to alter the default behavior of EIGRP routing and metric computation and to allow the
tuning of the EIGRP metric calculation for a particular type of service (ToS).
If k5 equals 0, the composite EIGRP metric is computed according to the following formula:
metric = [k1 * bandwidth + (k2 * bandwidth)/(256 – load) + k3 * delay + K6 * extended metrics]
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1469
Routing
metric weights (EIGRP)
If k5 does not equal zero, an additional operation is performed:
metric = metric * [k5/(reliability + k4)]
Scaled Bandwidth= 107/minimum interface bandwidth (in kilobits per second) * 256
Delay is in tens of microseconds for classic mode and pico seconds for named mode. In classic mode, a delay
of hexadecimal FFFFFFFF (decimal 4294967295) indicates that the network is unreachable. In named mode,
a delay of hexadecimal FFFFFFFFFFFF (decimal 281474976710655) indicates that the network is unreachable.
Reliability is given as a fraction of 255. That is, 255 is 100 percent reliability or a perfectly stable link.
Load is given as a fraction of 255. A load of 255 indicates a completely saturated link.
Examples The following example shows how to set the metric weights to slightly different values than the
defaults:
Device(config)#router eigrp 109
Device(config-router)#network 192.168.0.0
Device(config-router)#metric weights 0 2 0 2 0 0
The following example shows how to configure an address-family metric weight to ToS: 0; K1: 2;
K2: 0; K3: 2; K4: 0; K5: 0; K6:1:
Device(config)#router eigrp virtual-name
Device(config-router)#address-family ipv4 autonomous-system 4533
Device(config-router-af)#metric weights 0 2 0 2 0 0 1
Related Commands Command Description
address-family (EIGRP) Enters address family configuration mode to configure an EIGRP routing
instance.
bandwidth (interface) Sets a bandwidth value for an interface.
delay (interface) Sets a delay value for an interface.
ipv6 router eigrp Configures an IPv6 EIGRP routing process.
metric holddown Keeps new EIGRP routing information from being used for a certain period of
time.
metric maximum-hops Causes IP routing software to advertise routes with a hop count higher than
what is specified by the command (EIGRP only) as unreachable routes.
router eigrp Configures an EIGRP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1470
Routing
neighbor advertisement-interval
neighbor advertisement-interval
To set the minimum route advertisement interval (MRAI) between the sending of BGP routing updates, use
the neighbor advertisement-interval command in address family or router configuration mode. To restore
the default value, use the no form of this command.
neighbor {ip-addresspeer-group-name} advertisement-interval seconds
no neighbor {ip-addresspeer-group-name} advertisement-interval seconds
Syntax Description ip-address IP address of the neighbor.
peer-group-name Name of a BGP peer group.
seconds Time (in seconds) is specified by an integer ranging from 0 to 600.
Command Default eBGP sessions not in a VRF: 30 seconds
eBGP sessions in a VRF: 0 seconds
iBGP sessions: 0 seconds
Command Modes
Router configuration (config-router)
Table 155:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When the MRAI is equal to 0 seconds, BGP routing updates are sent as soon as the BGP routing table changes.
If you specify a BGP peer group by using the peer-group-name argument, all the members of the peer group
will inherit the characteristic configured with this command.
Examples The following router configuration mode example sets the minimum time between sending BGP
routing updates to 10 seconds:
router bgp 5
neighbor 10.4.4.4 advertisement-interval 10
The following address family configuration mode example sets the minimum time between sending
BGP routing updates to 10 seconds:
router bgp 5
address-family ipv4 unicast
neighbor 10.4.4.4 advertisement-interval 10
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1471
Routing
neighbor advertisement-interval
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard IPv4 address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard VPNv4 address prefixes.
neighbor peer-group (creating) Creates a BGP peer group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1472
Routing
neighbor default-originate
neighbor default-originate
To allow a BGP speaker (the local router) to send the default route 0.0.0.0 to a neighbor for use as a default
route, use the neighbor default-originate command in address family or router configuration mode. To send
no route as a default, use the no form of this command.
neighbor {ip-addresspeer-group-name} default-originate [route-map map-name]
no neighbor {ip-addresspeer-group-name} default-originate [route-map map-name]
Syntax Description ip-address IP address of the neighbor.
peer-group-name Name of a BGP peer group.
route-map map-name (Optional) Name of the route map. The route map allows route 0.0.0.0 to be
injected conditionally.
Command Default No default route is sent to the neighbor.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 156:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command does not require the presence of 0.0.0.0 in the local router. When used with a route map, the
default route 0.0.0.0 is injected if the route map contains a match ip address clause and there is a route that
matches the IP access list exactly. The route map can contain other match clauses also.
You can use standard or extended access lists with the neighbor default-originate command.
Examples In the following router configuration example, the local router injects route 0.0.0.0 to the neighbor
172.16.2.3 unconditionally:
router bgp 109
network 172.16.0.0
neighbor 172.16.2.3 remote-as 200
neighbor 172.16.2.3 default-originate
In the following example, the local router injects route 0.0.0.0 to the neighbor 172.16.2.3 only if
there is a route to 192.168.68.0 (that is, if a route with any mask exists, such as 255.255.255.0 or
255.255.0.0):
router bgp 109
network 172.16.0.0
neighbor 172.16.2.3 remote-as 200
neighbor 172.16.2.3 default-originate route-map default-map
!
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1473
Routing
neighbor default-originate
route-map default-map 10 permit
match ip address 1
!
access-list 1 permit 192.168.68.0
In the following example, the last line of the configuration has been changed to show the use of an
extended access list. The local router injects route 0.0.0.0 to the neighbor 172.16.2.3 only if there is
a route to 192.168.68.0 with a mask of 255.255.0.0:
router bgp 109
network 172.16.0.0
neighbor 172.16.2.3 remote-as 200
neighbor 172.16.2.3 default-originate route-map default-map
!
route-map default-map 10 permit
match ip address 100
!
access-list 100 permit ip host 192.168.68.0 host 255.255.0.0
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard IPv4
address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard VPNv4
address prefixes.
neighbor ebgp-multihop Accepts and attempts BGP connections to external peers residing on networks
that are not directly connected.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1474
Routing
neighbor description
neighbor description
To associate a description with a neighbor, use the neighbor description command in router configuration
mode or address family configuration mode. To remove the description, use the no form of this command.
neighbor {ip-addresspeer-group-name} description text
no neighbor {ip-addresspeer-group-name} description [text]
Syntax Description ip-address IP address of the neighbor.
peer-group-name Name of an EIGRP peer group. This argument is not
available in address-family configuration mode.
text Text (up to 80 characters in length) that describes the
neighbor.
Command Default There is no description of the neighbor.
Command Modes Router configuration (config-router) Address family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples In the following examples, the description of the neighbor is “peer with example.com”:
Device(config)#router bgp 109
Device(config-router)#network 172.16.0.0
Device(config-router)#neighbor 172.16.2.3 description peer with example.com
In the following example, the description of the address family neighbor is “address-family-peer”:
Device(config)#router eigrp virtual-name
Device(config-router)#address-family ipv4 autonomous-system 4453
Device(config-router-af)#network 172.16.0.0
Device(config-router-af)#neighbor 172.16.2.3 description address-family-peer
Related Commands Command Description
address-family (EIGRP) Enters address family configuration mode to configure
an EIGRP routing instance.
network (EIGRP) Specifies the network for an EIGRP routing process.
router eigrp Configures the EIGRP address family process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1475
Routing
neighbor ebgp-multihop
neighbor ebgp-multihop
To accept and attempt BGP connections to external peers residing on networks that are not directly connected,
use the neighbor ebgp-multihop command in router configuration mode. To return to the default, use the
no form of this command.
neighbor {ip-addressipv6-addresspeer-group-name} ebgp-multihop [ttl]
no neighbor {ip-addressipv6-addresspeer-group-name} ebgp-multihop
Syntax Description ip-address IP address of the BGP-speaking neighbor.
ipv6-address IPv6 address of the BGP-speaking neighbor.
peer-group-name Name of a BGP peer group.
ttl (Optional) Time-to-live in the range from 1 to 255 hops.
Command Default Only directly connected neighbors are allowed.
Command Modes
Router configuration (config-router)
Table 157:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This feature should be used only under the guidance of Cisco technical support staff.
If you specify a BGP peer group by using the peer-group-name argument, all the members of the peer group
will inherit the characteristic configured with this command.
To prevent the creation of loops through oscillating routes, the multihop will not be established if the only
route to the multihop peer is the default route (0.0.0.0).
Examples The following example allows connections to or from neighbor 10.108.1.1, which resides on a
network that is not directly connected:
Device(config)#router bgp 109
Device(config-router)#neighbor 10.108.1.1 ebgp-multihop
Related Commands Command Description
neighbor advertise-map non-exist-map Allows a BGP speaker (the local router) to send the default
route 0.0.0.0 to a neighbor for use as a default route.
neighbor peer-group (creating) Creates a BGP peer group.
network (BGP and multiprotocol BGP) Specifies the list of networks for the BGP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1476
Routing
neighbor maximum-prefix (BGP)
neighbor maximum-prefix (BGP)
To control how many prefixes can be received from a neighbor, use the neighbor maximum-prefix command
in router configuration mode. To disable this function, use the no form of this command.
neighbor {ip-addresspeer-group-name} maximum-prefix maximum [threshold] [restart restart-interval]
[warning-only]
no neighbor {ip-addresspeer-group-name} maximum-prefix maximum
Syntax Description ip-address IP address of the neighbor.
peer-group-name Name of a Border Gateway Protocol (BGP) peer group.
maximum Maximum number of prefixes allowed from the specified neighbor. The number of
prefixes that can be configured is limited only by the available system resources on a
router.
threshold (Optional) Integer specifying at what percentage of the maximum-prefix limit the router
starts to generate a warning message. The range is from 1 to 100; the default is 75.
restart (Optional) Configures the router that is running BGP to automatically reestablish a
peering session that has been disabled because the maximum-prefix limit has been
exceeded. The restart timer is configured with the restart-interval argument.
restart-interval (Optional) Time interval (in minutes) that a peering session is reestablished. The range
is from 1 to 65535 minutes.
warning-only (optional) Allows the router to generate a sys-log message when the maximum-prefix
limitis exceeded, instead of terminating the peering session.
Command Default This command is disabled by default. Peering sessions are disabled when the maximum number of prefixes
is exceeded. If the restart-interval argument is not configured, a disabled session will stay down after the
maximum-prefix limit is exceeded.
threshold : 75 percent
Command Modes
Router configuration (config-router)
Table 158:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The neighbor maximum-prefixcommand allows you to configure a maximum number of prefixes that a
Border Gateway Protocol (BGP) routing process will accept from the specified peer. This feature provides a
mechanism (in addition to distribute lists, filter lists, and route maps) to control prefixes received from a peer.
When the number of received prefixes exceeds the maximum number configured, BGP disables the peering
session (by default). If the restart keyword is configured, BGP will automatically reestablish the peering
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1477
Routing
neighbor maximum-prefix (BGP)
session at the configured time interval. If the restart keyword is not configured and a peering session is
terminated because the maximum prefix limit has been exceed, the peering session will not be be reestablished
until the clear ip bgp command is entered. If the warning-only keyword is configured, BGP sends only a
log message and continues to peer with the sender.
There is no default limit on the number of prefixes that can be configured with this command. Limitations on
the number of prefixes that can be configured are determined by the amount of available system resources.
Examples In the following example, the maximum prefixes that will be accepted from the 192.168.1.1 neighbor
is set to 1000:
Device(config)#router bgp 40000
Device(config-router)#network 192.168.0.0
Device(config-router)#neighbor 192.168.1.1 maximum-prefix 1000
In the following example, the maximum number of prefixes that will be accepted from the 192.168.2.2
neighbor is set to 5000. The router is also configured to display warning messages when 50 percent
of the maximum-prefix limit (2500 prefixes) has been reached.
Device(config)#router bgp 40000
Device(config-router)#network 192.168.0.0
Device(config-router)#neighbor 192.168.2.2 maximum-prefix 5000 50
In the following example, the maximum number of prefixes that will be accepted from the 192.168.3.3
neighbor is set to 2000. The router is also configured to reestablish a disabled peering session after
30 minutes.
Device(config)#router bgp 40000
Device(config-router) network 192.168.0.0
Device(config-router)#neighbor 192.168.3.3 maximum-prefix 2000 restart 30
In the following example, warning messages will be displayed when the threshold of the
maximum-prefix limit (500 x 0.75 = 375) for the 192.168.4.4 neighbor is exceeded:
Device(config)#router bgp 40000
Device(config-router)#network 192.168.0.0
Device(config-router)#neighbor 192.168.4.4 maximum-prefix 500 warning-only
Related Commands Command Description
clear ip bgp Resets a BGP connection using BGP soft reconfiguration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1478
Routing
neighbor peer-group (assigning members)
neighbor peer-group (assigning members)
To configure a BGP neighbor to be a member of a peer group, use the neighbor peer-group command in
address family or router configuration mode. To remove the neighbor from the peer group, use the noform
of this command.
neighbor {ip-addressipv6-address} peer-group peer-group-name
no neighbor {ip-addressipv6-address} peer-group peer-group-name
Syntax Description ip-address IP address of the BGP neighbor that belongs to the peer group specified by the
peer-group-name argument.
ipv6-address IPv6 address of the BGP neighbor that belongs to the peer group specified by the
peer-group-name argument.
peer-group-name Name of the BGP peer group to which this neighbor belongs.
Command Default There are no BGP neighbors in a peer group.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 159:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The neighbor at the IP address indicated inherits all the configured options of the peer group.
Note Using the no form of the neighbor peer-group command removes all of the BGP configuration for that
neighbor, not just the peer group association.
Examples The following router configuration mode example assigns three neighbors to the peer group named
internal:
Device(config)#router bgp 100
Device(config-router)#neighbor internal peer-group
Device(config-router)#neighbor internal remote-as 100
Device(config-router)#neighbor internal update-source loopback 0
Device(config-router)#neighbor internal route-map set-med out
Device(config-router)#neighbor internal filter-list 1 out
Device(config-router)#neighbor internal filter-list 2 in
Device(config-router)#neighbor 172.16.232.53 peer-group internal
Device(config-router)#neighbor 172.16.232.54 peer-group internal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1479
Routing
neighbor peer-group (assigning members)
Device(config-router)#neighbor 172.16.232.55 peer-group internal
Device(config-router)#neighbor 172.16.232.55 filter-list 3 in
The following address family configuration mode example assigns three neighbors to the peer group
named internal:
Device(config)#router bgp 100
Device(config-router)#address-family ipv4 unicast
Device(config-router)#neighbor internal peer-group
Device(config-router)#neighbor internal remote-as 100
Device(config-router)#neighbor internal update-source loopback 0
Device(config-router)#neighbor internal route-map set-med out
Device(config-router)#neighbor internal filter-list 1 out
Device(config-router)#neighbor internal filter-list 2 in
Device(config-router)#neighbor 172.16.232.53 peer-group internal
Device(config-router)#neighbor 172.16.232.54 peer-group internal
Device(config-router)#neighbor 172.16.232.55 peer-group internal
Device(config-router)#neighbor 172.16.232.55 filter-list 3 in
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard IPv4 address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard VPNv4 address prefixes.
neighbor peer-group (creating) Creates a BGP peer group.
neighbor shutdown Disables a neighbor or peer group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1480
Routing
neighbor peer-group (creating)
neighbor peer-group (creating)
To create a BGP or multiprotocol BGP peer group, use the neighbor peer-group command in address family
or router configuration mode. To remove the peer group and all of its members, use the noform of this
command.
neighbor peer-group-name peer-group
no neighbor peer-group-name peer-group
Syntax Description peer-group-name Name of the BGP peer group.
Command Default There is no BGP peer group.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 160:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Often in a BGP or multiprotocol BGP speaker, many neighbors are configured with the same update policies
(that is, same outbound route maps, distribute lists, filter lists, update source, and so on). Neighbors with the
same update policies can be grouped into peer groups to simplify configuration and make update calculation
more efficient.
Note Peer group members can span multiple logical IP subnets, and can transmit, or pass along, routes from one
peer group member to another.
Once a peer group is created with the neighbor peer-group command, it can be configured with the neighbor
commands. By default, members of the peer group inherit all the configuration options of the peer group.
Members also can be configured to override the options that do not affect outbound updates.
All the peer group members will inherit the current configuration as well as changes made to the peer group.
Peer group members will always inherit the following configuration options by default:
• remote-as (if configured)
• version
• update-source
• outbound route-maps
• outbound filter-lists
• outbound distribute-lists
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1481
Routing
neighbor peer-group (creating)
• minimum-advertisement-interval
• next-hop-self
If a peer group is not configured with a remote-as option, the members can be configured with the neighbor
{ip-address | peer-group-name} remote-as command. This command allows you to create peer groups
containing external BGP (eBGP) neighbors.
Examples The following example configurations show how to create these types of neighbor peer group:
• internal Border Gateway Protocol (iBGP) peer group
• eBGP peer group
• Multiprotocol BGP peer group
In the following example, the peer group named internal configures the members of the peer group
to be iBGP neighbors. By definition, this is an iBGP peer group because the router bgp command
and the neighbor remote-as command indicate the same autonomous system (in this case, autonomous
system 100). All the peer group members use loopback 0 as the update source and use set-med as
the outbound route map. The neighbor internal filter-list 2 in command shows that, except for
172.16.232.55, all the neighbors have filter list 2 as the inbound filter list.
router bgp 100
neighbor internal peer-group
neighbor internal remote-as 100
neighbor internal update-source loopback 0
neighbor internal route-map set-med out
neighbor internal filter-list 1 out
neighbor internal filter-list 2 in
neighbor 172.16.232.53 peer-group internal
neighbor 172.16.232.54 peer-group internal
neighbor 172.16.232.55 peer-group internal
neighbor 172.16.232.55 filter-list 3 in
The following example defines the peer group named external-peers without the neighbor remote-as
command. By definition, this is an eBGP peer group because each individual member of the peer
group is configured with its respective autonomous system number separately. Thus the peer group
consists of members from autonomous systems 200, 300, and 400. All the peer group members have
the set-metric route map as an outbound route map and filter list 99 as an outbound filter list. Except
for neighbor 172.16.232.110, all of them have 101 as the inbound filter list.
router bgp 100
neighbor external-peers peer-group
neighbor external-peers route-map set-metric out
neighbor external-peers filter-list 99 out
neighbor external-peers filter-list 101 in
neighbor 172.16.232.90 remote-as 200
neighbor 172.16.232.90 peer-group external-peers
neighbor 172.16.232.100 remote-as 300
neighbor 172.16.232.100 peer-group external-peers
neighbor 172.16.232.110 remote-as 400
neighbor 172.16.232.110 peer-group external-peers
neighbor 172.16.232.110 filter-list 400 in
In the following example, all members of the peer group are multicast-capable:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1482
Routing
neighbor peer-group (creating)
router bgp 100
neighbor 10.1.1.1 remote-as 1
neighbor 172.16.2.2 remote-as 2
address-family ipv4 multicast
neighbor mygroup peer-group
neighbor 10.1.1.1 peer-group mygroup
neighbor 172.16.2.2 peer-group mygroup
neighbor 10.1.1.1 activate
neighbor 172.16.2.2 activate
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard IPv4
address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard VPNv4
address prefixes.
clear ip bgp peer-group Removes all the members of a BGP peer group.
show ip bgp peer-group Displays information about BGP peer groups.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1483
Routing
neighbor route-map
neighbor route-map
To apply a route map to incoming or outgoing routes, use the neighbor route-map command in address
family or router configuration mode. To remove a route map, use the no form of this command.
neighbor{ip-addresspeer-group-name | ipv6-address[{%}]}route-map map-name{in | out}
no neighbor{ip-addresspeer-group-name | ipv6-address[{%}]}route-map map-name{in | out}
Syntax Description ip-address IP address of the neighbor.
peer-group-name Name of a BGP or multiprotocol BGP peer group.
ipv6-address IPv6 address of the neighbor.
% (Optional) IPv6 link-local address identifier. This keyword needs to be added whenever
a link-local IPv6 address is used outside the context of its interface.
map-name Name of a route map.
in Applies route map to incoming routes.
out Applies route map to outgoing routes.
Command Default No route maps are applied to a peer.
Command Modes Router configuration (config-router)
Table 161:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When specified in address family configuration mode, this command applies a route map to that particular
address family only. When specified in router configuration mode, this command applies a route map to IPv4
or IPv6 unicast routes only.
If an outbound route map is specified, it is proper behavior to only advertise routes that match at least one
section of the route map.
If you specify a BGP or multiprotocol BGP peer group by using the peer-group-name argument, all the
members of the peer group will inherit the characteristic configured with this command. Specifying the
command for a neighbor overrides the inbound policy that is inherited from the peer group.
The % keyword is used whenever link-local IPv6 addresses are used outside the context of their interfaces.
This keyword does not need to be used for non-link-local IPv6 addresses.
Examples The following router configuration mode example applies a route map named internal-map to a BGP
incoming route from 172.16.70.24:
router bgp 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1484
Routing
neighbor route-map
neighbor 172.16.70.24 route-map internal-map in
route-map internal-map
match as-path 1
set local-preference 100
The following address family configuration mode example applies a route map named internal-map
to a multiprotocol BGP incoming route from 172.16.70.24:
router bgp 5
address-family ipv4 multicast
neighbor 172.16.70.24 route-map internal-map in
route-map internal-map
match as-path 1
set local-preference 100
Related Commands Command Description
address-family ipv4 (BGP) Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard IP
Version 4 address prefixes.
address-family ipv6 Enters address family configuration mode for configuring routing sessions
such as BGP that use standard IPv6 address prefixes.
address-family vpnv4 Places the router in address family configuration mode for configuring routing
sessions such as BGP, RIP, or static routing sessions that use standard VPN
Version 4 address prefixes.
address-family vpnv6 Places the router in address family configuration mode for configuring routing
sessions that use standard VPNv6 address prefixes.
neighbor remote-as Creates a BGP peer group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1485
Routing
neighbor update-source
neighbor update-source
To have the Cisco software allow Border Gateway Protocol (BGP) sessions to use any operational interface
for TCP connections, use the neighbor update-source command in router configuration mode. To restore
the interface assignment to the closest interface, which is called the best local address, use the no form of this
command.
neighbor{ip-address | ipv6-address[{%}]peer-group-name}update-source interface-type interface-number
neighbor{ip-address | ipv6-address[{%}]peer-group-name}update-source interface-type interface-number
Syntax Description ip-address IPv4 address of the BGP-speaking neighbor.
ipv6-address IPv6 address of the BGP-speaking neighbor.
% (Optional) IPv6 link-local address identifier. This keyword needs to be added whenever
a link-local IPv6 address is used outside the context of its interface.
peer-group-name Name of a BGP peer group.
interface-type Interface type.
interface-number Interface number.
Command Default Best local address
Command Modes
Router configuration (config-router)
Table 162:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command can work in conjunction with the loopback interface feature described in the “Interface
Configuration Overview” chapter of the Cisco IOS Interface and Hardware Component Configuration Guide.
If you specify a BGP peer group by using the peer-group-name argument, all the members of the peer group
will inherit the characteristic configured with this command.
The neighbor update-source command must be used to enable IPv6 link-local peering for internal or external
BGP sessions.
The % keyword is used whenever link-local IPv6 addresses are used outside the context of their interfaces
and for these link-local IPv6 addresses you must specify the interface they are on. The syntax becomes <IPv6
local-link address>%<interface name>, for example, FE80::1%Ethernet1/0. Note that the interface type and
number must not contain any spaces, and be used in full-length form because name shortening is not supported
in this situation. The % keyword and subsequent interface syntax is not used for non-link-local IPv6 addresses.
Examples The following example sources BGP TCP connections for the specified neighbor with the IP address
of the loopback interface rather than the best local address:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1486
Routing
neighbor update-source
Device(config)#router bgp 65000
Device(config-router)#network 172.16.0.0
Device(config-router)#neighbor 172.16.2.3 remote-as 110
Device(config-router)#neighbor 172.16.2.3 update-source Loopback0
The following example sources IPv6 BGP TCP connections for the specified neighbor in autonomous
system 65000 with the global IPv6 address of loopback interface 0 and the specified neighbor in
autonomous system 65400 with the link-local IPv6 address of Fast Ethernet interface 0/0. Note that
the link-local IPv6 address of FE80::2 is on Ethernet interface 1/0.
Device(config)#router bgp 65000
Device(config-router)#neighbor 3ffe::3 remote-as 65000
Device(config-router)#neighbor 3ffe::3 update-source Loopback0
Device(config-router)#neighbor fe80::2%Ethernet1/0 remote-as 65400
Device(config-router)#neighbor fe80::2%Ethernet1/0 update-source FastEthernet 0/0
Device(config-router)#address-family ipv6
Device(config-router)#neighbor 3ffe::3 activate
Device(config-router)#neighbor fe80::2%Ethernet1/0 activate
Device(config-router)#exit-address-family
Related Commands Command Description
neighbor activate Enables the exchange of information with a BGP neighboring router.
neighbor remote-as Adds an entry to the BGP or multiprotocol BGP neighbor table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1487
Routing
network (BGP and multiprotocol BGP)
network (BGP and multiprotocol BGP)
To specify the networks to be advertised by the Border Gateway Protocol (BGP) and multiprotocol BGP
routing processes, use the network command in address family or router configuration mode. To remove an
entry from the routing table, use the no form of this command.
network {network-number [mask network-mask]nsap-prefix} [route-map map-tag]
no network {network-number [mask network-mask]nsap-prefix} [route-map map-tag]
Syntax Description network-number Network that BGP or multiprotocol BGP will advertise.
mask network-mask (Optional) Network or subnetwork mask with mask address.
nsap-prefix Network service access point (NSAP) prefix of the Connectionless Network Service
(CLNS) network that BGP or multiprotocol BGP will advertise. This argument is
used only under NSAP address family configuration mode.
route-map map-tag (Optional) Identifier of a configured route map. The route map should be examined
to filter the networks to be advertised. If not specified, all networks are advertised.
If the keyword is specified, but no route map tags are listed, no networks will be
advertised.
Command Default No networks are specified.
Command Modes Address family configuration (config-router-af)
Router configuration (config-router)
Table 163:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines BGP and multiprotocol BGP networks can be learned from connected routes, from dynamic routing, and from
static route sources.
The maximum number of network commands you can use is determined by the resources of the router, such
as the configured NVRAM or RAM.
Examples The following example sets up network 10.108.0.0 to be included in the BGP updates:
Device(config)#router bgp 65100
Device(config-router)#network 10.108.0.0
The following example sets up network 10.108.0.0 to be included in the multiprotocol BGP updates:
Device(config)#router bgp 64800
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1488
Routing
network (BGP and multiprotocol BGP)
Device(config-router)#address family ipv4 multicast
Device(config-router)#network 10.108.0.0
The following example advertises NSAP prefix 49.6001 in the multiprotocol BGP updates:
Device(config)#router bgp 64500
Device(config-router)#address-family nsap
Device(config-router)#network 49.6001
Related Commands Command Description
address-family ipv4 (BGP) Enters the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard IP Version 4 address prefixes.
address-family vpnv4 Enters the router in address family configuration mode for configuring
routing sessions such as BGP, RIP, or static routing sessions that use
standard VPNv4 address prefixes.
default-information originate Allows the redistribution of network 0.0.0.0 into BGP.
(BGP)
route-map (IP) Defines the conditions for redistributing routes from one routing
protocol into another.
router bgp Configures the BGP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1489
Routing
network (EIGRP)
network (EIGRP)
To specify the network for an Enhanced Interior Gateway Routing Protocol (EIGRP) routing process, use the
network command in router configuration mode or address-family configuration mode. To remove an entry,
use the no form of this command.
network ip-address [wildcard-mask]
no network ip-address [wildcard-mask]
Syntax Description ip-address IP address of the directly connected network.
wildcard-mask (Optional) EIGRP wildcard bits. Wildcard mask indicates a subnetwork, bitwise complement
of the subnet mask.
Command Default No networks are specified.
Command Modes Router configuration (config-router) Address-family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When the network command is configured for an EIGRP routing process, the router matches one or more
local interfaces. The network command matches only local interfaces that are configured with addresses that
are within the same subnet as the address that has been configured with the networkcommand. The router
then establishes neighbors through the matched interfaces. There is no limit to the number of network statements
(network commands) that can be configured on a router.
Use a wildcard mask as a shortcut to group networks together. A wildcard mask matches everything in the
network part of an IP address with a zero. Wildcard masks target a specific host/IP address, entire network,
subnet, or even a range of IP addresses.
When entered in address-family configuration mode, this command applies only to named EIGRP IPv4
configurations. Named IPv6 and Service Advertisement Framework (SAF) configurations do not support this
command in address-family configuration mode.
Examples The following example configures EIGRP autonomous system 1 and establishes neighbors through
network 172.16.0.0 and 192.168.0.0:
Device(config)#router eigrp 1
Device(config-router)#network 172.16.0.0
Device(config-router)#network 192.168.0.0
Device(config-router)#network 192.168.0.0 0.0.255.255
The following example configures EIGRP address-family autonomous system 4453 and establishes
neighbors through network 172.16.0.0 and 192.168.0.0:
Device(config)#router eigrp virtual-name
Device(config-router)#address-family ipv4 autonomous-system 4453
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1490
Routing
network (EIGRP)
Device(config-router-af)#network 172.16.0.0
Device(config-router-af)#network 192.168.0.0
Related Commands Command Description
address-family (EIGRP) Enters address-family configuration mode to configure an EIGRP routing
instance.
router eigrp Configures the EIGRP address-family process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1491
Routing
nsf (EIGRP)
nsf (EIGRP)
To enable Cisco nonstop forwarding (NSF) operations for the Enhanced Interior Gateway Routing Protocol
(EIGRP), use the nsf command in router configuration or address family configuration mode. To disable
EIGRP NSF and to remove the EIGRP NSF configuration from the running-configuration file, use the no
form of this command.
nsf
no nsf
Syntax Description This command has no arguments or keywords.
Command Default EIGRP NSF is disabled.
Command Modes Router configuration (config-router)
Address family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The nsf command is used to enable or disable EIGRP NSF support on an NSF-capable router. NSF is supported
only on platforms that support High Availability.
Examples The following example shows how to disable NSF:
Device#configure terminal
Device(config)#router eigrp 101
Device(config-router)#no nsf
Device(config-router)#end
The following example shows how to enable EIGRP IPv6 NSF:
Device#configure terminal
Device(config)#router eigrp virtual-name-1
Device(config-router)#address-family ipv6 autonomous-system 10
Device(config-router-af)#nsf
Device(config-router-af)#end
Related Commands Command Description
debug eigrp address-family ipv6 Displays information about EIGRP address family IPv6 event
notifications notifications.
debug eigrp nsf Displays notifications and information about NSF events for an
EIGRP routing process.
debug ip eigrp notifications Displays information and notifications for an EIGRP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1492
Routing
nsf (EIGRP)
Command Description
show ip protocols Displays the parameters and the current state of the active routing
protocol process.
show ipv6 protocols Displays the parameters and the current state of the active IPv6
routing protocol process.
timers graceful-restart purge-time Sets the graceful-restart purge-time timer to determine how long an
NSF-aware router that is running EIGRP must hold routes for an
inactive peer.
timers nsf converge Sets the maximum time that the restarting router must wait for the
end-of-table notification from an NSF-capable or NSF-aware peer.
timers nsf signal Sets the maximum time for the initial restart period.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1493
Routing
offset-list (EIGRP)
offset-list (EIGRP)
To add an offset to incoming and outgoing metrics to routes learned via Enhanced Interior Gateway Routing
Protocol (EIGRP), use the offset-list command in router configuration mode or address family topology
configuration mode. To remove an offset list, use the no form of this command.
offset-list {access-list-numberaccess-list-name} {in | out} offset [interface-type interface-number]
no offset-list {access-list-numberaccess-list-name} {in | out} offset [interface-type interface-number]
Syntax Description access-list-number | Standard access list number or name to be applied. Access list number 0
access-list-name indicates all networks (networks, prefixes, or routes). If the offset value is
0, no action is taken.
in Applies the access list to incoming metrics.
out Applies the access list to outgoing metrics.
offset Positive offset to be applied to metrics for networks matching the access
list. If the offset is 0, no action is taken.
interface-type (Optional) Interface type to which the offset list is applied.
interface-number (Optional) Interface number to which the offset list is applied.
Command Default No offset values are added to incoming or outgoing metrics to routes learned via EIGRP.
Command Modes Router configuration (config-router) Address family topology configuration (config-router-af-topology)
Table 164:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The offset value is added to the routing metric. An offset list with an interface type and interface number is
considered extended and takes precedence over an offset list that is not extended. Therefore, if an entry passes
the extended offset list and the normal offset list, the offset of the extended offset list is added to the metric.
Examples In the following example, the router applies an offset of 10 to the delay component of the router only
to access list 21:
Device(config-router)#offset-list 21 out 10
In the following example, the router applies an offset of 10 to routes learned from Ethernet interface
0:
Device(config-router)#offset-list 21 in 10 ethernet 0
In the following example, the router applies an offset of 10 to routes learned from Ethernet interface
0 in an EIGRP named configuration:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1494
Routing
offset-list (EIGRP)
Device(config)#router eigrp virtual-name
Device(config-router)#address-family ipv4 autonomous-system 1
Device(config-router-af)#topology base
Device(config-router-af-topology)#offset-list 21 in 10 ethernet0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1495
Routing
redistribute (IP)
redistribute (IP)
To redistribute routes from one routing domain into another routing domain, use the redistribute command
in the appropriate configuration mode. To disable all or some part of the redistribution (depending on the
protocol), use the no form of this command. See the “Usage Guidelines” section for detailed, protocol-specific
behaviors.
redistribute protocol [process-id] {level-1 | level-1-2 | level-2} [autonomous-system-number] [metric
{metric-value | transparent}] [metric-type type-value] [match {internal | external 1 | external 2}]
[tag tag-value] [route-map map-tag] [subnets] [nssa-only]
no redistribute protocol [process-id] {level-1 | level-1-2 | level-2} [autonomous-system-number]
[metric {metric-value | transparent}] [metric-type type-value] [match {internal | external 1 |
external 2}] [tag tag-value] [route-map map-tag] [subnets] [nssa-only]
Syntax Description protocol Source protocol from which routes are being redistributed. It
can be one of the following keywords: application, bgp,
connected, eigrp, isis, mobile, ospf, rip, or static [ip].
The static [ip] keyword is used to redistribute IP static routes.
The optional ip keyword is used when redistributing into the
Intermediate System-to-Intermediate System (IS-IS) protocol.
The application keyword is used to redistribute an application
from one routing domain to another. You can redistribute
more than one application to different routing protocols such
as IS-IS, OSPF, Border Gateway Protocol (BGP), Enhanced
Interior Gateway Routing Protocol (EIGRP) and Routing
Information Protocol (RIP).
The connected keyword refers to routes that are established
automatically by virtue of having enabled IP on an interface.
For routing protocols such as Open Shortest Path First (OSPF)
and IS-IS, these routes will be redistributed as external to the
autonomous system.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1496
Routing
redistribute (IP)
process-id (Optional) For the application keyword, this is the name of
an application.
For the bgp or eigrp keyword, this is an autonomous system
number, which is a 16-bit decimal number.
For the isis keyword, this is an optional tag value that defines
a meaningful name for a routing process. Creating a name for
a routing process means that you use names when configuring
routing. You can configure a router in two routing domains
and redistribute routing information between these two
domains.
For the ospf keyword, this is an appropriate OSPF process ID
from which routes are to be redistributed. This identifies the
routing process. This value takes the form of a nonzero
decimal number.
For the rip keyword, no process-id value is needed.
For the application keyword, this is the name of an
application.
By default, no process ID is defined.
level-1 Specifies that, for IS-IS, Level 1 routes are redistributed into
other IP routing protocols independently.
level-1-2 Specifies that, for IS-IS, both Level 1 and Level 2 routes are
redistributed into other IP routing protocols.
level-2 Specifies that, for IS-IS, Level 2 routes are redistributed into
other IP routing protocols independently.
autonomous-system-number (Optional) Autonomous system number for the redistributed
route. The range is from 1 to 65535.
• 4-byte autonomous system numbers are supported in the
range from 1.0 to 65535.65535 in asdot notation only.
For more details about autonomous system number formats,
see the router bgp command.
metric metric-value (Optional) When redistributing from one OSPF process to
another OSPF process on the same router, the metric will be
carried through from one process to the other if no metric
value is specified. When redistributing other processes to an
OSPF process, the default metric is 20 when no metric value
is specified. The default value is 0.
metric transparent (Optional) Causes RIP to use the routing table metric for
redistributed routes as the RIP metric.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1497
Routing
redistribute (IP)
metric-type type value (Optional) For OSPF, specifies the external link type
associated with the default route advertised into the OSPF
routing domain. It can be one of two values:
• 1—Type 1 external route
• 2—Type 2 external route
If a metric-type is not specified, the Cisco IOS software
adopts a Type 2 external route.
For IS-IS, it can be one of two values:
• internal—IS-IS metric that is < 63.
• external—IS-IS metric that is > 64 < 128.
The default is internal.
match {internal | external1 | external2} (Optional) Specifies the criteria by which OSPF routes are
redistributed into other routing domains. It can be one of the
following:
• internal—Routes that are internal to a specific
autonomous system.
• external 1—Routes that are external to the autonomous
system, but are imported into OSPF as Type 1 external
routes.
• external 2—Routes that are external to the autonomous
system, but are imported into OSPF as Type 2 external
routes.
The default is internal.
tag tag-value (Optional) Specifies the 32-bit decimal value attached to each
external route. This is not used by OSPF itself. It may be used
to communicate information between Autonomous System
Boundary Routers (ASBRs). If none is specified, the remote
autonomous system number is used for routes from BGP and
Exterior Gateway Protocol (EGP); for other protocols, zero
(0) is used.
route-map (Optional) Specifies the route map that should be interrogated
to filter the importation of routes from this source routing
protocol to the current routing protocol. If not specified, all
routes are redistributed. If this keyword is specified, but no
route map tags are listed, no routes will be imported.
map-tag (Optional) Identifier of a configured route map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1498
Routing
redistribute (IP)
subnets (Optional) For redistributing routes into OSPF.
Note Irrespective of whether the subnets keyword is
configured or not, the subnets functionality is
enabled by default. This automatic addition
results in the redistribution of classless OSPF
routes.
nssa-only (Optional) Sets the nssa-only attribute for all routes
redistributed into OSPF.
Command Default Route redistribution is disabled.
Command Modes Router configuration (config-router)
Address family configuration (config-af)
Address family topology configuration (config-router-af-topology)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Using the no Form of the redistribute Command
Caution Removing options that you have configured for the redistribute command requires careful use of the no form
of the redistribute command to ensure that you obtain the result that you are expecting. Changing or disabling
any keyword may or may not affect the state of other keywords, depending on the protocol.
It is important to understand that different protocols implement the no form of the redistribute command
differently:
• In BGP, OSPF, and RIP configurations, the no redistribute command removes only the specified
keywords from the redistribute commands in the running configuration. They use the subtractive keyword
method when redistributing from other protocols. For example, in the case of BGP, if you configure no
redistribute static route-map interior, only the route map is removed from the redistribution, leaving
redistribute static in place with no filter.
• The no redistribute isis command removes the IS-IS redistribution from the running configuration.
IS-IS removes the entire command, regardless of whether IS-IS is the redistributed or redistributing
protocol.
• EIGRP used the subtractive keyword method prior to EIGRP component version rel5. Starting with
EIGRP component version rel5, the no redistribute command removes the entire redistribute command
when redistributing from any other protocol.
• An EIGRP routing process is configured when you issue the router eigrp command and then specify a
network for the process using the network sub-command. Suppose that you have not configured an
EIGRP routing process, and that you have configured redistribution of routes from such an EIGRP process
into BGP, OSPF, or RIP. If you use the no redistribute eigrp command to change or disable a parameter
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1499
Routing
redistribute (IP)
in the redistribute eigrp command, the no redistribute eigrp command removes the entire redistribute
eigrp command instead of changing or disabling a specific parameter.
Additional Usage Guidelines for the redistribute Command
A router receiving a link-state protocol with an internal metric will consider the cost of the route from itself
to the redistributing router plus the advertised cost to reach the destination. An external metric only considers
the advertised metric to reach the destination.
Routes learned from IP routing protocols can be redistributed at Level 1 into an attached area or at Level 2.
The level-1-2 keyword allows both Level 1 and Level 2 routes in a single command.
Redistributed routing information must be filtered by the distribute-list out router configuration command.
This guideline ensures that only those routes intended by the administrator are passed along to the receiving
routing protocol.
Whenever you use the redistribute or the default-information router configuration commands to redistribute
routes into an OSPF routing domain, the router automatically becomes an ASBR. However, an ASBR does
not, by default, generate a default route into the OSPF routing domain.
When routes are redistributed into OSPF from protocols other than OSPF or BGP, and no metric has been
specified with the metric-type keyword and type-value argument, OSPF will use 20 as the default metric.
When routes are redistributed into OSPF from BGP, OSPF will use 1 as the default metric. When routes are
redistributed from one OSPF process to another OSPF process, autonomous system external and
not-so-stubby-area (NSSA) routes will use 20 as the default metric. When intra-area and inter-area routes are
redistributed between OSPF processes, the internal OSPF metric from the redistribution source process is
advertised as the external metric in the redistribution destination process. (This is the only case in which the
routing table metric will be preserved when routes are redistributed into OSPF.)
Note The show ip ospf [topology-info] command will display subnets keyword irrespective of whether the subnets
keyword is configured or not. This is because the subnets functionality is enabled by default for OSPF.
On a router internal to an NSSA area, the nssa-only keyword causes the originated type-7 NSSA LSAs to
have their propagate (P) bit set to zero, which prevents area border routers from translating these LSAs into
type-5 external LSAs. On an area border router that is connected to an NSSA and normal areas, the nssa-only
keyword causes the routes to be redistributed only into the NSSA areas.
Routes configured with the connected keyword affected by this redistribute command are the routes not
specified by the network router configuration command.
You cannot use the default-metric command to affect the metric used to advertise connected routes.
Note The metric value specified in the redistribute command supersedes the metric value specified in the
default-metric command.
The default redistribution of Interior Gateway Protocol (IGP) or Exterior Gateway Protocol (EGP) into BGP
is not allowed unless the default-information originate router configuration command is specified.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1500
Routing
redistribute (IP)
4-Byte Autonomous System Number Support
The Cisco implementation of 4-byte autonomous system numbers uses asplain—65538 for example—as the
default regular expression match and output display format for autonomous system numbers, but you can
configure 4-byte autonomous system numbers in both the asplain format and the asdot format as described
in RFC 5396. To change the default regular expression match and output display of 4-byte autonomous system
numbers to asdot format, use the bgp asnotation dot command.
Examples The following example shows how OSPF routes are redistributed into a BGP domain:
Device(config)# router bgp 109
Device(config-router)# redistribute ospf
The following example shows how to redistribute EIGRP routes into an OSPF domain:
Device(config)# router ospf 110
Device(config-router)# redistribute eigrp
The following example shows how to redistribute the specified EIGRP process routes into an OSPF
domain. The EIGRP-derived metric will be remapped to 100 and RIP routes to 200.
Device(config)# router ospf 109
Device(config-router)# redistribute eigrp 108 metric 100 subnets
Device(config-router)# redistribute rip metric 200 subnets
The following example shows how to configure BGP routes to be redistributed into IS-IS. The
link-state cost is specified as 5, and the metric type is set to external, indicating that it has lower
priority than internal metrics.
Device(config)# router isis
Device(config-router)# redistribute bgp 120 metric 5 metric-type external
The following example shows how to redistribute an application into an OSPF domain and specify
a metric value of 5:
Device(config)# router ospf 4
Device(config-router)# redistribute application am metric 5
In the following example, network 172.16.0.0 will appear as an external LSA in OSPF 1 with a cost
of 100 (the cost is preserved):
Device(config)# interface ethernet 0
Device(config-if)# ip address 172.16.0.1 255.0.0.0
Device(config-if)# exit
Device(config)# ip ospf cost 100
Device(config)# interface ethernet 1
Device(config-if)# ip address 10.0.0.1 255.0.0.0
!
Device(config)# router ospf 1
Device(config-router)# network 10.0.0.0 0.255.255.255 area 0
Device(config-if)# exit
Device(config-router)# redistribute ospf 2 subnet
Device(config)# router ospf 2
Device(config-router)# network 172.16.0.0 0.255.255.255 area 0
The following example shows how BGP routes are redistributed into OSPF and assigned the local
4-byte autonomous system number in asplain format.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1501
Routing
redistribute (IP)
Device(config)# router ospf 2
Device(config-router)# redistribute bgp 65538
The following example shows how to remove the connected metric 1000 subnets options from the
redistribute connected metric 1000 subnets command and leave the redistribute connected
command in the configuration:
Device(config-router)# no redistribute connected metric 1000 subnets
The following example shows how to remove the metric 1000 options from the redistribute
connected metric 1000 subnets command and leave the redistribute connected subnets command
in the configuration:
Device(config-router)# no redistribute connected metric 1000
The following example shows how to remove the subnets option from the redistribute connected
metric 1000 subnets command and leave the redistribute connected metric 1000 command in the
configuration:
Device(config-router)# no redistribute connected subnets
The following example shows how to remove the redistribute connected command, and any of the
options that were configured for the redistribute connected command, from the configuration:
Device(config-router)# no redistribute connected
The following example shows how EIGRP routes are redistributed into an EIGRP process in a named
EIGRP configuration:
Device(config)# router eigrp virtual-name
Device(config-router)# address-family ipv4 autonomous-system 1
Device(config-router-af)# topology base
Device(config-router-af-topology)# redistribute eigrp 6473 metric 1 1 1 1 1
The following example shows how to set and disable the redistributions in EIGRP configuration.
Note that, in the case of EIGRP, the no form of the commands removes the entire set of redistribute
commands from the running configuration.
Device(config)# router eigrp 1
Device(config-router)# network 0.0.0.0
Device(config-router)# redistribute eigrp 2 route-map x
Device(config-router)# redistribute ospf 1 route-map x
Device(config-router)# redistribute bgp 1 route-map x
Device(config-router)# redistribute isis level-2 route-map x
Device(config-router)# redistribute rip route-map x
Device(config)# router eigrp 1
Device(config-router)# no redistribute eigrp 2 route-map x
Device(config-router)# no redistribute ospf 1 route-map x
Device(config-router)# no redistribute bgp 1 route-map x
Device(config-router)# no redistribute isis level-2 route-map x
Device(config-router)# no redistribute rip route-map x
Device(config-router)# end
Device# show running-config | section router eigrp 1
router eigrp 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1502
Routing
redistribute (IP)
network 0.0.0.0
The following example shows how to set and disable the redistributions in OSPF configuration. Note
that the no form of the commands removes only the specified keywords from the redistribute
command in the running configuration.
Device(config)# router ospf 1
Device(config-router)# network 0.0.0.0
Device(config-router)# redistribute eigrp 2 route-map x
Device(config-router)# redistribute ospf 1 route-map x
Device(config-router)# redistribute bgp 1 route-map x
Device(config-router)# redistribute isis level-2 route-map x
Device(config-router)# redistribute rip route-map x
Device(config)# router ospf 1
Device(config-router)# no redistribute eigrp 2 route-map x
Device(config-router)# no redistribute ospf 1 route-map x
Device(config-router)# no redistribute bgp 1 route-map x
Device(config-router)# no redistribute isis level-2 route-map x
Device(config-router)# no redistribute rip route-map x
Device(config-router)# end
Device# show running-config | section router ospf 1
router ospf 1
redistribute eigrp 2
redistribute ospf 1
redistribute bgp 1
redistribute rip
network 0.0.0.0
The following example shows how to remove only the route map filter from the redistribution in
BGP; redistribution itself remains in force without a filter:
Device(config)# router bgp 65000
Device(config-router)# no redistribute eigrp 2 route-map x
The following example shows how to remove the EIGRP redistribution to BGP:
Device(config)# router bgp 65000
Device(config-router)# no redistribute eigrp 2
Related Commands Command Description
default-information originate (OSPF) Generates a default route into an OSPF routing domain.
router bgp Configures the BGP routing process.
router eigrp Configures the EIGRP address-family process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1503
Routing
redistribute (IPv6)
redistribute (IPv6)
To redistribute IPv6 routes from one routing domain into another routing domain, use the redistribute
command in IPv6 address family configuration mode. To disable redistribution, use the no form of this
command.
redistribute protocol [{process-id }][{include-connected {level-1 | level-1-2 |
level-2}}][{as-number}][{metric metric-value}]{metric-type type-value}[{nssa-only}][{tag
tag-value}][{route-map map-tag}]
no redistribute protocol [{process-id }][{include-connected {level-1 | level-1-2 |
level-2}}][{as-number}][{metric metric-value}]{metric-type type-value}[{nssa-only}][{tag
tag-value}][{route-map map-tag}]
Syntax Description protocol Source protocol from which routes are redistributed. It can be one of the following
keywords: bgp, connected, eigrp, isis, lisp, nd, omp, ospf (ospfv3), rip, or static.
process-id (Optional) For the bgp or eigrp keyword, the process ID is an autonomous system
number, which is a 16-bit decimal number.
For the isis keyword, the process ID is an optional value that defines a meaningful name
for a routing process. You can specify only one Intermediate System-to-Intermediate
System (IS-IS) process per router. Creating a name for a routing process means that
you use names when configuring routing.
For the ospf keyword, the process ID is the number that is assigned administratively
when the Open Shortest Path First (OSPF) for the IPv6 routing process is enabled.
For the rip keyword, the process ID is an optional value that defines a meaningful name
for an IPv6 Routing Information Protocol (RIP) routing process.
include-connected (Optional) Allows the target protocol to redistribute routes that are learned by the source
protocol and connected prefixes on those interfaces over which the source protocol is
running.
level-1 Specifies that for IS-IS, Level 1 routes are redistributed into other IPv6 routing protocols
independently.
level-1-2 Specifies that for IS-IS, both Level 1 and Level 2 routes are redistributed into other
IPv6 routing protocols.
level-2 Specifies that for IS-IS, Level 2 routes are redistributed into other IPv6 routing protocols
independently.
as-number (Optional) Autonomous system number for the redistributed route.
metric (Optional) When redistributing from one OSPF process to another OSPF process on
metric-value the same router, the metric is carried through from one process to the other if no metric
value is specified. When redistributing other processes to an OSPF process, the default
metric is 20 when no metric value is specified.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1504
Routing
redistribute (IPv6)
metric-type (Optional) Specifies the external link type that is associated with the default route that
type-value is advertised into the routing domain. It can be one of two values:
• 1: Type 1 external route
• 2: Type 2 external route
If no value is specified for the metric-type keyword, the Cisco IOS software adopts a
Type 2 external route.
nssa-only (Optional) Limits redistributed routes to not-so-stubby area (NSSA)
tag tag-value (Optional) Specifies the 32-bit decimal value that is attached to each external route.
This is not used by OSPF itself. It might be used to communicate information between
Autonomous System Boundary Routers (ASBRs). If none is specified, then the remote
autonomous system number is used for routes from the BGP and the Exterior Gateway
Protocol (EGP); for other protocols, zero (0) is used.
route-map (Optional) Specifies the route map that is checked to filter the import of routes from
this source routing protocol to the current routing protocol. If the route-map keyword
is not specified, all the routes are redistributed. If this keyword is specified, but no route
map tags are listed, no routes are imported.
map-tag (Optional) Identifier of a configured route map.
Command Modes Router configuration (config-router)
Address family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This comman
Usage Guidelines Changing or disabling a keyword does not affect the state of other keywords.
IS-IS ignores configured redistribution of routes, if any that are configured with the include-connected
keyword. IS-IS advertises a prefix on an interface if either IS-IS is running over the interface or the interface
is configured as passive.
Routes that are learned from IPv6 routing protocols are redistributed into IPv6 IS-IS at Level 1 into an attached
area, or at Level 2. The level-1-2 keyword allows both Level 1 and Level 2 routes in a single command.
For IPv6 RIP, use the redistribute command to advertise static routes as if they were directly connected
routes.
Note Advertising static routes as directly connected routes might cause routing loops if improperly configured.
Redistributed IPv6 RIP routing information is always filtered by the distribute-list prefix-list command in
router configuration mode. Using the distribute-list prefix-list command ensures that only those routes that
are intended by the administrator are passed along to the receiving routing protocol.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1505
Routing
redistribute (IPv6)
Note The metric value that is specified in the redistribute command for IPv6 RIP supersedes the metric value
that is specified using the default-metric command.
In IPv4, if you redistribute a protocol, by default, you also redistribute the subnet on the interfaces over which
the protocol is running. In IPv6, this is not the default behavior. To redistribute the subnet on the interfaces
over which the protocol is running in IPv6, use the include-connected keyword. In IPv6, this functionality
is not supported when the source protocol is BGP.
When the no redistribute command is configured, the parameter settings are ignored when the client protocol
is IS-IS or EIGRP.
IS-IS redistribution is removed completely when IS-IS Level 1 and Level 2 are removed by you. IS-IS level
settings can be configured using the redistribute command only.
The default redistribute type is restored to OSPFv3 when all route type values are removed by you.
Specify the nssa-only keyword to clear the propagate bit (P-bit) when external routes are redistributed into
an NSSA. Doing so prevents corresponding NSSA external link state advertisements (LSAs) from being
translated into other areas.
Examples The following example shows how to configure IPv6 IS-IS to redistribute IPv6 BGP routes. The
metric is specified as 5, and the metric type is set to 1.
Device> enable
Device# configure terminal
Device(config)# router isis
Device(config-router)# address-family ipv6
Device(config-router-af)# redistribute bgp 64500 metric 5 metric-type 1
The following example shows how to redistribute IPv6 BGP routes into the IPv6 RIP routing process
named cisco:
Device> enable
Device# configure terminal
Device(config)# router rip cisco
Device(config-router)# redistribute bgp 42
The following example shows how to redistribute IS-IS for IPv6 routes into the OSPFv3 for IPv6
routing process 1:
Device> enable
Device# configure terminal
Device(config)# router ospfv3 1
Device(config-router)# address-family ipv6
Device(config-router-af)# redistribute isis 1 metric 32 metric-type 1 tag 85
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1506
Routing
redistribute maximum-prefix (OSPF)
redistribute maximum-prefix (OSPF)
To limit the number of prefixes that are redistributed into Open Shortest Path First (OSPF) or to generate a
warning when the number of prefixes that are redistributed into OSPF reaches a maximum, use the redistribute
maximum-prefix command in router configuration mode. To remove the values, use the no form of this
command.
redistribute maximum-prefix maximum [{percentage}][{warning-only}]
no redistribute
Syntax Description maximum Integer from 1 to 4294967295 that specifies the maximum number of IP or IPv6 prefixes
that can be redistributed into OSPF.
When the warning-only keyword is configured, the maximum value specifies the number
of prefixes that can be redistributed into OSPF before the system logs a warning message.
Redistribution is not limited.
The maximum number of IP or IPv6 prefixes that are allowed to be redistributed into OSPF,
or the number of prefixes that are allowed to be redistributed into OSPF before the system
logs a warning message, depends on whether the warning-only keyword is present.
There is no default value for the maximum argument.
If the warning-only keyword is also configured, this value does not limit redistribution; it
is simply the number of redistributed prefixes that, when reached, causes a warning message
to be logged.
percentage (Optional) Integer from 1 to 100 that specifies the threshold value, as a percentage, at which
a warning message is generated.
The default percentage is 75.
warning-only (Optional) Causes a warning message to be logged when the number of prefixes that are
defined by the maximum argument has been exceeded. Additional redistribution is not
prevented.
Command Default The default percentage is 75.
Command Modes Router configuration (config-router)
Address family configuration (config-router-af)
Command History Release Modific
Cisco IOS XE Everest 16.5.1a This co
Usage Guidelines A network can be severely flooded if many IP or IPv6 prefixes are injected into the OSPF, perhaps by
redistributing Border Gateway Protocol (BGP) into OSPF. Limiting the number of redistributed prefixes
prevents this potential problem.
When the redistribute maximum-prefix command is configured and the number of redistributed prefixes
reaches the maximum value that is configured, no more prefixes are redistributed (unless the warning-only
keyword is configured).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1507
Routing
redistribute maximum-prefix (OSPF)
Examples The following example shows how two warning messages are logged; the first if the number of
prefixes redistributed reaches 85 percent of 600 (510 prefixes), and the second if the number of
redistributed routes reaches 600. However, the number of redistributed routes is not limited.
Device> enable
Device# configure terminal
Device(config)# router ospfv3 11
Device(config-router)# address-family ipv6
Device(config-router-af)# redistribute eigrp 10 subnets
Device(config-router-af)# redistribute maximum-prefix 600 85 warning-only
The following example shows how to set a maximum of 10 prefixes that can be redistributed into
an OSPFv3 process:
Device> enable
Device# configure terminal
Device(config)# router ospfv3 10
Device(config-router)# address-family ipv6 unicast
Device(config-router-af)# redistribute maximum-prefix 10
Device(config-router-af)# redistribute connected
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1508
Routing
rewrite-evpn-rt-asn
rewrite-evpn-rt-asn
To enable the rewrite of the autonomous system number (ASN) portion of the EVPN route target extended
community with the ASN of the target eBGP EVPN peer, use the rewrite-evpn-rt-asn command in address
family configuration mode. Use the no form of the command to disable the rewrite of ASN.
rewrite-evpn-rt-asn
no rewrite-evpn-rt-asn
Syntax Description This command has no arguments or keywords.
Command Modes Address-family configuration (config-router-af)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 The command was introduced.
Usage Guidelines The rewrite-evpn-rt-asn command is required for the route target auto feature to be used to configure EVPN
route targets. Route target auto feature is implemented on all border leaf switches that support BGP EVPN.
The rewrite-evpn-rt-asn command only affects the following:
• EVPN address family.
• Inbound route-reception.
• Routes from eBGP peers.
• Route-type 2 and route-type 5 of EVPN prefixes.
• route target extended community inside the BGP update.
The rewrite-evpn-rt-asn command only works on type 0 and on type 2 of route-target extended communities.
Note Run this command only when route target auto feature is being used and matching route targets are not
manually configured on all switches.
The following example shows how to enable rewrite of ASN using the rewrite-evpn-rt-asn command:
Device# configure terminal
Device(config)# router bgp 10000
Device(config-router)# address-family l2vpn evpn
Device(config-router-af)# rewrite-evpn-rt-asn
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1509
Routing
route-map
route-map
To define conditions for redistributing routes from one routing protocol to another routing protocol, or to
enable policy routing, use the route-map command in global configuration mode. To delete an entry, use the
no form of this command.
route-map map-tag [{permit | deny}] [sequence-number] ordering-seq sequence-name
no route-map map-tag [{permit | deny}] [sequence-number] ordering-seq sequence-name
Syntax Description map-tag Name for the route map.
permit (Optional) Permits only the routes matching the route map to be forwarded
or redistributed.
deny (Optional) Blocks routes matching the route map from being forwarded or
redistributed.
sequence-number (Optional) Number that indicates the position a new route map will have in
the list of route maps already configured with the same name.
ordering-seq sequence-name (Optional) Orders the route maps based on the string provided.
Command Default Policy routing is not enabled, and conditions for redistributing routes from one routing protocol to another
routing protocol are not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the route-map command to enter route-map configuration mode.
Use route maps to redistribute routes, or to subject packets to policy routing. Both these purposes are described
here.
Redistribution
Use the route-map global configuration command and the match and set route-map configuration commands
to define the conditions for redistributing routes from one routing protocol to another. Each route-map
command has a list of match and set commands associated with it. The match commands specify the match
criteria, that is, the conditions under which redistribution is allowed for the current route-map command.
The set commands specify the set actions, that is, the redistribution actions to be performed if the criteria
enforced by the match commands are met. If the route-map command is enabled and the user does not specify
any action, then the permit action is applied by default. The no route-map command deletes the route map.
The match route-map configuration command has multiple formats. The match commands can be run in any
order, and all the match commands must match to cause the route to be redistributed according to the set
actions specified with the set commands. The no forms of the match commands remove the specified match
criteria.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1510
Routing
route-map
Use route maps when you want detailed control over how routes are redistributed between routing processes.
The destination routing protocol is the one you specify with the router global configuration command. The
source routing protocol is the one you specify with the redistribute router configuration command. See the
examples section for an illustration of how route maps are configured.
When passing routes through a route map, the route map can have several parts. Any route that does not match
at least one match clause relating to a route-map command is ignored, that is, the route is not advertised for
outbound route maps, and is not accepted for inbound route maps. If you want to modify only some data,
configure a second route map section with an explicit match specified.
The redistribute router configuration command uses the name specified by the map-tag argument to reference
a route map. Multiple route maps can share the same map tag name.
If the match criteria are met for this route map, and the permit keyword is specified, the route is redistributed
as controlled by the set actions. In the case of policy routing, the packet is policy routed. If the match criteria
are not met, and the permit keyword is specified, the next route map with the same map tag is tested. If a
route passes none of the match criteria for the set of route maps sharing the same name, it is not redistributed
by that set.
If the match criteria are met for the route map, and the deny keyword is specified, the route is not redistributed.
In the case of policy routing, the packet is not policy routed, and no other route maps sharing the same map
tag name are examined. If the packet is not policy routed, the normal forwarding algorithm is used.
Policy Routing
Another purpose of route maps is to enable policy routing. Use the ip policy route-map or ipv6 policy
route-map command in addition to the route-map command, and the match and set commands to define
the conditions for policy-routing packets. The match commands specify the conditions under which policy
routing occurs. The set commands specify the routing actions to be performed if the criteria enforced by the
match commands are met. We recommend that you policy route packets some way other than the obvious
shortest path.
The sequence-number argument works as follows:
• If no entry is defined with the supplied tag, an entry is created with the sequence-number argument set
to 10.
• If only one entry is defined with the supplied tag, that entry becomes the default entry for the route-map
command. The sequence-number argument of this entry is unchanged.
• If more than one entry is defined with the supplied tag, an error message is displayed to indicate that the
sequence-number argument is required.
If the no route-map map-tag command is specified (without the sequence-number argument), the entire route
map is deleted.
Examples The following example shows how to redistribute Routing Information Protocol (RIP) routes with
a hop count equal to 1 to the Open Shortest Path First (OSPF). These routes will be redistributed to
the OSPF as external link-state advertisements (LSAs) with a metric of 5, metric type of type1, and
a tag equal to 1.
Device> enable
Device# configure terminal
Device(config)# router ospf 109
Device(config-router)# redistribute rip route-map rip-to-ospf
Device(config-router)# exit
Device(config)# route-map rip-to-ospf permit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1511
Routing
route-map
Device(config-route-map)# match metric 1
Device(config-route-map)# set metric 5
Device(config-route-map)# set metric-type type1
Device(config-route-map)# set tag 1
The following example for IPv6 shows how to redistribute RIP routes with a hop count equal to 1
to the OSPF. These routes will be redistributed to the OSPF as external LSAs, with a tag equal to
42, and a metric type equal to type1.
Device> enable
Device# configure terminal
Device(config)# ipv6 router ospf 1
Device(config-router)# redistribute rip one route-map rip-to-ospfv3
Device(config-router)# exit
Device(config)# route-map rip-to-ospfv3
Device(config-route-map)# match tag 42
Device(config-route-map)# set metric-type type1
The following named configuration example shows how to redistribute Enhanced Interior Gateway
Routing Protocol (EIGRP) addresses with a hop count equal to 1. These addresses are redistributed
to the EIGRP as external, with a metric of 5, and a tag equal to 1:
Device> enable
Device# configure terminal
Device(config)# router eigrp virtual-name1
Device(config-router)# address-family ipv4 autonomous-system 4453
Device(config-router-af)# topology base
Device(config-router-af-topology)# redistribute eigrp 6473 route-map
virtual-name1-to-virtual-name2
Device(config-router-af-topology)# exit-address-topology
Device(config-router-af)# exit-address-family
Device(config-router)# router eigrp virtual-name2
Device(config-router)# address-family ipv4 autonomous-system 6473
Device(config-router-af)# topology base
Device(config-router-af-topology)# exit-af-topology
Device(config-router-af)# exit-address-family
Device(config)# route-map virtual-name1-to-virtual-name2
Device(config-route-map)# match tag 42
Device(config-route-map)# set metric 5
Device(config-route-map)# set tag 1
Related Commands Command Description
ip policy route-map Identifies a route map to use for policy routing on an interface.
ipv6 policy route-map Configures IPv6 PBR on an interface.
match Matches values from the routing table.
router eigrp Configures the EIGRP address-family process.
set Sets values in the destination routing protocol
show route-map Displays all route maps configured or only the one specified.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1512
Routing
router-id
router-id
To use a fixed router ID, use the router-id command in router configuration mode. To force Open Shortest
Path First (OSPF) to use the previous OSPF router ID behavior, use the no form of this command.
router-id ip-address
no router-id ip-address
Syntax Description ip-address Router ID in IP address format.
Command Default No OSPF routing process is defined.
Command Modes Router configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can configure an arbitrary value in the IP address format for each router. However, each router ID must
be unique.
If this command is used on an OSPF router process which is already active (has neighbors), the new router-ID
is used at the next reload or at a manual OSPF process restart. To manually restart the OSPF process, use the
clear ip ospf command.
Examples The following example specifies a fixed router-id:
router-id 10.1.1.1
Related Commands Command Description
clear ip ospf Clears redistribution based on the OSPF routing process ID.
router ospf Configures the OSPF routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1513
Routing
router bgp
router bgp
To configure the Border Gateway Protocol (BGP) routing process, use the router bgp command in global
configuration mode. To remove a BGP routing process, use the no form of this command.
router bgp autonomous-system-number
no router bgp autonomous-system-number
Syntax Description autonomous-system-number Number of an autonomous system that identifies the router to other BGP
routers and tags the routing information that is passed along. Number in the
range from 1 to 65535.
Command Default No BGP routing process is enabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.12.1 This command was introduced.
Usage Guidelines This command allows you to set up a distributed routing core that automatically guarantees the loop-free
exchange of routing information between autonomous systems.
Cisco has implemented the following two methods of representing autonomous system numbers:
• Asplain—Decimal value notation where both 2-byte and 4-byte autonomous system numbers are
represented by their decimal value. For example, 65526 is a 2-byte autonomous system number and
234567 is a 4-byte autonomous system number.
• Asdot—Autonomous system dot notation where 2-byte autonomous system numbers are represented by
their decimal value and 4-byte autonomous system numbers are represented by a dot notation. For
example, 65526 is a 2-byte autonomous system number and 1.169031 is a 4-byte autonomous system
number (this is dot notation for the 234567 decimal number).
For details about the third method of representing autonomous system numbers, see RFC 5396.
Note In Cisco IOS releases that include 4-byte ASN support, command accounting and command authorization
that include a 4-byte ASN number are sent in the asplain notation irrespective of the format that is used on
the command-line interface.
Asplain as Default Autonomous System Number Formatting
The Cisco implementation of 4-byte autonomous system numbers uses asplain as the default display format
for autonomous system numbers, but you can configure 4-byte autonomous system numbers in both the asplain
and asdot format. In addition, the default format for matching 4-byte autonomous system numbers in regular
expressions is asplain, so you must ensure that any regular expressions to match 4-byte autonomous system
numbers are written in the asplain format. If you want to change the default show command output to display
4-byte autonomous system numbers in the asdot format, use the bgp asnotation dot command under router
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1514
Routing
router bgp
configuration mode. When the asdot format is enabled as the default, any regular expressions to match 4-byte
autonomous system numbers must be written using the asdot format, or the regular expression match will fail.
The tables below show that although you can configure 4-byte autonomous system numbers in either asplain
or asdot format, only one format is used to display show command output and control 4-byte autonomous
system number matching for regular expressions, and the default is asplain format. To display 4-byte
autonomous system numbers in show command output and to control matching for regular expressions in the
asdot format, you must configure the bgp asnotation dot command. After enabling the bgp asnotation dot
command, a hard reset must be initiated for all BGP sessions by entering the clear ip bgp * command.
Note If you are upgrading to an image that supports 4-byte autonomous system numbers, you can still use 2-byte
autonomous system numbers. The show command output and regular expression match are not changed and
remain in asplain (decimal value) format for 2-byte autonomous system numbers regardless of the format
configured for 4-byte autonomous system numbers.
Table 166: Default Asplain 4-Byte Autonomous System Number Format
Format Configuration Format Show Command Output and Regular Expression
Match Format
asplain 2-byte: 1 to 65535 4-byte: 65536 to 2-byte: 1 to 65535 4-byte: 65536 to 4294967295
4294967295
asdot 2-byte: 1 to 65535 4-byte: 1.0 to 65535.65535 2-byte: 1 to 65535 4-byte: 65536 to 4294967295
Table 167: Asdot 4-Byte Autonomous System Number Format
Format Configuration Format Show Command Output and Regular Expression
Match Format
asplain 2-byte: 1 to 65535 4-byte: 65536 to 2-byte: 1 to 65535 4-byte: 1.0 to 65535.65535
4294967295
asdot 2-byte: 1 to 65535 4-byte: 1.0 to 65535.65535 2-byte: 1 to 65535 4-byte: 1.0 to 65535.65535
Reserved and Private Autonomous System Numbers
The Cisco implementation of BGP supports RFC 4893. RFC 4893 was developed to allow BGP to support a
gradual transition from 2-byte autonomous system numbers to 4-byte autonomous system numbers. A new
reserved (private) autonomous system number, 23456, was created by RFC 4893 and this number cannot be
configured as an autonomous system number in the Cisco IOS CLI.
RFC 5398, Autonomous System (AS) Number Reservation for Documentation Use , describes new reserved
autonomous system numbers for documentation purposes. Use of the reserved numbers allow configuration
examples to be accurately documented and avoids conflict with production networks if these configurations
are literally copied. The reserved numbers are documented in the IANA autonomous system number registry.
Reserved 2-byte autonomous system numbers are in the contiguous block, 64496 to 64511 and reserved 4-byte
autonomous system numbers are from 65536 to 65551 inclusive.
Private 2-byte autonomous system numbers are still valid in the range from 64512 to 65534 with 65535 being
reserved for special use. Private autonomous system numbers can be used for internal routing domains but
must be translated for traffic that is routed out to the Internet. BGP should not be configured to advertise
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1515
Routing
router bgp
private autonomous system numbers to external networks. Cisco IOS software does not remove private
autonomous system numbers from routing updates by default. Cisco recommends that ISPs filter private
autonomous system numbers.
Note Autonomous system number assignment for public and private networks is governed by the IANA. For
information about autonomous system numbers, including reserved number assignment, or to apply to register
an autonomous system number, see the following URL: http://www.iana.org/.
Examples The following example shows how to configure a BGP process for autonomous system 45000 and
configures two external BGP neighbors in different autonomous systems using 2-byte autonomous
system numbers:
Device> enable
Device# configure terminal
Device(config)# router bgp 45000
Device(config-router)# neighbor 192.168.1.2 remote-as 40000
Device(config-router)# neighbor 192.168.3.2 remote-as 50000
Device(config-router)# neighbor 192.168.3.2 description finance
Device(config-router)# address-family ipv4
Device(config-router-af)# neighbor 192.168.1.2 activate
Device(config-router-af)# neighbor 192.168.3.2 activate
Device(config-router-af)# no auto-summary
Device(config-router-af)# no synchronization
Device(config-router-af)# network 172.17.1.0 mask 255.255.255.0
Device(config-router-af)# exit-address-family
The following example shows how to configure a BGP process for autonomous system 65538 and
configures two external BGP neighbors in different autonomous systems using 4-byte autonomous
system numbers in asplain notation. This example is supported i n Cisco IOS Release 12.0(32)SY8,
12.0(33)S3, 12.2(33)SRE, 12.2(33)XNE, 12.2(33)SXI1, Cisco IOS XE Release 2.4, and later releases.
Device> enable
Device# configure terminal
Device(config)# router bgp 65538
Device(config-router)# neighbor 192.168.1.2 remote-as 65536
Device(config-router)# neighbor 192.168.3.2 remote-as 65550
Device(config-router)# neighbor 192.168.3.2 description finance
Device(config-router)# address-family ipv4
Device(config-router-af)# neighbor 192.168.1.2 activate
Device(config-router-af)# neighbor 192.168.3.2 activate
Device(config-router-af)# no auto-summary
Device(config-router-af)# no synchronization
Device(config-router-af)# network 172.17.1.0 mask 255.255.255.0
Device(config-router-af)# exit-address-family
Related Commands Command Description
neighbor remote-as Adds an entry to the BGP or multiprotocol BGP neighbor table.
network (BGP and multiprotocol BGP) Specifies the list of networks for the BGP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1516
Routing
router eigrp
router eigrp
To configure the EIGRP routing process, use the router eigrp command in global configuration mode. To
remove an EIGRP routing process, use the no form of this command.
router eigrp {autonomous-system-numbervirtual-instance-name}
no router eigrp {autonomous-system-numbervirtual-instance-name}
Syntax Description autonomous-system-number Autonomous system number that identifies the EIGRP services to the other
EIGRP address-family routers. It is also used to tag routing information. Valid
range is from 1 to 65535.
virtual-instance-name EIGRP virtual instance name. This name must be unique among all the
address-family router processes on a single router, but need not be unique
among routers.
Command Default No EIGRP processes are configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Configuring the router eigrp command with the autonomous-system-number argument creates an EIGRP
configuration referred to as autonomous system (AS) configuration. An EIGRP AS configuration creates an
EIGRP routing instance that can be used for tagging routing information.
Configuring the router eigrp command with the virtual-instance-name argument creates an EIGRP
configuration referred to as EIGRP named configuration. An EIGRP named configuration does not create an
EIGRP routing instance by itself. An EIGRP named configuration is a base configuration that is required to
define address-family configurations under it that are used for routing.
Examples The following example shows how to configure EIGRP process 109:
Device> enable
Device# configure terminal
Device(config)# router eigrp 109
The following example configures an EIGRP address-family routing process and assigns it the name
virtual-name:
Device> enable
Device# configure terminal
Device(config)# router eigrp virtual-name
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1517
Routing
router ospf
router ospf
To configure an OSPF routing process, use the router ospf command in global configuration mode. To
terminate an OSPF routing process, use the no form of this command.
router ospf process-id [vrf vrf-name]
no router ospf process-id [vrf vrf-name]
Syntax Description process-id Internally used identification parameter for an OSPF routing process. It is locally assigned,
and can be a positive integer. A unique value is assigned for each OSPF routing process.
vrf vrf-name (Optional) Specifies the name of the VPN routing and forwarding (VRF) instance to associate
with the OSPF VRF processes.
Command Default No OSPF routing process is defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can specify multiple OSPF routing processes in each router.
After you enter the router ospf command, you can enter the maximum number of paths. There can be between
1 and 32 paths.
Examples The following example shows how to configure an OSPF routing process and assign a process number
of 109:
Device(config)# router ospf 109
The following example shows a basic OSPF configuration using the router ospf command to
configure the OSPF VRF instance processes for the first, second, and third VRFs:
Device> enable
Device# configure terminal
Device(config)# router ospf 12 vrf first
Device(config)# router ospf 13 vrf second
Device(config)# router ospf 14 vrf third
Device(config)# exit
The following example shows how to use the maximum-paths option:
Device> enable
Device# configure terminal
Device(config)# router ospf
Device(config-router)# maximum-paths 2
Device(config-router)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1518
Routing
router ospf
Related Commands Command Description
network area Defines the interfaces on which OSPF runs, and defines the area ID for those interfaces.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1519
Routing
router ospfv3
router ospfv3
To enter Open Shortest Path First Version 3 (OSPFv3) through router configuration mode, use the router
ospfv3 command in global configuration mode.
router ospfv3 [{process-id}]
Syntax Description process-id (Optional) Internal identification. The number that is used here is the number assigned
administratively when enabling the OSPFv3 routing process. The range is 1-65535.
Command Default OSPFv3 routing process is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the router ospfv3 command to enter OSPFv3 router configuration mode. From this mode, you can enter
taddress-family configuration mode for IPv6 or IPv4, and then configure the IPv6 or IPv4 address family.
Examples The following example shows how to enter OSPFv3 router configuration mode:
Device> enable
Device# configure terminal
Device(config)# router ospfv3 1
Device(config-router)#
Related Commands Command Description
address-family ipv6 Enters IPv6 address family configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1520
Routing
send-lifetime
send-lifetime
To set the time period during which an authentication key on a key chain is valid to be sent, use the
send-lifetime command in key chain key configuration mode. To revert to the default value, use the no form
of this command.
send-lifetime [ local ] start-time { infinite end-time | duration seconds }
no send-lifetime
Syntax Description local Specifies the time in local timezone.
start-time Beginning time that the key specified by the key command is valid to be sent. The
syntax can be either of the following:
hh : mm : ss month date year
hh : mm : ss date month year
• hh: Hours
• mm: Minutes
• ss: Seconds
• month: First three letters of the month
• date: Date (1-31)
• year: Year (four digits)
The default start time and the earliest acceptable date is January 1, 1993.
infinite Key is valid to be sent from the start-time value on.
end-time Key is valid to be sent from the start-time value until the end-timevalue. The syntax
is the same as that for the start-timevalue.The end-time value must be after the
start-timevalue. The default end time is an infinite time period.
duration seconds Length of time (in seconds) that the key is valid to be sent. The range is from 1 to
2147483646.
Command Default Forever (the starting time is January 1, 1993, and the ending time is infinite)
Command Modes Key chain key configuration (config-keychain-key)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Bengaluru 17.5.1 The new range of the duration keyword is from 1 to 2147483646.
Usage Guidelines Specify a start-time value and one of the following values: infinite, end-time, or duration seconds.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1521
Routing
send-lifetime
We recommend running Network Time Protocol (NTP) or some other time synchronization method if you
intend to set lifetimes on keys.
If the last key expires, authentication will continue and an error message will be generated. To disable
authentication, you must manually delete the last valid key.
Examples The following example configures a key chain named chain1. The key named key1 will be accepted
from 1:30 p.m. to 3:30 p.m. and be sent from 2:00 p.m. to 3:00 p.m. The key named key2 will be
accepted from 2:30 p.m. to 4:30 p.m. and be sent from 3:00 p.m. to 4:00 p.m. The overlap allows
for migration of keys or a discrepancy in the set time of the router. There is a 30-minute leeway on
each side to handle time differences.
Device(config)# interface GigabitEthernet1/0/1
Device(config-if)# ip rip authentication key-chain chain1
Device(config-if)# ip rip authentication mode md5
Device(config-if)# exit
Device(config)# router rip
Device(config-router)# network 172.19.0.0
Device(config-router)# version 2
Device(config-router)# exit
Device(config)# key chain chain1
Device(config-keychain)# key 1
Device(config-keychain-key)# key-string key1
Device(config-keychain-key)# accept-lifetime 13:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 14:00:00 Jan 25 1996 duration 3600
Device(config-keychain-key)# exit
Device(config-keychain)# key 2
Device(config-keychain)# key-string key2
Device(config-keychain)# accept-lifetime 14:30:00 Jan 25 1996 duration 7200
Device(config-keychain)# send-lifetime 15:00:00 Jan 25 1996 duration 3600
The following example configures a key chain named chain1 for EIGRP address-family. The key
named key1 will be accepted from 1:30 p.m. to 3:30 p.m. and be sent from 2:00 p.m. to 3:00 p.m.
The key named key2 will be accepted from 2:30 p.m. to 4:30 p.m. and be sent from 3:00 p.m. to 4:00
p.m. The overlap allows for migration of keys or a discrepancy in the set time of the router. There
is a 30-minute leeway on each side to handle time differences.
Device(config)# router eigrp 10
Device(config-router)# address-family ipv4 autonomous-system 4453
Device(config-router-af)# network 10.0.0.0
Device(config-router-af)# af-interface ethernet0/0
Device(config-router-af-interface)# authentication key-chain trees
Device(config-router-af-interface)# authentication mode md5
Device(config-router-af-interface)# exit
Device(config-router-af)# exit
Device(config-router)# exit
Device(config)# key chain chain1
Device(config-keychain)# key 1
Device(config-keychain-key)# key-string key1
Device(config-keychain-key)# accept-lifetime 13:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 14:00:00 Jan 25 1996 duration 3600
Device(config-keychain-key)# exit
Device(config-keychain)# key 2
Device(config-keychain-key)# key-string key2
Device(config-keychain-key)# accept-lifetime 14:30:00 Jan 25 1996 duration 7200
Device(config-keychain-key)# send-lifetime 15:00:00 Jan 25 1996 duration 3600
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1522
Routing
send-lifetime
Related Commands Command Description
accept-lifetime Sets the time period during which the authentication key on a key chain is
received as valid.
key Identifies an authentication key on a key chain.
key chain Defines an authentication key chain needed to enable authentication for
routing protocols.
key-string (authentication) Specifies the authentication string for a key.
show key chain Displays authentication key information.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1523
Routing
set community
set community
To set the BGP communities attribute, use the set community route map configuration command. To delete
the entry, use the no form of this command.
set community {community-number [additive] [well-known-community] | none}
no set community
Syntax Description community-number Specifies that community number. Valid values are from 1 to 4294967200,
no-export, or no-advertise.
additive (Optional) Adds the community to the already existing communities.
well-known-community (Optional) Well know communities can be specified by using the following
keywords:
• internet
• local-as
• no-advertise
• no-export
none (Optional) Removes the community attribute from the prefixes that pass the route
map.
Command Default No BGP communities attributes exist.
Command Modes
Route-map configuration (config-route-map)
Table 168:
Command History
Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You must have a match clause (even if it points to a “permit everything” list) if you want to set tags.
Use the route-map global configuration command, and the match and set route map configuration commands,
to define the conditions for redistributing routes from one routing protocol into another. Each route-map
command has a list of match and set commands associated with it. The match commands specify the match
criteria --the conditions under which redistribution is allowed for the current route-mapcommand. The set
commands specify the set actions --the particular redistribution actions to perform if the criteria enforced by
the match commands are met. The no route-map command deletes the route map.
The set route map configuration commands specify the redistribution set actions to be performed when all of
the match criteria of a route map are met. When all match criteria are met, all set actions are performed.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1524
Routing
set community
Examples In the following example, routes that pass the autonomous system path access list 1 have the
community set to 109. Routes that pass the autonomous system path access list 2 have the community
set to no-export (these routes will not be advertised to any external BGP [eBGP] peers).
route-map set_community 10 permit
match as-path 1
set community 109
route-map set_community 20 permit
match as-path 2
set community no-export
In the following similar example, routes that pass the autonomous system path access list 1 have the
community set to 109. Routes that pass the autonomous system path access list 2 have the community
set to local-as (the router will not advertise this route to peers outside the local autonomous system.
route-map set_community 10 permit
match as-path 1
set community 109
route-map set_community 20 permit
match as-path 2
set community local-as
Related Commands Command Description
ip community-list Creates a community list for BGP and control access to it.
match community Matches a BGP community.
route-map (IP) Defines the conditions for redistributing routes from one routing protocol into
another, or enables policy routing.
set comm-list delete Removes communities from the community attribute of an inbound or outbound
update.
show ip bgp community Displays routes that belong to specified BGP communities.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1525
Routing
set ip next-hop (BGP)
set ip next-hop (BGP)
To indicate where to output packets that pass a match clause of a route map for policy routing, use the set ip
next-hop command in route-map configuration mode. To delete an entry, use the no form of this command.
set ip next-hop ip-address[{...ip-address}][{peer-address}]
no set ip next-hop ip-address[{...ip-address}][{peer-address}]
Syntax Description ip-address IP address of the next hop to which packets are output. It need not be an adjacent router.
peer-address (Optional) Sets the next hop to be the BGP peering address.
Command Default This command is disabled by default.
Command Modes
Route-map configuration (config-route-map)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines An ellipsis (...) in the command syntax indicates that your command input can include multiple values for the
ip-address argument.
Use the ip policy route-map interface configuration command, the route-map global configuration command,
and the match and set route-map configuration commands to define the conditions for policy routing packets.
The ip policy route-map command identifies a route map by name. Each route-map command has a list of
match and set commands associated with it. The match commands specify the match criteria --the conditions
under which policy routing occurs. The set commands specify the set actions --the particular routing actions
to perform if the criteria enforced by the match commands are met.
If the first next hop specified with the set ip next-hop command is down, the optionally specified IP addresses
are tried in turn.
When the set ip next-hop command is used with the peer-address keyword in an inbound route map of a
BGP peer, the next hop of the received matching routes will be set to be the neighbor peering address, overriding
any third-party next hops. So the same route map can be applied to multiple BGP peers to override third-party
next hops.
When the set ip next-hop command is used with the peer-address keyword in an outbound route map of a
BGP peer, the next hop of the advertised matching routes will be set to be the peering address of the local
router, thus disabling the next hop calculation. The set ip next-hop command has finer granularity than the
(per-neighbor) neighbor next-hop-self command, because you can set the next hop for some routes, but not
others. The neighbor next-hop-self command sets the next hop for all routes sent to that neighbor.
The set clauses can be used in conjunction with one another. They are evaluated in the following order:
1. set ip next-hop
2. set interface
3. set ip default next-hop
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1526
Routing
set ip next-hop (BGP)
4. set default interface
Note To avoid a common configuration error for reflected routes, do not use the set ip next-hop command in a
route map to be applied to BGP route reflector clients.
Configuring the set ip next-hop ...ip-address command on a VRF interface allows the next hop to be looked
up in a specified VRF address family. In this context, the ...ip-address argument matches that of the specified
VRF instance.
Examples In the following example, three routers are on the same FDDI LAN (with IP addresses 10.1.1.1,
10.1.1.2, and 10.1.1.3). Each is in a different autonomous system. The set ip next-hop peer-address
command specifies that traffic from the router (10.1.1.3) in remote autonomous system 300 for the
router (10.1.1.1) in remote autonomous system 100 that matches the route map is passed through the
router bgp 200, rather than sent directly to the router (10.1.1.1) in autonomous system 100 over their
mutual connection to the LAN.
Device(config)#router bgp 200
Device(config)#neighbor 10.1.1.3 remote-as 300
Device(config)#neighbor 10.1.1.3 route-map set-peer-address out
Device(config)#neighbor 10.1.1.1 remote-as 100
Device(config)#route-map set-peer-address permit 10
Device(config)#set ip next-hop peer-address
Related Commands Command Description
ip policy route-map Identifies a route map to use for policy routing on an interface.
match ip address Distributes any routes that have a destination network number address that is
permitted by a standard or extended access list, and performs policy routing on
packets.
match length Bases policy routing on the Level 3 length of a packet.
neighbor next-hop-self Disables next hop processing of BGP updates on the router.
route-map (IP) Defines the conditions for redistributing routes from one routing protocol to
another, or enables policy routing.
set default interface Indicates where to output packets that pass a match clause of a route map for
policy routing and that have no explicit route to the destination.
set interface Indicates where to output packets that pass a match clause of a route map for
policy routing.
set ip default next-hop Indicates where to output packets that pass a match clause of a route map for
policy routing and for which the Cisco IOS software has no explicit route to a
destination.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1527
Routing
show ip bgp
show ip bgp
To display entries in the Border Gateway Protocol (BGP) routing table, use the show ip bgp command in
user EXEC or privileged EXEC mode.
show ip bgp [{ip-address [{mask [{longer-prefixes [{injected}] | shorter-prefixes [{length}] |
best-path-reason | bestpath | multipaths | subnets}] | best-path-reason | bestpath | internal |
multipaths}] | all | oer-paths | prefix-list name | pending-prefixes | route-map name | version
{version-number | recent offset-value}}]
Syntax Description ip-address (Optional) IP address entered to filter the output to display only a particular host
or network in the BGP routing table.
mask (Optional) Mask to filter or match hosts that are part of the specified network.
longer-prefixes (Optional) Displays the specified route and all more-specific routes.
injected (Optional) Displays more-specific prefixes injected into the BGP routing table.
shorter-prefixes (Optional) Displays the specified route and all less-specific routes.
length (Optional) The prefix length. The range is a number from 0 to 32.
bestpath (Optional) Displays the best path for this prefix.
best-path-reason (Optional) Displays the reason why a path loses to the bestpath.
Note If the best-path is yet to be selected, then the output will be 'Best Path
Evaluation: No best path'
internal (Optional) Displays the internal details for this prefix.
multipaths (Optional) Displays multipaths for this prefix.
subnets (Optional) Displays the subnet routes for the specified prefix.
all (Optional) Displays all address family information in the BGP routing table.
oer-paths (Optional) Displays Optimized Edge Routing (OER) controlled prefixes in the
BGP routing table.
prefix-list name (Optional) Filters the output based on the specified prefix list.
pending-prefixes (Optional) Displays prefixes that are pending deletion from the BGP routing table.
route-map name (Optional) Filters the output based on the specified route map.
version version-number (Optional) Displays all prefixes with network versions greater than or equal to the
specified version number. The range is from 1 to 4294967295.
recent offset-value (Optional) Displays the offset from the current routing table version. The range is
from 1 to 4294967295.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1528
Routing
show ip bgp
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.10.1 The best-path-reason keyword was added to this
command.
BGP Path Installation Time-Stamp was added to the
output of the command.
BGP Peak Prefix Watermark was added to the output
of the command.
Usage Guidelines The show ip bgp command is used to display the contents of the BGP routing table. The output can be filtered
to display entries for a specific prefix, prefix length, and prefixes injected through a prefix list, route map, or
conditional advertisement.
When changes are made to the network address, the network version number is incremented. Use the version
keyword to view a specific network version.
show ip bgp: Example
The following sample output displays the BGP routing table:
Device#show ip bgp
BGP table version is 6, local router ID is 10.0.96.2
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale, m multipath, b backup-path, x best-external, f
RT-Filter, a additional-path
Origin codes: i - IGP, e - EGP, ? - incomplete
RPKI validation codes: V valid, I invalid, N Not found
Network Next Hop Metric LocPrf Weight Path
N* 10.0.0.1 10.0.0.3 0 0 3 ?
N*> 10.0.3.5 0 0 4 ?
Nr 10.0.0.0/8 10.0.0.3 0 0 3 ?
Nr> 10.0.3.5 0 0 4 ?
Nr> 10.0.0.0/24 10.0.0.3 0 0 3 ?
V*> 10.0.2.0/24 0.0.0.0 0 32768 i
Vr> 10.0.3.0/24 10.0.3.5 0 0 4 ?
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1529
Routing
show ip bgp
Table 169: show ip bgp Field Descriptions
Field Description
BGP table version Internal version number of the table. This number is incremented whenever the table
changes.
local router ID IP address of the router.
Status codes Status of the table entry. The status is displayed at the beginning of each line in the
table. It can be one of the following values:
• s—The table entry is suppressed.
• d—The table entry is dampened.
• h—The table entry history.
• *—The table entry is valid.
• >—The table entry is the best entry to use for that network.
• i—The table entry was learned via an internal BGP (iBGP) session.
• r—The table entry is a RIB-failure.
• S—The table entry is stale.
• m—The table entry has multipath to use for that network.
• b—The table entry has a backup path to use for that network.
• x—The table entry has a best external route to use for the network.
Origin codes Origin of the entry. The origin code is placed at the end of each line in the table. It
can be one of the following values:
• a—Path is selected as an additional path.
• i—Entry originated from an Interior Gateway Protocol (IGP) and was advertised
with a network router configuration command.
• e—Entry originated from an Exterior Gateway Protocol (EGP).
• ?—Origin of the path is not clear. Usually, this is a router that is redistributed
into BGP from an IGP.
RPKI validation codes If shown, the RPKI validation state for the network prefix, which is downloaded
from the RPKI server. The codes are shown only if the bgp rpki server or neighbor
announce rpki state command is configured.
Network IP address of a network entity.
Next Hop IP address of the next system that is used when forwarding a packet to the destination
network. An entry of 0.0.0.0 indicates that the router has some non-BGP routes to
this network.
Metric If shown, the value of the interautonomous system metric.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1530
Routing
show ip bgp
Field Description
LocPrf Local preference value as set with the set local-preference route-map configuration
command. The default value is 100.
Weight Weight of the route as set via autonomous system filters.
Path Autonomous system paths to the destination network. There can be one entry in this
field for each autonomous system in the path.
(stale) Indicates that the following path for the specified autonomous system is marked as
“stale” during a graceful restart process.
Updated on The time at which the path is received or updated.
show ip bgp (4-Byte Autonomous System Numbers): Example
The following sample output shows the BGP routing table with 4-byte autonomous system numbers,
65536 and 65550, shown under the Path field. This example requires Cisco IOS Release 12.0(32)SY8,
12.0(33)S3, 12.2(33)SRE, 12.2(33)XNE, 12.2(33)SXI1, Cisco IOS XE Release 2.4, or a later release.
Device#show ip bgp
BGP table version is 4, local router ID is 172.16.1.99
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 10.1.1.0/24 192.168.1.2 0 0 65536 i
*> 10.2.2.0/24 192.168.3.2 0 0 65550 i
*> 172.16.1.0/24 0.0.0.0 0 32768 i
show ip bgp network: Example
The following sample output displays information about the 192.168.1.0 entry in the BGP routing
table:
Device#show ip bgp 192.168.1.0
BGP routing table entry for 192.168.1.0/24, version 22
Paths: (2 available, best #2, table default)
Additional-path
Advertised to update-groups:
3
10 10
192.168.3.2 from 172.16.1.2 (10.2.2.2)
Origin IGP, metric 0, localpref 100, valid, internal, backup/repair
10 10
192.168.1.2 from 192.168.1.2 (10.3.3.3)
Origin IGP, localpref 100, valid, external, best , recursive-via-connected
The following sample output displays information about the 10.3.3.3 255.255.255.255 entry in the
BGP routing table:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1531
Routing
show ip bgp
Device#show ip bgp 10.3.3.3 255.255.255.255
BGP routing table entry for 10.3.3.3/32, version 35
Paths: (3 available, best #2, table default)
Multipath: eBGP
Flag: 0x860
Advertised to update-groups:
1
200
10.71.8.165 from 10.71.8.165 (192.168.0.102)
Origin incomplete, localpref 100, valid, external, backup/repair
Only allowed to recurse through connected route
200
10.71.11.165 from 10.71.11.165 (192.168.0.102)
Origin incomplete, localpref 100, weight 100, valid, external, best
Only allowed to recurse through connected route
200
10.71.10.165 from 10.71.10.165 (192.168.0.104)
Origin incomplete, localpref 100, valid, external,
Only allowed to recurse through connected route
The table below describes the significant fields shown in the display.
Table 170: show ip bgp ip-address Field Descriptions
Field Description
BGP routing table entry for IP address or network number of the routing table entry.
version Internal version number of the table. This number is incremented whenever the
table changes.
Paths The number of available paths, and the number of installed best paths. This
line displays “Default-IP-Routing-Table” when the best path is installed in the
IP routing table.
Multipath This field is displayed when multipath load sharing is enabled. This field will
indicate if the multipaths are iBGP or eBGP.
Advertised to update-groups The number of each update group for which advertisements are processed.
Origin Origin of the entry. The origin can be IGP, EGP, or incomplete. This line
displays the configured metric (0 if no metric is configured), the local preference
value (100 is default), and the status and type of route (internal, external,
multipath, best).
Extended Community This field is displayed if the route carries an extended community attribute.
The attribute code is displayed on this line. Information about the extended
community is displayed on a subsequent line.
show ip bgp all: Example
The following is sample output from the show ip bgp command entered with the all keyword.
Information about all configured address families is displayed.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1532
Routing
show ip bgp
Device#show ip bgp all
For address family: IPv4 Unicast *****
BGP table version is 27, local router ID is 10.1.1.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 10.1.1.0/24 0.0.0.0 0 32768 ?
*> 10.13.13.0/24 0.0.0.0 0 32768 ?
*> 10.15.15.0/24 0.0.0.0 0 32768 ?
*>i10.18.18.0/24 172.16.14.105 1388 91351 0 100 e
*>i10.100.0.0/16 172.16.14.107 262 272 0 1 2 3 i
*>i10.100.0.0/16 172.16.14.105 1388 91351 0 100 e
*>i10.101.0.0/16 172.16.14.105 1388 91351 0 100 e
*>i10.103.0.0/16 172.16.14.101 1388 173 173 100 e
*>i10.104.0.0/16 172.16.14.101 1388 173 173 100 e
*>i10.100.0.0/16 172.16.14.106 2219 20889 0 53285 33299 51178 47751 e
*>i10.101.0.0/16 172.16.14.106 2219 20889 0 53285 33299 51178 47751 e
* 10.100.0.0/16 172.16.14.109 2309 0 200 300 e
*> 172.16.14.108 1388 0 100 e
* 10.101.0.0/16 172.16.14.109 2309 0 200 300 e
*> 172.16.14.108 1388 0 100 e
*> 10.102.0.0/16 172.16.14.108 1388 0 100 e
*> 172.16.14.0/24 0.0.0.0 0 32768 ?
*> 192.168.5.0 0.0.0.0 0 32768 ?
*> 10.80.0.0/16 172.16.14.108 1388 0 50 e
*> 10.80.0.0/16 172.16.14.108 1388 0 50 e
For address family: VPNv4 Unicast *****
BGP table version is 21, local router ID is 10.1.1.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
Route Distinguisher: 1:1 (default for vrf vpn1)
*> 10.1.1.0/24 192.168.4.3 1622 0 100 53285 33299 51178
{27016,57039,16690} e
*> 10.1.2.0/24 192.168.4.3 1622 0 100 53285 33299 51178
{27016,57039,16690} e
*> 10.1.3.0/24 192.168.4.3 1622 0 100 53285 33299 51178
{27016,57039,16690} e
*> 10.1.4.0/24 192.168.4.3 1622 0 100 53285 33299 51178
{27016,57039,16690} e
*> 10.1.5.0/24 192.168.4.3 1622 0 100 53285 33299 51178
{27016,57039,16690} e
*>i172.17.1.0/24 10.3.3.3 10 30 0 53285 33299 51178 47751 ?
*>i172.17.2.0/24 10.3.3.3 10 30 0 53285 33299 51178 47751 ?
*>i172.17.3.0/24 10.3.3.3 10 30 0 53285 33299 51178 47751 ?
*>i172.17.4.0/24 10.3.3.3 10 30 0 53285 33299 51178 47751 ?
*>i172.17.5.0/24 10.3.3.3 10 30 0 53285 33299 51178 47751 ?
For address family: IPv4 Multicast *****
BGP table version is 11, local router ID is 10.1.1.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 10.40.40.0/26 172.16.14.110 2219 0 21 22 {51178,47751,27016} e
* 10.1.1.1 1622 0 15 20 1 {2} e
*> 10.40.40.64/26 172.16.14.110 2219 0 21 22 {51178,47751,27016} e
* 10.1.1.1 1622 0 15 20 1 {2} e
*> 10.40.40.128/26 172.16.14.110 2219 0 21 22 {51178,47751,27016} e
* 10.1.1.1 2563 0 15 20 1 {2} e
*> 10.40.40.192/26 10.1.1.1 2563 0 15 20 1 {2} e
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1533
Routing
show ip bgp
*> 10.40.41.0/26 10.1.1.1 1209 0 15 20 1 {2} e
*>i10.102.0.0/16 10.1.1.1 300 500 0 5 4 {101,102} e
*>i10.103.0.0/16 10.1.1.1 300 500 0 5 4 {101,102} e
For address family: NSAP Unicast *****
BGP table version is 1, local router ID is 10.1.1.1
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
* i45.0000.0002.0001.000c.00 49.0001.0000.0000.0a00 100 0 ?
* i46.0001.0000.0000.0000.0a00 49.0001.0000.0000.0a00 100 0 ?
* i47.0001.0000.0000.000b.00 49.0001.0000.0000.0a00 100 0 ?
* i47.0001.0000.0000.000e.00 49.0001.0000.0000.0a00
show ip bgp longer-prefixes: Example
The following is sample output from the show ip bgp longer-prefixes command:
Device#show ip bgp 10.92.0.0 255.255.0.0 longer-prefixes
BGP table version is 1738, local router ID is 192.168.72.24
Status codes: s suppressed, * valid, > best, i - internal
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 10.92.0.0 10.92.72.30 8896 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.1.0 10.92.72.30 8796 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.11.0 10.92.72.30 42482 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.14.0 10.92.72.30 8796 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.15.0 10.92.72.30 8696 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.16.0 10.92.72.30 1400 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.17.0 10.92.72.30 1400 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.18.0 10.92.72.30 8876 32768 ?
* 10.92.72.30 0 109 108 ?
*> 10.92.19.0 10.92.72.30 8876 32768 ?
* 10.92.72.30 0 109 108 ?
show ip bgp shorter-prefixes: Example
The following is sample output from the show ip bgp shorter-prefixes command. An 8-bit prefix
length is specified.
Device#show ip bgp 172.16.0.0/16 shorter-prefixes 8
*> 172.16.0.0 10.0.0.2 0 ?
* 10.0.0.2 0 0 200 ?
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1534
Routing
show ip bgp
show ip bgp prefix-list: Example
The following is sample output from the show ip bgp prefix-list command:
Device#show ip bgp prefix-list ROUTE
BGP table version is 39, local router ID is 10.0.0.1
Status codes:s suppressed, d damped, h history, * valid, > best, i -
internal
Origin codes:i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 192.168.1.0 10.0.0.2 0 ?
* 10.0.0.2 0 0 200 ?
show ip bgp route-map: Example
The following is sample output from the show ip bgp route-map command:
Device#show ip bgp route-map LEARNED_PATH
BGP table version is 40, local router ID is 10.0.0.1
Status codes:s suppressed, d damped, h history, * valid, > best, i -
internal
Origin codes:i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 192.168.1.0 10.0.0.2 0 ?
* 10.0.0.2 0 0 200 ?
show ip bgp (Additional Paths): Example
The following output indicates (for each neighbor) whether any of the additional path tags (group-best,
all, best 2 or best 3) are applied to the path. A line of output indicates rx pathid (received from
neighbor) and tx pathid (announcing to neighbors). Note that the “Path advertised to update-groups:”
is now per-path when the BGP Additional Paths feature is enabled.
Device#show ip bgp 10.0.0.1 255.255.255.224
BGP routing table entry for 10.0.0.1/28, version 82
Paths: (10 available, best #5, table default)
Path advertised to update-groups:
21 25
Refresh Epoch 1
20 50, (Received from a RR-client)
192.0.2.1 from 192.0.2.1 (192.0.2.1)
Origin IGP, metric 200, localpref 100, valid, internal, all
Originator: 192.0.2.1, Cluster list: 2.2.2.2
mpls labels in/out 16/nolabel
rx pathid: 0, tx pathid: 0x9
Updated on Aug 14 2018 18:30:39 PST
Path advertised to update-groups:
18 21
Refresh Epoch 1
30
192.0.2.2 from 192.0.2.2 (192.0.2.2)
Origin IGP, metric 200, localpref 100, valid, internal, group-best, all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1535
Routing
show ip bgp
Originator: 192.0.2.2, Cluster list: 4.4.4.4
mpls labels in/out 16/nolabel
rx pathid: 0x1, tx pathid: 0x8
Updated on Aug 14 2018 18:30:39 PST
Path advertised to update-groups:
16 18 19 20 21 22 24
25 27
Refresh Epoch 1
10
192.0.2.3 from 192.0.2.3 (192.0.2.3)
Origin IGP, metric 200, localpref 100, valid, external, best2, all
mpls labels in/out 16/nolabel
rx pathid: 0, tx pathid: 0x7
Updated on Aug 14 2018 18:30:39 PST
Path advertised to update-groups:
20 21 22 24 25
Refresh Epoch 1
10
192.0.2.4 from 192.0.2.4 (192.0.2.4)
Origin IGP, metric 300, localpref 100, valid, external, best3, all
mpls labels in/out 16/nolabel
rx pathid: 0, tx pathid: 0x6
Updated on Jun 17 2018 11:12:30 PST
Path advertised to update-groups:
10 13 17 18 19 20 21
22 23 24 25 26 27 28
Refresh Epoch 1
10
192.0.2.5 from 192.0.2.5 (192.0.2.5)
Origin IGP, metric 100, localpref 100, valid, external, best
mpls labels in/out 16/nolabel
rx pathid: 0, tx pathid: 0x0
Updated on Jun 17 2018 11:12:30 PST
Path advertised to update-groups:
21
Refresh Epoch 1
30
192.0.2.6 from 192.0.2.6 (192.0.2.6)
Origin IGP, metric 200, localpref 100, valid, internal, all
Originator: 192.0.2.6, Cluster list: 5.5.5.5
mpls labels in/out 16/nolabel
rx pathid: 0x1, tx pathid: 0x5
Updated on Jun 17 2018 11:12:30 PST
Path advertised to update-groups:
18 23 24 26 28
Refresh Epoch 1
60 40, (Received from a RR-client)
192.0.2.7 from 192.0.2.7 (192.0.2.7)
Origin IGP, metric 250, localpref 100, valid, internal, group-best
Originator: 192.0.2.7, Cluster list: 3.3.3.3
mpls labels in/out 16/nolabel
rx pathid: 0x2, tx pathid: 0x2
Updated on Jun 17 2018 11:12:30 PST
Path advertised to update-groups:
25
Refresh Epoch 1
30 40, (Received from a RR-client)
192.0.2.8 from 192.0.2.8 (192.0.2.8)
Origin IGP, metric 200, localpref 100, valid, internal, all
Originator: 192.0.2.8, Cluster list: 2.2.2.2
mpls labels in/out 16/nolabel
rx pathid: 0x1, tx pathid: 0x3
Updated on Jun 17 2018 11:12:30 PST
Path advertised to update-groups:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1536
Routing
show ip bgp
18 21 23 24 25 26 28
Refresh Epoch 1
20 40, (Received from a RR-client)
192.0.2.9 from 192.0.2.9 (192.0.2.9)
Origin IGP, metric 200, localpref 100, valid, internal, group-best, all
Originator: 192.0.2.9, Cluster list: 2.2.2.2
mpls labels in/out 16/nolabel
rx pathid: 0x1, tx pathid: 0x4
Updated on Jun 17 2018 18:34:12 PST
Path advertised to update-groups:
21
Refresh Epoch 1
30 40
192.0.2.9 from 192.0.2.9 (192.0.2.9)
Origin IGP, metric 100, localpref 100, valid, internal, all
Originator: 192.0.2.9, Cluster list: 4.4.4.4
mpls labels in/out 16/nolabel
rx pathid: 0x1, tx pathid: 0x1
Updated on Jun 17 2018 18:34:12 PST
show ip bgp network (BGP Attribute Filter): Example
The following is sample output from the show ip bgp command that displays unknown and discarded
path attributes:
Device#show ip bgp 192.0.2.0/32
BGP routing table entry for 192.0.2.0/32, version 0
Paths: (1 available, no best path)
Refresh Epoch 1
Local
192.168.101.2 from 192.168.101.2 (192.168.101.2)
Origin IGP, localpref 100, valid, internal
unknown transitive attribute: flag 0xE0 type 0x81 length 0x20
value 0000 0000 0000 0000 0000 0000 0000 0000
0000 0000 0000 0000 0000 0000 0000 0000
unknown transitive attribute: flag 0xE0 type 0x83 length 0x20
value 0000 0000 0000 0000 0000 0000 0000 0000
0000 0000 0000 0000 0000 0000 0000 0000
discarded unknown attribute: flag 0x40 type 0x63 length 0x64
value 0000 0000 0000 0000 0000 0000 0000 0000
0000 0000 0000 0000 0000 0000 0000 0000
show ip bgp version: Example
The following is sample output from the show ip bgp version command:
Device#show ip bgp version
BGP table version is 5, local router ID is 10.2.4.2
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale, m multipath, b backup-path, x best-external
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 192.168.34.2/24 10.0.0.1 0 0 1 ?
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1537
Routing
show ip bgp
*> 192.168.35.2/24 10.0.0.1 0 0 1 ?
The following example shows how to display the network version:
Device#show ip bgp 192.168.34.2 | include version
BGP routing table entry for 192.168.34.2/24, version 5
The following sample output from the show ip bgp version recent command displays the prefix
changes in the specified version:
Device#show ip bgp version recent 2
BGP table version is 5, local router ID is 10.2.4.2
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal,
r RIB-failure, S Stale, m multipath, b backup-path, x best-external
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*> 192.168.134.1/28 10.0.0.1 0 0 1 ?
*> 192.168.134.19/28 10.0.0.1 0 0 1 ?
*> 192.168.134.34/28 10.0.0.1 0 0 1 ?
Device#show ip bgp 80.230.70.96 best-path-reason
BGP routing table entry for 192.168.3.0/24, version 72
Paths: (2 available, best #2, table default)
Advertised to update-groups:
2
Refresh Epoch 1
2
10.0.101.1 from 10.0.101.1 (10.0.101.1)
Origin IGP, localpref 100, valid, external
Extended Community: RT:100:100
rx pathid: 0, tx pathid: 0
Updated on Aug 14 2018 18:34:12 PST
Best Path Evaluation: Path is younger
Refresh Epoch 1
1
10.0.96.254 from 10.0.96.254 (10.0.96.254)
Origin IGP, localpref 100, valid, external, best
rx pathid: 0, tx pathid: 0x0
Updated on Aug 14 2018 18:30:39 PST
Best Path Evaluation: Overall best path
The following sample output for the show ip bgp summary command shows the peak watermarks
and their time-stamps for the peak number of route entries per neighbor bases:
Device#show ip bgp all summary
For address family: IPv4 Unicast
BGP router identifier 10.10.10.10, local AS number 1
BGP table version is 27, main routing table version 27
2 network entries using 496 bytes of memory
2 path entries using 272 bytes of memory
1/1 BGP path/bestpath attribute entries using 280 bytes of memory
1 BGP extended community entries using 24 bytes of memory
0 BGP route-map cache entries using 0 bytes of memory
0 BGP filter-list cache entries using 0 bytes of memory
BGP using 1072 total bytes of memory
BGP activity 58/54 prefixes, 110/106 paths, scan interval 60 secs
20 networks peaked at 00:03:50 Jul 28 2018 PST (00:00:32.833 ago)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1538
Routing
show ip bgp
Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd
11.11.11.11 4 1 0 0 1 0 0 00:20:09 Idle
For address family: L2VPN E-VPN
BGP router identifier 10.10.10.10, local AS number 1
BGP table version is 183, main routing table version 183
2 network entries using 688 bytes of memory
2 path entries using 416 bytes of memory
2/2 BGP path/bestpath attribute entries using 560 bytes of memory
1 BGP extended community entries using 24 bytes of memory
0 BGP route-map cache entries using 0 bytes of memory
0 BGP filter-list cache entries using 0 bytes of memory
BGP using 1688 total bytes of memory
BGP activity 58/54 prefixes, 110/106 paths, scan interval 60 secs
30 networks peaked at 00:35:36 Jul 28 2018 PST (00:00:47.321 ago)
Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd
11.11.11.11 4 1 0 0 1 0 0 00:20:09 Idle
Related Commands Command Description
bgp asnotation dot Changes the default display and the regular expression match format of
BGP 4-byte autonomous system numbers from asplain (decimal values)
to dot notation.
clear ip bgp Resets BGP connections using hard or soft reconfiguration.
ip bgp community new-format Configures BGP to display communities in the format AA:NN.
ip prefix-list Creates a prefix list or adds a prefix-list entry.
route-map Defines the conditions for redistributing routes from one routing protocol
into another routing protocol.
router bgp Configures the BGP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1539
Routing
show ip bgp neighbors
show ip bgp neighbors
To display information about Border Gateway Protocol (BGP) and TCP connections to neighbors, use the
show ip bgp neighbors command in user or privileged EXEC mode.
show ip bgp [{ipv4 {multicast | unicast} | vpnv4 all | vpnv6 unicast all}] neighbors [{slowip-address
| ipv6-address [{advertised-routes | dampened-routes | flap-statistics | paths [reg-exp] | policy [detail]
| received prefix-filter | received-routes | routes}]}]
Syntax Description ipv4 (Optional) Displays peers in the IPv4 address family.
multicast (Optional) Specifies IPv4 multicast address prefixes.
unicast (Optional) Specifies IPv4 unicast address prefixes.
vpnv4 all (Optional) Displays peers in the VPNv4 address family.
vpnv6 unicast all (Optional) Displays peers in the VPNv6 address family.
slow (Optional) Displays information about dynamically configured slow peers.
ip-address (Optional) IP address of the IPv4 neighbor. If this argument is omitted, information
about all neighbors is displayed.
ipv6-address (Optional) IP address of the IPv6 neighbor.
advertised-routes (Optional) Displays all routes that have been advertised to neighbors.
dampened-routes (Optional) Displays the dampened routes received from the specified neighbor.
flap-statistics (Optional) Displays the flap statistics of the routes learned from the specified
neighbor (for external BGP peers only).
paths reg-exp (Optional) Displays autonomous system paths learned from the specified neighbor.
An optional regular expression can be used to filter the output.
policy (Optional) Displays the policies applied to this neighbor per address family.
detail (Optional) Displays detailed policy information such as route maps, prefix lists,
community lists, access control lists (ACLs), and autonomous system path filter
lists.
received prefix-filter (Optional) Displays the prefix list (outbound route filter [ORF]) sent from the
specified neighbor.
received-routes (Optional) Displays all received routes (both accepted and rejected) from the
specified neighbor.
routes (Optional) Displays all routes that are received and accepted. The output displayed
when this keyword is entered is a subset of the output displayed by the
received-routes keyword.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1540
Routing
show ip bgp neighbors
Command Default The output of this command displays information for all neighbors.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Gibraltar 16.10.1 BGP Peak Prefix Watermark was added to the
command output.
Usage Guidelines Use the show ip bgp neighbors command to display BGP and TCP connection information for neighbor
sessions. For BGP, this includes detailed neighbor attribute, capability, path, and prefix information. For TCP,
this includes statistics related to BGP neighbor session establishment and maintenance.
Prefix activity is displayed based on the number of prefixes that are advertised and withdrawn. Policy denials
display the number of routes that were advertised but then ignored based on the function or attribute that is
displayed in the output.
Examples Example output is different for the various keywords available for the show ip bgp neighbors
command. Examples using the various keywords appear in the following sections.
show ip bgp neighbors: Example
The following example shows output for the BGP neighbor at 10.108.50.2. This neighbor is an
internal BGP (iBGP) peer. This neighbor supports the route refresh and graceful restart capabilities.
Device#show ip bgp neighbors 10.108.50.2
BGP neighbor is 10.108.50.2, remote AS 1, internal link
BGP version 4, remote router ID 192.168.252.252
BGP state = Established, up for 00:24:25
Last read 00:00:24, last write 00:00:24, hold time is 180, keepalive interval is
60 seconds
Neighbor capabilities:
Route refresh: advertised and received(old & new)
MPLS Label capability: advertised and received
Graceful Restart Capability: advertised
Address family IPv4 Unicast: advertised and received
Message statistics:
InQ depth is 0
OutQ depth is 0
Sent Rcvd
Opens: 3 3
Notifications: 0 0
Updates: 0 0
Keepalives: 113 112
Route Refresh: 0 0
Total: 116 115
Default minimum time between advertisement runs is 5 seconds
For address family: IPv4 Unicast
BGP additional-paths computation is enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1541
Routing
show ip bgp neighbors
BGP advertise-best-external is enabled
BGP table version 1, neighbor version 1/0
Output queue size : 0
Index 1, Offset 0, Mask 0x2
1 update-group member
Sent Rcvd
Prefix activity: ---- ----
Prefixes Current: 0 0
Prefixes Total: 0 0
Implicit Withdraw: 0 0
Explicit Withdraw: 0 0
Used as bestpath: n/a 0
Used as multipath: n/a 0
Outbound Inbound
Local Policy Denied Prefixes: -------- -------
Total: 0 0
Number of NLRIs in the update sent: max 0, min 0
Connections established 3; dropped 2
Last reset 00:24:26, due to Peer closed the session
External BGP neighbor may be up to 2 hops away.
Connection state is ESTAB, I/O status: 1, unread input bytes: 0
Connection is ECN Disabled
Local host: 10.108.50.1, Local port: 179
Foreign host: 10.108.50.2, Foreign port: 42698
Enqueued packets for retransmit: 0, input: 0 mis-ordered: 0 (0 bytes)
Event Timers (current time is 0x68B944):
Timer Starts Wakeups Next
Retrans 27 0 0x0
TimeWait 0 0 0x0
AckHold 27 18 0x0
SendWnd 0 0 0x0
KeepAlive 0 0 0x0
GiveUp 0 0 0x0
PmtuAger 0 0 0x0
DeadWait 0 0 0x0
iss: 3915509457 snduna: 3915510016 sndnxt: 3915510016 sndwnd: 15826
irs: 233567076 rcvnxt: 233567616 rcvwnd: 15845 delrcvwnd: 539
SRTT: 292 ms, RTTO: 359 ms, RTV: 67 ms, KRTT: 0 ms
minRTT: 12 ms, maxRTT: 300 ms, ACK hold: 200 ms
Flags: passive open, nagle, gen tcbs
IP Precedence value : 6
Datagrams (max data segment is 1460 bytes):
Rcvd: 38 (out of order: 0), with data: 27, total data bytes: 539
Sent: 45 (retransmit: 0, fastretransmit: 0, partialack: 0, Second Congestion: 08
The table below describes the significant fields shown in the display. Fields that are preceded by the
asterisk character (*) are displayed only when the counter has a nonzero value.
Table 171: show ip bgp neighbors Field Descriptions
Field Description
BGP neighbor IP address of the BGP neighbor and its autonomous system number.
remote AS Autonomous system number of the neighbor.
local AS 300 no-prepend (not shown Verifies that the local autonomous system number is not prepended to
in display) received external routes. This output supports the hiding of the local
autonomous systems when a network administrator is migrating
autonomous systems.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1542
Routing
show ip bgp neighbors
Field Description
internal link “internal link” is displayed for iBGP neighbors; “external link” is
displayed for external BGP (eBGP) neighbors.
BGP version BGP version being used to communicate with the remote router.
remote router ID IP address of the neighbor.
BGP state Finite state machine (FSM) stage of session negotiation.
up for Time, in hh:mm:ss, that the underlying TCP connection has been in
existence.
Last read Time, in hh:mm:ss, since BGP last received a message from this
neighbor.
last write Time, in hh:mm:ss, since BGP last sent a message to this neighbor.
hold time Time, in seconds, that BGP will maintain the session with this neighbor
without receiving messages.
keepalive interval Time interval, in seconds, at which keepalive messages are transmitted
to this neighbor.
Neighbor capabilities BGP capabilities advertised and received from this neighbor.
“advertised and received” is displayed when a capability is successfully
exchanged between two routers.
Route refresh Status of the route refresh capability.
MPLS Label capability Indicates that MPLS labels are both sent and received by the eBGP
peer.
Graceful Restart Capability Status of the graceful restart capability.
Address family IPv4 Unicast IP Version 4 unicast-specific properties of this neighbor.
Message statistics Statistics organized by message type.
InQ depth is Number of messages in the input queue.
OutQ depth is Number of messages in the output queue.
Sent Total number of transmitted messages.
Revd Total number of received messages.
Opens Number of open messages sent and received.
Notifications Number of notification (error) messages sent and received.
Updates Number of update messages sent and received.
Keepalives Number of keepalive messages sent and received.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1543
Routing
show ip bgp neighbors
Field Description
Route Refresh Number of route refresh request messages sent and received.
Total Total number of messages sent and received.
Default minimum time between... Time, in seconds, between advertisement transmissions.
For address family: Address family to which the following fields refer.
BGP table version Internal version number of the table. This is the primary routing table
with which the neighbor has been updated. The number increments
when the table changes.
neighbor version Number used by the software to track prefixes that have been sent and
those that need to be sent.
1 update-group member Number of the update-group member for this address family.
Prefix activity Prefix statistics for this address family.
Prefixes Current Number of prefixes accepted for this address family.
Prefixes Total Total number of received prefixes.
Implicit Withdraw Number of times that a prefix has been withdrawn and readvertised.
Explicit Withdraw Number of times that a prefix has been withdrawn because it is no
longer feasible.
Used as bestpath Number of received prefixes installed as best paths.
Used as multipath Number of received prefixes installed as multipaths.
* Saved (soft-reconfig) Number of soft resets performed with a neighbor that supports soft
reconfiguration. This field is displayed only if the counter has a nonzero
value.
* History paths This field is displayed only if the counter has a nonzero value.
* Invalid paths Number of invalid paths. This field is displayed only if the counter
has a nonzero value.
Local Policy Denied Prefixes Prefixes denied due to local policy configuration. Counters are updated
for inbound and outbound policy denials. The fields under this heading
are displayed only if the counter has a nonzero value.
* route-map Displays inbound and outbound route-map policy denials.
* filter-list Displays inbound and outbound filter-list policy denials.
* prefix-list Displays inbound and outbound prefix-list policy denials.
* Ext Community Displays only outbound extended community policy denials.
* AS_PATH too long Displays outbound AS_PATH length policy denials.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1544
Routing
show ip bgp neighbors
Field Description
* AS_PATH loop Displays outbound AS_PATH loop policy denials.
* AS_PATH confed info Displays outbound confederation policy denials.
* AS_PATH contains AS 0 Displays outbound denials of autonomous system 0.
* NEXT_HOP Martian Displays outbound martian denials.
* NEXT_HOP non-local Displays outbound nonlocal next-hop denials.
* NEXT_HOP is us Displays outbound next-hop-self denials.
* CLUSTER_LIST loop Displays outbound cluster-list loop denials.
* ORIGINATOR loop Displays outbound denials of local originated routes.
* unsuppress-map Displays inbound denials due to an unsuppress map.
* advertise-map Displays inbound denials due to an advertise map.
* VPN Imported prefix Displays inbound denials of VPN prefixes.
* Well-known Community Displays inbound denials of well-known communities.
* SOO loop Displays inbound denials due to site-of-origin.
* Bestpath from this peer Displays inbound denials because the best path came from the local
router.
* Suppressed due to dampening Displays inbound denials because the neighbor or link is in a
dampening state.
* Bestpath from iBGP peer Deploys inbound denials because the best path came from an iBGP
neighbor.
* Incorrect RIB for CE Deploys inbound denials due to RIB errors for a customer edge (CE)
router.
* BGP distribute-list Displays inbound denials due to a distribute list.
Number of NLRIs... Number of network layer reachability attributes in updates.
Current session network count Displays the peak number of networks observed in the current session.
peaked...
Highest network count observed at... Displays the peak number of networks observed since startup.
Connections established Number of times a TCP and BGP connection has been successfully
established.
dropped Number of times that a valid session has failed or been taken down.
Last reset Time, in hh:mm:ss, since this peering session was last reset. The reason
for the reset is displayed on this line.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1545
Routing
show ip bgp neighbors
Field Description
External BGP neighbor may be... Indicates that the BGP time to live (TTL) security check is enabled.
The maximum number of hops that can separate the local and remote
peer is displayed on this line.
Connection state Connection status of the BGP peer.
unread input bytes Number of bytes of packets still to be processed.
Connection is ECN Disabled Explicit congestion notification status (enabled or disabled).
Local host: 10.108.50.1, Local port: IP address of the local BGP speaker. BGP port number 179.
179
Foreign host: 10.108.50.2, Foreign Neighbor address and BGP destination port number.
port: 42698
Enqueued packets for retransmit: Packets queued for retransmission by TCP.
Event Timers TCP event timers. Counters are provided for starts and wakeups
(expired timers).
Retrans Number of times a packet has been retransmitted.
TimeWait Time waiting for the retransmission timers to expire.
AckHold Acknowledgment hold timer.
SendWnd Transmission (send) window.
KeepAlive Number of keepalive packets.
GiveUp Number of times a packet is dropped due to no acknowledgment.
PmtuAger Path MTU discovery timer.
DeadWait Expiration timer for dead segments.
iss: Initial packet transmission sequence number.
snduna: Last transmission sequence number that has not been acknowledged.
sndnxt: Next packet sequence number to be transmitted.
sndwnd: TCP window size of the remote neighbor.
irs: Initial packet receive sequence number.
rcvnxt: Last receive sequence number that has been locally acknowledged.
rcvwnd: TCP window size of the local host.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1546
Routing
show ip bgp neighbors
Field Description
delrcvwnd: Delayed receive window—data the local host has read from the
connection, but has not yet subtracted from the receive window the
host has advertised to the remote host. The value in this field gradually
increases until it is higher than a full-sized packet, at which point it is
applied to the rcvwnd field.
SRTT: A calculated smoothed round-trip timeout.
RTTO: Round-trip timeout.
RTV: Variance of the round-trip time.
KRTT: New round-trip timeout (using the Karn algorithm). This field
separately tracks the round-trip time of packets that have been re-sent.
minRTT: Shortest recorded round-trip timeout (hard-wire value used for
calculation).
maxRTT: Longest recorded round-trip timeout.
ACK hold: Length of time the local host will delay an acknowledgment to carry
(piggyback) additional data.
IP Precedence value: IP precedence of the BGP packets.
Datagrams Number of update packets received from a neighbor.
Rcvd: Number of received packets.
out of order: Number of packets received out of sequence.
with data Number of update packets sent with data.
total data bytes Total amount of data received, in bytes.
Sent Number of update packets sent.
Second Congestion Number of update packets with data sent.
Datagrams: Rcvd Number of update packets received from a neighbor.
retransmit Number of packets retransmitted.
fastretransmit Number of duplicate acknowledgments retransmitted for an out of
order segment before the retransmission timer expires.
partialack Number of retransmissions for partial acknowledgments (transmissions
before or without subsequent acknowledgments).
Second Congestion Number of second retransmissions sent due to congestion.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1547
Routing
show ip bgp neighbors
show ip bgp neighbors (4-Byte Autonomous System Numbers)
The following partial example shows output for several external BGP neighbors in autonomous
systems with 4-byte autonomous system numbers, 65536 and 65550. This example requires Cisco
IOS Release 12.0(32)SY8, 12.0(33)S3, 12.2(33)SRE, 12.2(33)XNE, 12.2(33)SXI1, Cisco IOS XE
Release 2.4, or a later release.
Device#show ip bgp neighbors
BGP neighbor is 192.168.1.2, remote AS 65536, external link
BGP version 4, remote router ID 0.0.0.0
BGP state = Idle
Last read 02:03:38, last write 02:03:38, hold time is 120, keepalive interval is 70
seconds
Configured hold time is 120, keepalive interval is 70 seconds
Minimum holdtime from neighbor is 0 seconds
.
.
.
BGP neighbor is 192.168.3.2, remote AS 65550, external link
Description: finance
BGP version 4, remote router ID 0.0.0.0
BGP state = Idle
Last read 02:03:48, last write 02:03:48, hold time is 120, keepalive interval is 70
seconds
Configured hold time is 120, keepalive interval is 70 seconds
Minimum holdtime from neighbor is 0 seconds
show ip bgp neighbors advertised-routes
The following example displays routes advertised for only the 172.16.232.178 neighbor:
Device#show ip bgp neighbors 172.16.232.178 advertised-routes
BGP table version is 27, local router ID is 172.16.232.181
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
*>i10.0.0.0 172.16.232.179 0 100 0 ?
*> 10.20.2.0 10.0.0.0 0 32768 i
The table below describes the significant fields shown in the display.
Table 172: show ip bgp neighbors advertised-routes Field Descriptions
Field Description
BGP table version Internal version number of the table. This is the primary routing table with which the
neighbor has been updated. The number increments when the table changes.
local router ID IP address of the local BGP speaker.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1548
Routing
show ip bgp neighbors
Field Description
Status codes Status of the table entry. The status is displayed at the beginning of each line in the table.
It can be one of the following values:
• s—The table entry is suppressed.
• d—The table entry is dampened and will not be advertised to BGP neighbors.
• h—The table entry does not contain the best path based on historical information.
• *—The table entry is valid.
• >—The table entry is the best entry to use for that network.
• i—The table entry was learned via an internal BGP (iBGP) session.
Origin codes Origin of the entry. The origin code is placed at the end of each line in the table. It can
be one of the following values:
• i—Entry originated from Interior Gateway Protocol (IGP) and was advertised with
a network router configuration command.
• e—Entry originated from Exterior Gateway Protocol (EGP).
• ?—Origin of the path is not clear. Usually, this is a route that is redistributed into
BGP from an IGP.
Network IP address of a network entity.
Next Hop IP address of the next system used to forward a packet to the destination network. An
entry of 0.0.0.0 indicates that there are non-BGP routes in the path to the destination
network.
Metric If shown, this is the value of the interautonomous system metric. This field is not used
frequently.
LocPrf Local preference value as set with the set local-preference route-map configuration
command. The default value is 100.
Weight Weight of the route as set via autonomous system filters.
Path Autonomous system paths to the destination network. There can be one entry in this field
for each autonomous system in the path.
show ip bgp neighbors check-control-plane-failure
The following is sample output from the show ip bgp neighbors command entered with the
check-control-plane-failure option configured:
Device#show ip bgp neighbors 10.10.10.1
BGP neighbor is 10.10.10.1, remote AS 10, internal link
Fall over configured for session
BFD is configured. BFD peer is Up. Using BFD to detect fast fallover (single-hop) with
c-bit check-control-plane-failure.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1549
Routing
show ip bgp neighbors
Inherits from template cbit-tps for session parameters
BGP version 4, remote router ID 10.7.7.7
BGP state = Established, up for 00:03:55
Last read 00:00:02, last write 00:00:21, hold time is 180, keepalive interval is 60 seconds
Neighbor sessions:
1 active, is not multisession capable (disabled)
Neighbor capabilities:
Route refresh: advertised and received(new)
Four-octets ASN Capability: advertised and received
Address family IPv4 Unicast: advertised and received
Enhanced Refresh Capability: advertised and received
Multisession Capability:
Stateful switchover support enabled: NO for session 1
show ip bgp neighbors paths
The following is sample output from the show ip bgp neighbors command entered with the paths
keyword:
Device#show ip bgp neighbors 172.29.232.178 paths 10
Address Refcount Metric Path
0x60E577B0 2 40 10 ?
The table below describes the significant fields shown in the display.
Table 173: show ip bgp neighbors paths Field Descriptions
Field Description
Address Internal address where the path is stored.
Refcount Number of routes using that path.
Metric Multi Exit Discriminator (MED) metric for the path. (The name of this metric for BGP versions
2 and 3 is INTER_AS.)
Path Autonomous system path for that route, followed by the origin code for that route.
show ip bgp neighbors received prefix-filter
The following example shows that a prefix list that filters all routes in the 10.0.0.0 network has been
received from the 192.168.20.72 neighbor:
Device#show ip bgp neighbors 192.168.20.72 received prefix-filter
Address family:IPv4 Unicast
ip prefix-list 192.168.20.72:1 entries
seq 5 deny 10.0.0.0/8 le 32
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1550
Routing
show ip bgp neighbors
Table 174: show ip bgp neighbors received prefix-filter Field Descriptions
Field Description
Address family Address family mode in which the prefix filter is received.
ip prefix-list Prefix list sent from the specified neighbor.
show ip bgp neighbors policy
The following sample output shows the policies applied to the neighbor at 192.168.1.2. The output
displays both inherited policies and policies configured on the neighbor device. Inherited polices are
policies that the neighbor inherits from a peer group or a peer-policy template.
Device#show ip bgp neighbors 192.168.1.2 policy
Neighbor: 192.168.1.2, Address-Family: IPv4 Unicast
Locally configured policies:
route-map ROUTE in
Inherited polices:
prefix-list NO-MARKETING in
route-map ROUTE in
weight 300
maximum-prefix 10000
BGP Attribute Filter and Enhanced Attribute Error Handling
The following is sample output from the show ip bgp neighbors command that indicates the discard
attribute values and treat-as-withdraw attribute values configured. It also provides a count of received
Updates matching a treat-as-withdraw attribute, a count of received Updates matching a discard
attribute, and a count of received malformed Updates that are treat-as-withdraw.
Device#show ip bgp vpnv4 all neighbors 10.0.103.1
BGP neighbor is 10.0.103.1, remote AS 100, internal link
Path-attribute treat-as-withdraw inbound
Path-attribute treat-as-withdraw value 128
Path-attribute treat-as-withdraw 128 in: count 2
Path-attribute discard 128 inbound
Path-attribute discard 128 in: count 2
Outbound Inbound
Local Policy Denied Prefixes: -------- -------
MALFORM treat as withdraw: 0 1
Total: 0 1
BGP Additional Paths
The following output indicates that the neighbor is capable of advertising additional paths and sending
additional paths it receives. It is also capable of receiving additional paths and advertised paths.
Device#show ip bgp neighbors 10.108.50.2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1551
Routing
show ip bgp neighbors
BGP neighbor is 10.108.50.2, remote AS 1, internal link
BGP version 4, remote router ID 192.168.252.252
BGP state = Established, up for 00:24:25
Last read 00:00:24, last write 00:00:24, hold time is 180, keepalive interval is 60 seconds
Neighbor capabilities:
Additional paths Send: advertised and received
Additional paths Receive: advertised and received
Route refresh: advertised and received(old & new)
Graceful Restart Capabilty: advertised and received
Address family IPv4 Unicast: advertised and received
BGP—Multiple Cluster IDs
In the following output, the cluster ID of the neighbor is displayed. (The vertical bar and letter “i”
for “include” cause the device to display only lines that include the user's input after the “i”, in this
case, “cluster-id.”) The cluster ID displayed is the one directly configured through a neighbor or a
template.
Device#show ip bgp neighbors 192.168.2.2 | i cluster-id
Configured with the cluster-id 192.168.15.6
BGP Peak Prefix Watermark
The following sample output shows the peak watermarks and their timestamps displayed for the peak
number of route entries per neighbor bases:
Device#show ip bgp ipv4 unicast neighbors 11.11.11.11
BGP neighbor is 11.11.11.11, remote AS 1, internal link
BGP version 4, remote router ID 0.0.0.0
BGP state = Idle, down for 00:01:43
Neighbor sessions:
0 active, is not multisession capable (disabled)
Stateful switchover support enabled: NO
Do log neighbor state changes (via global configuration)
Default minimum time between advertisement runs is 0 seconds
For address family: IPv4 Unicast
BGP table version 27, neighbor version 1/27
Output queue size : 0
Index 0, Advertise bit 0
Slow-peer detection is disabled
Slow-peer split-update-group dynamic is disabled
Sent Rcvd
Prefix activity: ---- ----
Prefixes Current: 0 0
Prefixes Total: 0 0
Implicit Withdraw: 0 0
Explicit Withdraw: 0 0
Used as bestpath: n/a 0
Used as multipath: n/a 0
Used as secondary: n/a 0
Outbound Inbound
Local Policy Denied Prefixes: -------- -------
Total: 0 0
Number of NLRIs in the update sent: max 2, min 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1552
Routing
show ip bgp neighbors
Current session network count peaked at 20 entries at 00:00:23 Aug 8 2018 PST (00:01:29.156
ago).
Highest network count observed at 20 entries at 23:55:32 Aug 7 2018 PST (00:06:20.156
ago).
Last detected as dynamic slow peer: never
Dynamic slow peer recovered: never
Refresh Epoch: 1
Last Sent Refresh Start-of-rib: never
Last Sent Refresh End-of-rib: never
Last Received Refresh Start-of-rib: never
Last Received Refresh End-of-rib: never
Sent Rcvd
Refresh activity: ---- ----
Refresh Start-of-RIB 0 0
Refresh End-of-RIB 0 0
BGP Soft Inbound and Outbound Refresh Time
In the following example, the times of occurrence of the soft inbound and outbound refresh, to or
from the given neighbour, are displayed:
Device#show ip bgp l2vpn evpn neighbors 11.11.11.11
BGP neighbor is 11.11.11.11, remote AS 1, internal link
BGP version 4, remote router ID 11.11.11.11
BGP state = Established, up for 00:14:06
Last read 00:00:21, last write 00:00:28, hold time is 180, keepalive
……………
Do log neighbor state changes (via global configuration)
Default minimum time between advertisement runs is 0 seconds
For address family: L2VPN E-VPN
Session: 11.11.11.11
BGP table version 30, neighbor version 30/0
Output queue size : 0
Index 1, Advertise bit 0
1 update-group member
Community attribute sent to this neighbor
Extended-community attribute sent to this neighbor
……….
…………
Last detected as dynamic slow peer: never
Dynamic slow peer recovered: never
Refresh Epoch: 2
Last Sent Refresh Start-of-rib: never
Last Sent Refresh End-of-rib: never
Last Received Refresh Start-of-rib: 00:14:06
Last Received Refresh End-of-rib: 00:14:06
Refresh-In took 0 seconds
Sent Rcvd
Refresh activity: ---- ----
Refresh Start-of-RIB 0 1
Refresh End-of-RIB 0 1
Address tracking is enabled, the RIB does have a route to 11.11.11.11
Route to peer address reachability Up: 1; Down: 0
Last notification 00:14:07
Connections established 1; dropped 0
…………
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1553
Routing
show ip bgp neighbors
…………
Packets received in fast path: 0, fast processed: 0, slow path: 0
fast lock acquisition failures: 0, slow path: 0
TCP Semaphore 0x7FA8A0AE7BA0 FREE
Related Commands Command Description
bgp asnotation dot Changes the default display and the regular expression match format of
BGP 4-byte autonomous system numbers from asplain (decimal values)
to dot notation.
bgp enhanced-error Restores the default behavior of treating Update messages that have a
malformed attribute as withdrawn, or includes iBGP peers in the
Enhanced Attribute Error Handling feature.
neighbor path-attribute discard Configures the device to discard unwanted Update messages from the
specified neighbor that contain a specified path attribute.
neighbor path-attribute Configures the device to withdraw from the specified neighbor unwanted
treat-as-withdraw Update messages that contain a specified attribute.
neighbor send-label Enables a BGP router to send MPLS labels with BGP routes to a
neighboring BGP router.
neighbor send-label explicit-null Enables a BGP router to send MPLS labels with explicit-null information
for a CSC-CE router and BGP routes to a neighboring CSC-PE router.
router bgp Configures the BGP routing process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1554
Routing
show ip bgp ipv6 unicast
show ip bgp ipv6 unicast
To display entries in the Internet Protocol version 6 (IPv6) Border Gateway Protocol (BGP) routing table,
use the show ip bgp ipv6 unicast command in user EXEC or privileged EXEC mode.
show ip bgp ipv6 unicast [ prefix / length ]
Syntax Description prefix /length (Optional) IPv6 network number and length of the IPv6 prefix, entered to display a particular
network in the IPv6 BGP routing table.
• The length is a decimal value that indicates how many of the high-order contiguous bits
of the address comprise the prefix (the network portion of the address). A slash mark
must precede the decimal value.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show ip bgp ipv6 unicast command provides output similar to the show ip bgp command, except that
it is IPv6 specific.
Examples The following is sample output from the show bgp ipv6 unicast prefix/length command, showing
the RPKI state of the path:
Device# show bgp ipv6 unicast 2010::1/128
BGP routing table entry for 2010::1/128, version 5
Paths: (1 available, best #1, table default)
Advertised to update-groups:
1 2
Refresh Epoch 1
3
2002::1 (FE80::A8BB:CCFF:FE00:300) from 2002::1 (10.0.0.3)
Origin IGP, metric 0, localpref 100, valid, external, best
path 079ECBD0 RPKI State not found
The table below describes the significant fields shown in the display.
Table 175: show ip bgp ipv6 Field Descriptions
Field Description
BGP routing table entry for IPv6 prefix and prefix length, internal version
number of the table. This number is incremented
whenever the table changes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1555
Routing
show ip bgp ipv6 unicast
Field Description
Paths: Number of routes available to destination.
Advertised to update-groups: Update group numbers.
3 Autonomous system number.
2002::1 (FE80::A8BB:CCFF:FE00:300) from 2002::1 Address of the neighbor from which the path was
(10.0.0.3) received, link local address of the neighbor, from
address of the neighbor, BGP router ID of the
neighbor.
Origin Indicates the origin of the entry.
metric If shown, the value of the interautonomous system
metric.
localpref Local preference value as set with the set
local-preference route-map configuration command.
The default value is 100.
valid Path is legitimate.
external Path is an External Border Gateway Protocol (EBGP)
path.
best path Path is flagged as the best path; number indicates
which path in memory.
RPKI State RPKI state of the network prefix shown at the
beginning of the output. The state could be valid,
invalid, or not found.
Related Commands Command Description
clear bgp ipv6 Resets an IPv6 BGP connection or session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1556
Routing
show ip eigrp interfaces
show ip eigrp interfaces
To display information about interfaces that are configured for the Enhanced Interior Gateway Routing Protocol
(EIGRP), use the show ip eigrp interfaces command in user EXEC or privileged EXEC mode.
show ip eigrp [vrf vrf-name] [autonomous-system-number] interfaces [type number] [{detail}]
Syntax Description vrf vrf-name (Optional) Displays information about the specified virtual routing and
forwarding (VRF) instance.
autonomous-system-number (Optional) Autonomous system number whose output needs to be filtered.
type (Optional) Interface type. For more information, use the question mark (?)
online help function.
number (Optional) Interface or subinterface number. For more information about the
numbering syntax for your networking device, use the question mark (?) online
help function.
detail (Optional) Displays detailed information about EIGRP interfaces for a specific
EIGRP process.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show ip eigrp interfaces command to display active EIGRP interfaces and EIGRP-specific interface
settings and statistics. The optional type number argument and the detail keyword can be entered in any order.
If an interface is specified, only information about that interface is displayed. Otherwise, information about
all interfaces on which EIGRP is running is displayed.
If an autonomous system is specified, only the routing process for the specified autonomous system is displayed.
Otherwise, all EIGRP processes are displayed.
This command can be used to display information about EIGRP named and EIGRP autonomous system
configurations.
This command displays the same information as the show eigrp address-family interfaces command. Cisco
recommends using the show eigrp address-family interfaces command.
Examples The following is sample output from the show ip eigrp interfaces command:
Device#show ip eigrp interfaces
EIGRP-IPv4 Interfaces for AS(60)
Xmit Queue Mean Pacing Time Multicast Pending
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1557
Routing
show ip eigrp interfaces
Interface Peers Un/Reliable SRTT Un/Reliable Flow Timer Routes
Di0 0 0/0 0 11/434 0 0
Et0 1 0/0 337 0/10 0 0
SE0:1.16 1 0/0 10 1/63 103 0
Tu0 1 0/0 330 0/16 0 0
The following sample output from the show ip eigrp interfaces detail command displays detailed
information about all active EIGRP interfaces:
Device#show ip eigrp interfaces detail
EIGRP-IPv4 Interfaces for AS(1)
Xmit Queue PeerQ Mean Pacing Time Multicast Pending
Interface Peers Un/Reliable Un/Reliable SRTT Un/Reliable Flow Timer Routes
Et0/0 1 0/0 0/0 525 0/2 3264 0
Hello-interval is 5, Hold-time is 15
Split-horizon is enabled
Next xmit serial <none>
Packetized sent/expedited: 3/0
Hello's sent/expedited: 6/2
Un/reliable mcasts: 0/6 Un/reliable ucasts: 7/4
Mcast exceptions: 1 CR packets: 1 ACKs suppressed: 0
Retransmissions sent: 1 Out-of-sequence rcvd: 0
Topology-ids on interface - 0
Authentication mode is not set
The following sample output from the show ip eigrp interfaces detail command displays detailed
information about a specific interface on which the no ip next-hop self command is configured along
with the no-ecmp-mode option:
Device#show ip eigrp interfaces detail tunnel 0
EIGRP-IPv4 Interfaces for AS(1)
Xmit Queue PeerQ Mean Pacing Time Multicast Pending
Interface Peers Un/Reliable Un/Reliable SRTT Un/Reliable Flow Timer Routes
Tu0/0 2 0/0 0/0 2 0/0 50 0
Hello-interval is 5, Hold-time is 15
Split-horizon is disabled
Next xmit serial <none>
Packetized sent/expedited: 24/3
Hello's sent/expedited: 28083/9
Un/reliable mcasts: 0/19 Un/reliable ucasts: 18/64
Mcast exceptions: 5 CR packets: 5 ACKs suppressed: 0
Retransmissions sent: 52 Out-of-sequence rcvd: 2
Next-hop-self disabled, next-hop info forwarded, ECMP mode Enabled
Topology-ids on interface - 0
Authentication mode is not set
The table below describes the significant fields shown in the displays.
Table 176: show ip eigrp interfaces Field Descriptions
Field Description
Interface Interface on which EIGRP is configured.
Peers Number of directly connected EIGRP neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1558
Routing
show ip eigrp interfaces
Field Description
PeerQ Un/Reliable Number of unreliable and reliable packets queued for transmission to specific
peers on the interface.
Xmit Queue Un/Reliable Number of packets remaining in the Unreliable and Reliable transmit queues.
Mean SRTT Mean smooth round-trip time (SRTT) interval (in seconds).
Pacing Time Un/Reliable Pacing time (in seconds) used to determine when EIGRP packets (unreliable and
reliable) should be sent out of the interface .
Multicast Flow Timer Maximum number of seconds for which the device will send multicast EIGRP
packets.
Pending Routes Number of routes in the transmit queue waiting to be sent.
Packetized sent/expedited Number of EIGRP routes that have been prepared for sending packets to neighbors
on an interface, and the number of times multiple routes were stored in a single
packet.
Hello’s sent/expedited Number of EIGRP hello packets that have been sent on an interface and packets
that were expedited.
Related Commands Command Description
show eigrp address-family interfaces Displays information about address family interfaces configured
for EIGRP.
show ip eigrp neighbors Displays neighbors discovered by EIGRP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1559
Routing
show ip eigrp neighbors
show ip eigrp neighbors
To display neighbors discovered by the Enhanced Interior Gateway Routing Protocol (EIGRP), use the show
ip eigrp neighbors command in privileged EXEC mode.
show ip eigrp [vrf vrf-name] [autonomous-system-number] neighbors [{static | detail}] [interface-type
interface-number]
Syntax Description vrf vrf-name (Optional) Displays information about the specified VPN Routing and
Forwarding (VRF) instance.
autonomous-system-number (Optional) Autonomous-system-number-specific output is displayed.
static (Optional) Displays static neighbors.
detail (Optional) Displays detailed neighbor information.
interface-type interface-number (Optional) Interface-specific output is displayed.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The show ip eigrp neighbors command can be used to display information about EIGRP named and EIGRP
autonomous-system configurations. Use the show ip eigrp neighbors command to display dynamic and static
neighbor states. You can use this command for also debugging certain types of transport problems.
This command displays the same information as the show eigrp address-family neighbors command. Cisco
recommends that you use the show eigrp address-family neighbors command.
Examples The following is sample output from the show ip eigrp neighbors command:
Device#show ip eigrp neighbors
H Address Interface Hold Uptime SRTT RTO Q Seq
(sec) (ms) Cnt Num
0 10.1.1.2 Et0/0 13 00:00:03 1996 5000 0 5
2 10.1.1.9 Et0/0 14 00:02:24 206 5000 0 5
1 10.1.2.3 Et0/1 11 00:20:39 2202 5000 0 5
The table below describes the significant fields shown in the display.
Table 177: show ip eigrp neighbors Field Descriptions
Field Description
Address IP address of the EIGRP peer.
Interface Interface on which the router is receiving hello packets from the peer.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1560
Routing
show ip eigrp neighbors
Field Description
Hold Time in seconds for which EIGRP waits to hear from the peer before declaring it down.
Uptime Elapsed time (in hours:minutes: seconds) since the local router first heard from this neighbor.
SRTT Smooth round-trip time. This is the number of milliseconds required for an EIGRP packet to be
sent to this neighbor and for the local router to receive an acknowledgment of that packet.
RTO Retransmission timeout (in milliseconds). This is the amount of time the software waits before
resending a packet from the retransmission queue to a neighbor.
Q Cnt Number of EIGRP packets (update, query, and reply) that the software is waiting to send.
Seq Num Sequence number of the last update, query, or reply packet that was received from this neighbor.
The following is sample output from the show ip eigrp neighbors detailcommand:
Device#show ip eigrp neighbors detail
EIGRP-IPv4 VR(foo) Address-Family Neighbors for AS(1)
H Address Interface Hold Uptime SRTT RTO Q Seq
(sec) (ms) Cnt Num
0 192.168.10.1 Gi2/0 12 00:00:21 1600 5000 0 3
Static neighbor (Lisp Encap)
Version 8.0/2.0, Retrans: 0, Retries: 0, Prefixes: 1
Topology-ids from peer - 0
The table below describes the significant fields shown in the display.
Table 178: show ip eigrp neighbors detail Field Descriptions
Field Description
H This column lists the order in which a peering session was established with the specified neighbor.
The order is specified with sequential numbering starting with 0.
Address IP address of the EIGRP peer.
Interface Interface on which the router is receiving hello packets from the peer.
Hold Time in seconds for which EIGRP waits to hear from the peer before declaring it down.
Lisp Indicates that routes from this neighbor are LISP encapsulated.
Encap
Uptime Elapsed time (in hours:minutes: seconds) since the local router first heard from this neighbor.
SRTT Smooth round-trip time. This is the number of milliseconds required for an EIGRP packet to be
sent to this neighbor and for the local router to receive an acknowledgment of that packet.
RTO Retransmission timeout (in milliseconds). This is the amount of time the software waits before
resending a packet from the retransmission queue to a neighbor.
Q Cnt Number of EIGRP packets (update, query, and reply) that the software is waiting to send.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1561
Routing
show ip eigrp neighbors
Field Description
Seq Num Sequence number of the last update, query, or reply packet that was received from this neighbor.
Version The software version that the specified peer is running.
Retrans Number of times that a packet has been retransmitted.
Retries Number of times an attempt was made to retransmit a packet.
Related Commands Command Description
show eigrp address-family neighbors Displays neighbors discovered by EIGRP.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1562
Routing
show ip eigrp topology
show ip eigrp topology
To display Enhanced Interior Gateway Routing Protocol (EIGRP) topology table entries, use the show ip
eigrp topology command in user EXEC or privileged EXEC mode.
show ip eigrp topology [{ network [{ mask }] prefix | active | all-links | detail-links | pending |
secondary-paths | summary | zero-successors }]
Syntax Description network (Optional) Network address.
mask (Optional) Network mask.
prefix (Optional) Network prefix in the format <network>/<length>, for example, 192.168.0.0/16.
active (Optional) Displays all topology entries that are in the active state.
all-links (Optional) Displays all the entries in the EIGRP topology table (including nonfeasible
successor sources).
detail-links (Optional) Displays all the topology entries with additional details.
pending (Optional) Displays all the entries in the EIGRP topology table that are either waiting for
an update from a neighbor or to reply to a neighbor.
secondary-paths (Optional) Displays the secondary paths in the topology.
summary (Optional) Displays a summary of the EIGRP topology table.
zero-successors (Optional) Displays the available routes that have zero successors.
Command Default If this command is used without any of the optional keywords, only topology entries with feasible successors
are displayed and only feasible paths are shown.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show ip eigrp topology command to display topology entries, feasible and nonfeasible paths, metrics,
and states. This command can be used without any arguments or keywords to display only topology entries
with feasible successors and feasible paths. The all-links keyword displays all the paths, whether feasible or
not, and the detail-links keyword displays additional details about these paths.
Use this command to display information about EIGRP named and EIGRP autonomous system configurations.
This command displays the same information as the show eigrp address-family topology command. We
recommend that you use the show eigrp address-family topology command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1563
Routing
show ip eigrp topology
Examples The following is a sample output from the show ip eigrp topology command:
Device# show ip eigrp topology
EIGRP-IPv4 Topology Table for AS(1)/ID(10.0.0.1)
Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply,
r - Reply status, s - sia status
P 10.0.0.0/8, 1 successors, FD is 409600
via 192.0.2.1 (409600/128256), Ethernet0/0
P 192.16.1.0/24, 1 successors, FD is 409600
via 192.0.2.1 (409600/128256), Ethernet0/0
P 10.0.0.0/8, 1 successors, FD is 281600
via Summary (281600/0), Null0
P 10.0.1.0/24, 1 successors, FD is 281600
via Connected, Ethernet0/0
The following is a sample output from the show ip eigrp topology prefix command, and displays
detailed information about a single prefix. The prefix shown is an EIGRP internal route.
Device# show ip eigrp topology 10.0.0.0/8
EIGRP-IPv4 VR(vr1) Topology Entry for AS(1)/ID(10.1.1.2) for 10.0.0.0/8
State is Passive, Query origin flag is 1, 1 Successor(s), FD is 82329600, RIB is 643200
Descriptor Blocks:
10.1.1.1 (Ethernet2/0), from 10.1.1.1, Send flag is 0x0
Composite metric is (82329600/163840), route is Internal
Vector metric:
Minimum bandwidth is 16000 Kbit
Total delay is 631250000 picoseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1500
Hop count is 1
Originating router is 10.1.1.1
The following is a sample output from the show ip eigrp topology prefix command, and displays
detailed information about a single prefix. The prefix shown is an EIGRP external route.
Device# show ip eigrp topology 192.16.1.0/24
EIGRP-IPv4 Topology Entry for AS(1)/ID(10.0.0.1) for 192.16.1.0/24
State is Passive, Query origin flag is 1, 1 Successor(s), FD is 409600, RIB is 643200
Descriptor Blocks:
172.16.1.0/24 (Ethernet0/0), from 10.0.1.2, Send flag is 0x0
Composite metric is (409600/128256), route is External
Vector metric:
Minimum bandwidth is 10000 Kbit
Total delay is 6000 picoseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1500
Hop count is 1
Originating router is 192.16.1.0/24
External data:
AS number of route is 0
External protocol is Connected, external metric is 0
Administrator tag is 0 (0x00000000)
The following is a sample output from the show ip eigrp topology prefix command displays Equal
Cost Multipath (ECMP) mode information when the no ip next-hop-self command is configured
without the no-ecmp-mode keyword in an EIGRP topology. The ECMP mode provides information
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1564
Routing
show ip eigrp topology
about the path that is being advertised. If there is more than one successor, the top-most path is
advertised as the default path over all the interfaces, and ECMP Mode: Advertise by default
is displayed in the output. If any path other than the default path is advertised, ECMP Mode:
Advertise out <Interface name> is displayed.
The topology table displays entries of routes for a particular prefix. The routes are sorted based on
metric, next-hop, and infosource. In a Dynamic Multipoint VPN (DMVPN) scenario, routes with
the same metric and next hop are sorted based on infosource. The top route in the ECMP is always
advertised.
Device# show ip eigrp topology 192.168.10.0/24
EIGRP-IPv4 Topology Entry for AS(1)/ID(10.10.100.100) for 192.168.10.0/24
State is Passive, Query origin flag is 1, 2 Successor(s), FD is 284160
Descriptor Blocks:
10.100.1.0 (Tunnel0), from 10.100.0.1, Send flag is 0x0
Composite metric is (284160/281600), route is Internal
Vector metric:
Minimum bandwidth is 10000 Kbit
Total delay is 1100 microseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1400
Hop count is 1
Originating router is 10.10.1.1
ECMP Mode: Advertise by default
10.100.0.2 (Tunnel1), from 10.100.0.2, Send flag is 0X0
Composite metric is (284160/281600), route is Internal
Vector metric:
Minimum bandwidth is 10000 Kbit
Total delay is 1100 microseconds
Reliability is 255/255
Load is ½55
Minimum MTU is 1400
Hop count is 1
Originating router is 10.10.2.2
ECMP Mode: Advertise out Tunnel1
The following is a sample output from the show ip eigrp topology all-links command, and displays
all the paths, including those that are not feasible:
Device# show ip eigrp topology all-links
EIGRP-IPv4 Topology Table for AS(1)/ID(10.0.0.1)
Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply,
r - reply Status, s - sia Status
P 172.16.1.0/24, 1 successors, FD is 409600, serno 14
via 10.10.1.2 (409600/128256), Ethernet0/0
via 10.1.4.3 (2586111744/2585599744), Serial3/0, serno 18
The following is a sample output from the show ip eigrp topology detail-links command, and
displays additional details about routes:
Device# show ip eigrp topology detail-links
EIGRP-IPv4 Topology Table for AS(1)/ID(10.0.0.1)
Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply,
r - reply Status, s - sia Status
P 10.0.0.0/8, 1 successors, FD is 409600, serno 6
via 10.10.1.2 (409600/128256), Ethernet0/0
P 172.16.1.0/24, 1 successors, FD is 409600, serno 14
via 10.10.1.2 (409600/128256), Ethernet0/0
P 10.0.0.0/8, 1 successors, FD is 281600, serno 3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1565
Routing
show ip eigrp topology
via Summary (281600/0), Null0
P 10.1.1.0/24, 1 successors, FD is 281600, serno 1
via Connected, Ethernet0/0
The following table describes the significant fields shown in the above examples:
Table 179: show ip eigrp topology Field Descriptions
Field Description
Codes State of this topology table entry. Passive and Active
refer to the EIGRP state with respect to the destination.
Update, Query, and Reply refer to the type of packet
that is being sent.
• P - Passive: Indicates that no EIGRP computations
are being performed for this route.
• A - Active: Indicates that EIGRP computations are
being performed for this route.
• U - Update: Indicates that a pending update packet
is waiting to be sent for this route.
• Q - Query: Indicates that a pending query packet
is waiting to be sent for this route.
• R - Reply: Indicates that a pending reply packet is
waiting to be sent for this route.
• r - Reply status: Indicates that EIGRP has sent a
query for the route and is waiting for a reply from
the specified path.
• s - sia status: Indicates that the EIGRP query packet
is in stuck-in-active (SIA) status.
successors Number of successors. This number corresponds to the
number of next hops in the IP routing table. If successors
is capitalized, then the route or the next hop is in a
transition state.
serno Serial number.
FD Feasible distance. This is the best metric to reach the
destination or the best metric that was known when the
route became active. This value is used in the feasibility
condition check. If the reported distance of the device
is less than the feasible distance, the feasibility condition
is met and that route becomes a feasible successor. After
the software determines that it has a feasible successor,
the software need not send a query for that destination.
via Next-hop address that advertises the passive route.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1566
Routing
show ip eigrp topology
Related Commands Command Description
show eigrp address-family topology Displays entries in the EIGRP address-family topology table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1567
Routing
show ip eigrp traffic
show ip eigrp traffic
To display the number of Enhanced Interior Gateway Routing Protocol (EIGRP) packets sent and received,
use the show ip eigrp traffic command in privileged EXEC mode.
show ip eigrp [vrf {vrf-name | *}] [autonomous-system-number] traffic
Syntax Description vrf vrf-name (Optional) Displays information about the specified VRF.
vrf * (Optional) Displays information about all VRFs.
autonomous-system-number (Optional) Autonomous system number.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command can be used to display information about EIGRP named configurations and EIGRP
autonomous-system (AS) configurations.
This command displays the same information as the show eigrp address-family traffic command. Cisco
recommends using the show eigrp address-family traffic command.
Examples The following is sample output from the show ip eigrp traffic command:
Device#show ip eigrp traffic
EIGRP-IPv4 Traffic Statistics for AS(60)
Hellos sent/received: 21429/2809
Updates sent/received: 22/17
Queries sent/received: 0/0
Replies sent/received: 0/0
Acks sent/received: 16/13
SIA-Queries sent/received: 0/0
SIA-Replies sent/received: 0/0
Hello Process ID: 204
PDM Process ID: 203
Socket Queue: 0/2000/2/0 (current/max/highest/drops)
Input Queue: 0/2000/2/0 (current/max/highest/drops)
The table below describes the significant fields shown in the display.
Table 180: show ip eigrp traffic Field Descriptions
Field Description
Hellos sent/received Number of hello packets sent and received.
Updates sent/received Number of update packets sent and received.
Queries sent/received Number of query packets sent and received.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1568
Routing
show ip eigrp traffic
Field Description
Replies sent/received Number of reply packets sent and received.
Acks sent/received Number of acknowledgement packets sent and received.
SIA-Queries sent/received Number of stuck in active query packets sent and received.
SIA-Replies sent/received Number of stuck in active reply packets sent and received.
Hello Process ID Hello process identifier.
PDM Process ID Protocol-dependent module IOS process identifier.
Socket Queue The IP to EIGRP Hello Process socket queue counters.
Input queue The EIGRP Hello Process to EIGRP PDM socket queue counters.
Related Commands Command Description
show eigrp address-family traffic Displays the number of EIGRP packets sent and received.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1569
Routing
show ip ospf
show ip ospf
To display general information about Open Shortest Path First (OSPF) routing processes, use the showipospf
command in user EXEC or privileged EXEC mode.
show ip ospf [process-id]
Syntax Description process-id (Optional) Process ID. If this argument is included, only information for the specified routing
process is included.
Command Modes User EXEC Privileged EXEC
Command History Mainline Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is sample output from the showipospf command when entered without a specific
OSPF process ID:
Device#show ip ospf
Routing Process "ospf 201" with ID 10.0.0.1 and Domain ID 10.20.0.1
Supports only single TOS(TOS0) routes
Supports opaque LSA
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
LSA group pacing timer 100 secs
Interface flood pacing timer 55 msecs
Retransmission pacing timer 100 msecs
Number of external LSA 0. Checksum Sum 0x0
Number of opaque AS LSA 0. Checksum Sum 0x0
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 2. 2 normal 0 stub 0 nssa
External flood list length 0
Area BACKBONE(0)
Number of interfaces in this area is 2
Area has message digest authentication
SPF algorithm executed 4 times
Area ranges are
Number of LSA 4. Checksum Sum 0x29BEB
Number of opaque link LSA 0. Checksum Sum 0x0
Number of DCbitless LSA 3
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
Area 172.16.26.0
Number of interfaces in this area is 0
Area has no authentication
SPF algorithm executed 1 times
Area ranges are
192.168.0.0/16 Passive Advertise
Number of LSA 1. Checksum Sum 0x44FD
Number of opaque link LSA 0. Checksum Sum 0x0
Number of DCbitless LSA 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1570
Routing
show ip ospf
Number of indication LSA 1
Number of DoNotAge LSA 0
Flood list length 0
Cisco IOS Release 12.2(18)SXE, 12.0(31)S, and 12.4(4)T
The following is sample output from the showipospfcommand to verify that the BFD feature has
been enabled for OSPF process 123. The relevant command output is shown in bold in the output.
Device#show ip ospf
Routing Process "ospf 123" with ID 172.16.10.1
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Incremental-SPF disabled
Minimum LSA interval 5 secs
Minimum LSA arrival 1000 msecs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x000000
Number of opaque AS LSA 0. Checksum Sum 0x000000
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
External flood list length 0
BFD is enabled
Area BACKBONE(0)
Number of interfaces in this area is 2
Area has no authentication
SPF algorithm last executed 00:00:03.708 ago
SPF algorithm executed 27 times
Area ranges are
Number of LSA 3. Checksum Sum 0x00AEF1
Number of opaque link LSA 0. Checksum Sum 0x000000
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
The table below describes the significant fields shown in the display.
Table 181: show ip ospf Field Descriptions
Field Description
Routing process “ospf 201” with ID 10.0.0.1 Process ID and OSPF router ID.
Supports... Number of types of service supported (Type 0 only).
SPF schedule delay Delay time (in seconds) of SPF calculations.
Minimum LSA interval Minimum interval (in seconds) between link-state
advertisements.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1571
Routing
show ip ospf
Field Description
LSA group pacing timer Configured LSA group pacing timer (in seconds).
Interface flood pacing timer Configured LSA flood pacing timer (in milliseconds).
Retransmission pacing timer Configured LSA retransmission pacing timer (in
milliseconds).
Number of external LSA Number of external link-state advertisements.
Number of opaque AS LSA Number of opaque link-state advertisements.
Number of DCbitless external and opaque AS Number of demand circuit external and opaque link-state
LSA advertisements.
Number of DoNotAge external and opaque AS Number of do not age external and opaque link-state
LSA advertisements.
Number of areas in this router is Number of areas configured for the router.
External flood list length External flood list length.
BFD is enabled BFD has been enabled on the OSPF process.
The following is an excerpt of output from the showipospf command when the OSPF Forwarding
Address Suppression in Type-5 LSAs feature is configured:
Device#show ip ospf
.
.
.
Area 2
Number of interfaces in this area is 4
It is a NSSA area
Perform type-7/type-5 LSA translation, suppress forwarding address
.
.
.
Routing Process "ospf 1" with ID 192.168.0.1
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Incremental-SPF disabled
Minimum LSA interval 5 secs
Minimum LSA arrival 1000 msecs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x0
Number of opaque AS LSA 0. Checksum Sum 0x0
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 0. 0 normal 0 stub 0 nssa
External flood list length 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1572
Routing
show ip ospf
The table below describes the significant fields shown in the display.
Table 182: show ip ospf Field Descriptions
Field Description
Area OSPF area and tag.
Number of interfaces... Number of interfaces configured in the area.
It is... Possible types are internal, area border, or autonomous system
boundary.
Routing process “ospf 1” with ID Process ID and OSPF router ID.
192.168.0.1
Supports... Number of types of service supported (Type 0 only).
Initial SPF schedule delay Delay time of SPF calculations at startup.
Minimum hold time Minimum hold time (in milliseconds) between consecutive SPF
calculations.
Maximum wait time Maximum wait time (in milliseconds) between consecutive SPF
calculations.
Incremental-SPF Status of incremental SPF calculations.
Minimum LSA... Minimum time interval (in seconds) between link-state
advertisements, and minimum arrival time (in milliseconds) of
link-state advertisements,
LSA group pacing timer Configured LSA group pacing timer (in seconds).
Interface flood pacing timer Configured LSA flood pacing timer (in milliseconds).
Retransmission pacing timer Configured LSA retransmission pacing timer (in milliseconds).
Number of... Number and type of link-state advertisements that have been
received.
Number of external LSA Number of external link-state advertisements.
Number of opaque AS LSA Number of opaque link-state advertisements.
Number of DCbitless external and opaque Number of demand circuit external and opaque link-state
AS LSA advertisements.
Number of DoNotAge external and opaque Number of do not age external and opaque link-state
AS LSA advertisements.
Number of areas in this router is Number of areas configured for the router listed by type.
External flood list length External flood list length.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1573
Routing
show ip ospf
The following is sample output from the showipospf command. In this example, the user had
configured the redistributionmaximum-prefix command to set a limit of 2000 redistributed routes.
SPF throttling was configured with the timersthrottlespf command.
Device#show ip ospf 1
Routing Process "ospf 1" with ID 10.0.0.1
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
It is an autonomous system boundary router
Redistributing External Routes from,
static, includes subnets in redistribution
Maximum limit of redistributed prefixes 2000
Threshold for warning message 75%
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
The table below describes the significant fields shown in the display.
Table 183: show ip ospf Field Descriptions
Field Description
Routing process “ospf 1” with ID Process ID and OSPF router ID.
10.0.0.1
Supports ... Number of Types of Service supported.
It is ... Possible types are internal, area border, or autonomous system
boundary router.
Redistributing External Routes from Lists of redistributed routes, by protocol.
Maximum limit of redistributed Value set in the redistributionmaximum-prefix command to set
prefixes a limit on the number of redistributed routes.
Threshold for warning message Percentage set in the redistributionmaximum-prefix command
for the threshold number of redistributed routes needed to cause a
warning message. The default is 75 percent of the maximum limit.
Initial SPF schedule delay Delay (in milliseconds) before initial SPF schedule for SPF throttling.
Configured with the timersthrottlespf command.
Minimum hold time between two Minimum hold time (in milliseconds) between two consecutive SPF
consecutive SPFs calculations for SPF throttling. Configured with the
timersthrottlespf command.
Maximum wait time between two Maximum wait time (in milliseconds) between two consecutive SPF
consecutive SPFs calculations for SPF throttling. Configured with the
timersthrottlespf command.
Number of areas Number of areas in router, area addresses, and so on.
The following is sample output from the showipospf command. In this example, the user had
configured LSA throttling, and those lines of output are displayed in bold.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1574
Routing
show ip ospf
Device#show ip ospf 1
Routing Process "ospf 4" with ID 10.10.24.4
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Incremental-SPF disabled
Initial LSA throttle delay 100 msecs
Minimum hold time for LSA throttle 10000 msecs
Maximum wait time for LSA throttle 45000 msecs
Minimum LSA arrival 1000 msecs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x0
Number of opaque AS LSA 0. Checksum Sum 0x0
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
External flood list length 0
Area 24
Number of interfaces in this area is 2
Area has no authentication
SPF algorithm last executed 04:28:18.396 ago
SPF algorithm executed 8 times
Area ranges are
Number of LSA 4. Checksum Sum 0x23EB9
Number of opaque link LSA 0. Checksum Sum 0x0
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
The following is sample showipospfcommand. In this example, the user had configured the
redistributionmaximum-prefix command to set a limit of 2000 redistributed routes. SPF throttling
was configured with the timersthrottlespf command.
Device#show ip ospf 1
Routing Process "ospf 1" with ID 192.168.0.0
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
It is an autonomous system boundary router
Redistributing External Routes from,
static, includes subnets in redistribution
Maximum limit of redistributed prefixes 2000
Threshold for warning message 75%
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
The table below describes the significant fields shown in the display.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1575
Routing
show ip ospf
Table 184: show ip ospf Field Descriptions
Field Description
Routing process “ospf 1” with ID Process ID and OSPF router ID.
192.168.0.0.
Supports ... Number of TOS supported.
It is ... Possible types are internal, area border, or autonomous system
boundary routers.
Redistributing External Routes from Lists of redistributed routes, by protocol.
Maximum limit of redistributed prefixes Value set in the redistributionmaximum-prefix command to set
a limit on the number of redistributed routes.
Threshold for warning message Percentage set in the redistributionmaximum-prefix command
for the threshold number of redistributed routes needed to cause a
warning message. The default is 75 percent of the maximum limit.
Initial SPF schedule delay Delay (in milliseconds) before the initial SPF schedule for SPF
throttling. Configured with the timersthrottlespf command.
Minimum hold time between two Minimum hold time (in milliseconds) between two consecutive SPF
consecutive SPFs calculations for SPF throttling. Configured with the
timersthrottlespf command.
Maximum wait time between two Maximum wait time (in milliseconds) between two consecutive SPF
consecutive SPFs calculations for SPF throttling. Configured with the
timersthrottlespf command.
Number of areas Number of areas in router, area addresses, and so on.
The following is sample output from the showipospf command. In this example, the user had
configured LSA throttling, and those lines of output are displayed in bold.
Device#show ip ospf 1
Routing Process "ospf 4" with ID 10.10.24.4
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Incremental-SPF disabled
Initial LSA throttle delay 100 msecs
Minimum hold time for LSA throttle 10000 msecs
Maximum wait time for LSA throttle 45000 msecs
Minimum LSA arrival 1000 msecs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x0
Number of opaque AS LSA 0. Checksum Sum 0x0
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1576
Routing
show ip ospf
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
External flood list length 0
Area 24
Number of interfaces in this area is 2
Area has no authentication
SPF algorithm last executed 04:28:18.396 ago
SPF algorithm executed 8 times
Area ranges are
Number of LSA 4. Checksum Sum 0x23EB9
Number of opaque link LSA 0. Checksum Sum 0x0
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1577
Routing
show ip ospf border-routers
show ip ospf border-routers
To display the internal Open Shortest Path First (OSPF) routing table entries to an Area Border Router (ABR)
and Autonomous System Boundary Router (ASBR), use the showipospfborder-routers command in privileged
EXEC mode.
show ip ospf border-routers
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is sample output from the showipospfborder-routers command:
Device#show ip ospf border-routers
OSPF Process 109 internal Routing Table
Codes: i - Intra-area route, I - Inter-area route
i 192.168.97.53 [10] via 172.16.1.53, Serial0, ABR, Area 0.0.0.3, SPF 3
i 192.168.103.51 [10] via 192.168.96.51, Serial0, ABR, Area 0.0.0.3, SPF 3
I 192.168.103.52 [22] via 192.168.96.51, Serial0, ASBR, Area 0.0.0.3, SPF 3
I 192.168.103.52 [22] via 172.16.1.53, Serial0, ASBR, Area 0.0.0.3, SPF 3
The table below describes the significant fields shown in the display.
Table 185: show ip ospf border-routers Field Descriptions
Field Description
192.168.97.53 Router ID of the destination.
[10] Cost of using this route.
via 172.16.1.53 Next hop toward the destination.
Serial0 Interface type for the outgoing interface.
ABR The router type of the destination; it is either an ABR or ASBR or both.
Area The area ID of the area from which this route is learned.
SPF 3 The internal number of the shortest path first (SPF) calculation that installs this route.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1578
Routing
show ip ospf database
show ip ospf database
To display lists of information related to the Open Shortest Path First (OSPF) database for a specific router,
use the showipospfdatabase command in EXEC mode.
show ip ospf [process-id area-id] database
show ip ospf [process-id area-id] database [adv-router [ip-address]]
show ip ospf [process-id area-id] database [asbr-summary] [link-state-id]
show ip ospf [process-id area-id] database [asbr-summary] [link-state-id] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [asbr-summary] [link-state-id] [self-originate]
[link-state-id]
show ip ospf [process-id area-id] database [database-summary]
show ip ospf [process-id] database [external] [link-state-id]
show ip ospf [process-id] database [external] [link-state-id] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [external] [link-state-id] [self-originate] [link-state-id]
show ip ospf [process-id area-id] database [network] [link-state-id]
show ip ospf [process-id area-id] database [network] [link-state-id] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [network] [link-state-id] [self-originate] [link-state-id]
show ip ospf [process-id area-id] database [nssa-external] [link-state-id]
show ip ospf [process-id area-id] database [nssa-external] [link-state-id] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [nssa-external] [link-state-id] [self-originate] [link-state-id]
show ip ospf [process-id area-id] database [router] [link-state-id]
show ip ospf [process-id area-id] database [router] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [router] [self-originate] [link-state-id]
show ip ospf [process-id area-id] database [self-originate] [link-state-id]
show ip ospf [process-id area-id] database [summary] [link-state-id]
show ip ospf [process-id area-id] database [summary] [link-state-id] [adv-router [ip-address]]
show ip ospf [process-id area-id] database [summary] [link-state-id] [self-originate] [link-state-id]
Syntax Description process-id (Optional) Internal identification. It is locally assigned and can be any positive
integer. The number used here is the number assigned administratively when
enabling the OSPF routing process.
area-id (Optional) Area number associated with the OSPF address range defined in the
network router configuration command used to define the particular area.
adv-router [ip-address (Optional) Displays all the LSAs of the specified router. If no IP address is included,
the information is about the local router itself (in this case, the same as
self-originate).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1579
Routing
show ip ospf database
link-state-id (Optional) Portion of the Internet environment that is being described by the
advertisement. The value entered depends on the advertisement’s LS type. It must
be entered in the form of an IP address.
When the link state advertisement is describing a network, the link-state-id can
take one of two forms:
The network’s IP address (as in type 3 summary link advertisements and in
autonomous system external link advertisements).
A derived address obtained from the link state ID. (Note that masking a network
links advertisement’s link state ID with the network’s subnet mask yields the
network’s IP address.)
When the link state advertisement is describing a router, the link state ID is always
the described router’s OSPF router ID.
When an autonomous system external advertisement (LS Type = 5) is describing
a default route, its link state ID is set to Default Destination (0.0.0.0).
asbr-summary (Optional) Displays information only about the autonomous system boundary
router summary LSAs.
database-summary (Optional) Displays how many of each type of LSA for each area there are in the
database, and the total.
external (Optional) Displays information only about the external LSAs.
network (Optional) Displays information only about the network LSAs.
nssa-external (Optional) Displays information only about the NSSA external LSAs.
router (Optional) Displays information only about the router LSAs.
self-originate (Optional) Displays only self-originated LSAs (from the local router).
summary (Optional) Displays information only about the summary LSAs.
Command Modes EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The various forms of this command deliver information about different OSPF link state advertisements.
Examples The following is sample output from the showipospfdatabase command when no arguments or
keywords are used:
Device#show ip ospf database
OSPF Router with id(192.168.239.66) (Process ID 300)
Displaying Router Link States(Area 0.0.0.0)
Link ID ADV Router Age Seq# Checksum Link count
172.16.21.6 172.16.21.6 1731 0x80002CFB 0x69BC 8
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1580
Routing
show ip ospf database
172.16.21.5 172.16.21.5 1112 0x800009D2 0xA2B8 5
172.16.1.2 172.16.1.2 1662 0x80000A98 0x4CB6 9
172.16.1.1 172.16.1.1 1115 0x800009B6 0x5F2C 1
172.16.1.5 172.16.1.5 1691 0x80002BC 0x2A1A 5
172.16.65.6 172.16.65.6 1395 0x80001947 0xEEE1 4
172.16.241.5 172.16.241.5 1161 0x8000007C 0x7C70 1
172.16.27.6 172.16.27.6 1723 0x80000548 0x8641 4
172.16.70.6 172.16.70.6 1485 0x80000B97 0xEB84 6
Displaying Net Link States(Area 0.0.0.0)
Link ID ADV Router Age Seq# Checksum
172.16.1.3 192.168.239.66 1245 0x800000EC 0x82E
Displaying Summary Net Link States(Area 0.0.0.0)
Link ID ADV Router Age Seq# Checksum
172.16.240.0 172.16.241.5 1152 0x80000077 0x7A05
172.16.241.0 172.16.241.5 1152 0x80000070 0xAEB7
172.16.244.0 172.16.241.5 1152 0x80000071 0x95CB
The table below describes the significant fields shown in the display.
Table 186: show ip ospf Database Field Descriptions
Field Description
Link ID Router ID number.
ADV Router Advertising router’s ID.
Age Link state age.
Seq# Link state sequence number (detects old or duplicate link state advertisements).
Checksum Fletcher checksum of the complete contents of the link state advertisement.
Link count Number of interfaces detected for router.
The following is sample output from the showipospfdatabasecommand with the
asbr-summarykeyword:
Device#show ip ospf database asbr-summary
OSPF Router with id(192.168.239.66) (Process ID 300)
Displaying Summary ASB Link States(Area 0.0.0.0)
LS age: 1463
Options: (No TOS-capability)
LS Type: Summary Links(AS Boundary Router)
Link State ID: 172.16.245.1 (AS Boundary Router address)
Advertising Router: 172.16.241.5
LS Seq Number: 80000072
Checksum: 0x3548
Length: 28
Network Mask: 0.0.0.0 TOS: 0 Metric: 1
The table below describes the significant fields shown in the display.
Table 187: show ip ospf database asbr-summary Field Descriptions
Field Description
OSPF Router with id Router ID number.
Process ID OSPF process ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1581
Routing
show ip ospf database
Field Description
LS age Link state age.
Options Type of service options (Type 0 only).
LS Type Link state type.
Link State ID Link state ID (autonomous system boundary router).
Advertising Router Advertising router’s ID.
LS Seq Number Link state sequence (detects old or duplicate link state advertisements).
Checksum LS checksum (Fletcher checksum of the complete contents of the link state
advertisement).
Length Length in bytes of the link state advertisement.
Network Mask Network mask implemented.
TOS Type of service.
Metric Link state metric.
The following is sample output from the showipospfdatabasecommand with the externalkeyword:
Device#show ip ospf database external
OSPF Router with id(192.168.239.66) (Autonomous system 300)
Displaying AS External Link States
LS age: 280
Options: (No TOS-capability)
LS Type: AS External Link
Link State ID: 10.105.0.0 (External Network Number)
Advertising Router: 172.16.70.6
LS Seq Number: 80000AFD
Checksum: 0xC3A
Length: 36
Network Mask: 255.255.0.0
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 1
Forward Address: 0.0.0.0
External Route Tag: 0
The table below describes the significant fields shown in the display.
Table 188: show ip ospf database external Field Descriptions
Field Description
OSPF Router with id Router ID number.
Autonomous system OSPF autonomous system number (OSPF process ID).
LS age Link state age.
Options Type of service options (Type 0 only).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1582
Routing
show ip ospf database
Field Description
LS Type Link state type.
Link State ID Link state ID (external network number).
Advertising Router Advertising router’s ID.
LS Seq Number Link state sequence number (detects old or duplicate link state advertisements).
Checksum LS checksum (Fletcher checksum of the complete contents of the LSA).
Length Length in bytes of the link state advertisement.
Network Mask Network mask implemented.
Metric Type External Type.
TOS Type of service.
Metric Link state metric.
Forward Address Forwarding address. Data traffic for the advertised destination will be forwarded to
this address. If the forwarding address is set to 0.0.0.0, data traffic will be forwarded
instead to the advertisement’s originator.
External Route Tag External route tag, a 32-bit field attached to each external route. This is not used by
the OSPF protocol itself.
The following is sample output from the showipospfdatabasecommand with the networkkeyword:
Device#show ip ospf database network
OSPF Router with id(192.168.239.66) (Process ID 300)
Displaying Net Link States(Area 0.0.0.0)
LS age: 1367
Options: (No TOS-capability)
LS Type: Network Links
Link State ID: 172.16.1.3 (address of Designated Router)
Advertising Router: 192.168.239.66
LS Seq Number: 800000E7
Checksum: 0x1229
Length: 52
Network Mask: 255.255.255.0
Attached Router: 192.168.239.66
Attached Router: 172.16.241.5
Attached Router: 172.16.1.1
Attached Router: 172.16.54.5
Attached Router: 172.16.1.5
The table below describes the significant fields shown in the display.
Table 189: show ip ospf database network Field Descriptions
Field Description
OSPF Router with id Router ID number.
Process ID 300 OSPF process ID.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1583
Routing
show ip ospf database
Field Description
LS age Link state age.
Options Type of service options (Type 0 only).
LS Type: Link state type.
Link State ID Link state ID of designated router.
Advertising Router Advertising router’s ID.
LS Seq Number Link state sequence (detects old or duplicate link state advertisements).
Checksum LS checksum (Fletcher checksum of the complete contents of the link state
advertisement).
Length Length in bytes of the link state advertisement.
Network Mask Network mask implemented.
AS Boundary Router Definition of router type.
Attached Router List of routers attached to the network, by IP address.
The following is sample output from the showipospfdatabasecommand with the routerkeyword:
Device#show ip ospf database router
OSPF Router with id(192.168.239.66) (Process ID 300)
Displaying Router Link States(Area 0.0.0.0)
LS age: 1176
Options: (No TOS-capability)
LS Type: Router Links
Link State ID: 172.16.21.6
Advertising Router: 172.16.21.6
LS Seq Number: 80002CF6
Checksum: 0x73B7
Length: 120
AS Boundary Router
155 Number of Links: 8
Link connected to: another Router (point-to-point)
(link ID) Neighboring Router ID: 172.16.21.5
(Link Data) Router Interface address: 172.16.21.6
Number of TOS metrics: 0
TOS 0 Metrics: 2
The table below describes the significant fields shown in the display.
Table 190: show ip ospf database router Field Descriptions
Field Description
OSPF Router with id Router ID number.
Process ID OSPF process ID.
LS age Link state age.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1584
Routing
show ip ospf database
Field Description
Options Type of service options (Type 0 only).
LS Type Link state type.
Link State ID Link state ID.
Advertising Router Advertising router’s ID.
LS Seq Number Link state sequence (detects old or duplicate link state advertisements).
Checksum LS checksum (Fletcher checksum of the complete contents of the link state
advertisement).
Length Length in bytes of the link state advertisement.
AS Boundary Router Definition of router type.
Number of Links Number of active links.
link ID Link type.
Link Data Router interface address.
TOS Type of service metric (Type 0 only).
The following is sample output from showipospfdatabasecommand with the summarykeyword:
Device#show ip ospf database summary
OSPF Router with id(192.168.239.66) (Process ID 300)
Displaying Summary Net Link States(Area 0.0.0.0)
LS age: 1401
Options: (No TOS-capability)
LS Type: Summary Links(Network)
Link State ID: 172.16.240.0 (summary Network Number)
Advertising Router: 172.16.241.5
LS Seq Number: 80000072
Checksum: 0x84FF
Length: 28
Network Mask: 255.255.255.0 TOS: 0 Metric: 1
The table below describes the significant fields shown in the display.
Table 191: show ip ospf database summary Field Descriptions
Field Description
OSPF Router with id Router ID number.
Process ID OSPF process ID.
LS age Link state age.
Options Type of service options (Type 0 only).
LS Type Link state type.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1585
Routing
show ip ospf database
Field Description
Link State ID Link state ID (summary network number).
Advertising Router Advertising router’s ID.
LS Seq Number Link state sequence (detects old or duplicate link state advertisements).
Checksum LS checksum (Fletcher checksum of the complete contents of the link state
advertisement).
Length Length in bytes of the link state advertisement.
Network Mask Network mask implemented.
TOS Type of service.
Metric Link state metric.
The following is sample output from showipospfdatabasecommand with the
database-summarykeyword:
Device#show ip ospf database database-summary
OSPF Router with ID (10.0.0.1) (Process ID 1)
Area 0 database summary
LSA Type Count Delete Maxage
Router 3 0 0
Network 0 0 0
Summary Net 0 0 0
Summary ASBR 0 0 0
Type-7 Ext 0 0 0
Self-originated Type-7 0
Opaque Link 0 0 0
Opaque Area 0 0 0
Subtotal 3 0 0
Process 1 database summary
LSA Type Count Delete Maxage
Router 3 0 0
Network 0 0 0
Summary Net 0 0 0
Summary ASBR 0 0 0
Type-7 Ext 0 0 0
Opaque Link 0 0 0
Opaque Area 0 0 0
Type-5 Ext 0 0 0
Self-originated Type-5 200
Opaque AS 0 0 0
Total 203 0 0
The table below describes the significant fields shown in the display.
Table 192: show ip ospf database database-summary Field Descriptions
Field Description
Area 0 database summary Area number.
Count Count of LSAs of the type identified in the first column.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1586
Routing
show ip ospf database
Field Description
Router Number of router link state advertisements in that area.
Network Number of network link state advertisements in that area.
Summary Net Number of summary link state advertisements in that area.
Summary ASBR Number of summary autonomous system boundary router (ASBR) link state
advertisements in that area.
Type-7 Ext Type-7 LSA count.
Self-originated Type-7 Self-originated Type-7 LSA.
Opaque Link Type-9 LSA count.
Opaque Area Type-10 LSA count
Subtotal Sum of LSAs for that area.
Delete Number of link state advertisements that are marked “Deleted” in that area.
Maxage Number of link state advertisements that are marked “Maxaged” in that area.
Process 1 database summary Database summary for the process.
Count Count of LSAs of the type identified in the first column.
Router Number of router link state advertisements in that process.
Network Number of network link state advertisements in that process.
Summary Net Number of summary link state advertisements in that process.
Summary ASBR Number of summary autonomous system boundary router (ASBR) link state
advertisements in that process.
Type-7 Ext Type-7 LSA count.
Opaque Link Type-9 LSA count.
Opaque Area Type-10 LSA count.
Type-5 Ext Type-5 LSA count.
Self-Originated Type-5 Self-originated Type-5 LSA count.
Opaque AS Type-11 LSA count.
Total Sum of LSAs for that process.
Delete Number of link state advertisements that are marked “Deleted” in that process.
Maxage Number of link state advertisements that are marked “Maxaged” in that process.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1587
Routing
show ip ospf interface
show ip ospf interface
To display interface information related to Open Shortest Path First (OSPF), use the show ip ospf interface
command in user EXEC or privileged EXEC mode.
show ip [ospf] [process-id] interface [type number] [brief] [multicast] [topology {topology-name
| base}]
Syntax Description process-id (Optional) Process ID number. If this argument is included, only information for
the specified routing process is included. The range is 1 to 65535.
type (Optional) Interface type. If the type argument is included, only information for
the specified interface type is included.
number (Optional) Interface number. If the number argument is included, only information
for the specified interface number is included.
brief (Optional) Displays brief overview information for OSPF interfaces, states,
addresses and masks, and areas on the device.
multicast (Optional) Displays multicast information.
topology topology-name (Optional) Displays OSPF-related information about the named topology instance.
topology base (Optional) Displays OSPF-related information about the base topology.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following is sample output from the show ip ospf interface command when Ethernet interface
0/0 is specified:
Device#show ip ospf interface ethernet 0/0
Ethernet0/0 is up, line protocol is up
Internet Address 192.168.254.202/24, Area 0
Process ID 1, Router ID 192.168.99.1, Network Type BROADCAST, Cost: 10
Topology-MTID Cost Disabled Shutdown Topology Name
0 10 no no Base
Transmit Delay is 1 sec, State DR, Priority 1
Designated Router (ID) 192.168.99.1, Interface address 192.168.254.202
Backup Designated router (ID) 192.168.254.10, Interface address 192.168.254.10
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
oob-resync timeout 40
Hello due in 00:00:05
Supports Link-local Signaling (LLS)
Cisco NSF helper support enabled
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1588
Routing
show ip ospf interface
IETF NSF helper support enabled
Index 1/1, flood queue length 0
Next 0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 192.168.254.10 (Backup Designated Router)
Suppress hello for 0 neighbor(s)
In Cisco IOS Release 12.2(33)SRB, the following sample output from the show ip ospf interface
brief topology VOICE command shows a summary of information, including a confirmation that
the Multitopology Routing (MTR) VOICE topology is configured in the interface configuration:
Device#show ip ospf interface brief topology VOICE
VOICE Topology (MTID 10)
Interface PID Area IP Address/Mask Cost State Nbrs F/C
Lo0 1 0 10.0.0.2/32 1 LOOP 0/0
Se2/0 1 0 10.1.0.2/30 10 P2P 1/1
The following sample output from the show ip ospf interface brief topology VOICE command
displays details of the MTR VOICE topology for the interface. When the command is entered without
the brief keyword, more information is displayed.
Device#show ip ospf interface topology VOICE
VOICE Topology (MTID 10)
Loopback0 is up, line protocol is up
Internet Address 10.0.0.2/32, Area 0
Process ID 1, Router ID 10.0.0.2, Network Type LOOPBACK
Topology-MTID Cost Disabled Shutdown Topology Name
10 1 no no VOICE
Loopback interface is treated as a stub Host Serial2/0 is up, line protocol is up
Internet Address 10.1.0.2/30, Area 0
Process ID 1, Router ID 10.0.0.2, Network Type POINT_TO_POINT
Topology-MTID Cost Disabled Shutdown Topology Name
10 10 no no VOICE
Transmit Delay is 1 sec, State POINT_TO_POINT
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
oob-resync timeout 40
Hello due in 00:00:03
Supports Link-local Signaling (LLS)
Cisco NSF helper support enabled
IETF NSF helper support enabled
Index 1/1, flood queue length 0
Next 0x0(0)/0x0(0)
Last flood scan length is 1, maximum is 1
Last flood scan time is 0 msec, maximum is 0 msec
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 10.0.0.1
Suppress hello for 0 neighbor(s)
In Cisco IOS Release 12.2(33)SRC, the following sample output from the show ip ospf interface
command displays details about the configured Time-to-Live (TTL) limits:
Device#show ip ospf interface ethernet 0
.
.
.
Strict TTL checking enabled
! or a message similar to the following is displayed
Strict TTL checking enabled, up to 4 hops allowed
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1589
Routing
show ip ospf interface
.
.
.
The table below describes the significant fields shown in the displays.
Table 193: show ip ospf interface Field Descriptions
Field Description
Ethernet Status of the physical link and operational status of the protocol.
Process ID OSPF process ID.
Area OSPF area.
Cost Administrative cost assigned to the interface.
State Operational state of the interface.
Nbrs F/C OSPF neighbor count.
Internet Address Interface IP address, subnet mask, and area address.
Topology-MTID MTR topology Multitopology Identifier (MTID). A number assigned
so that the protocol can identify the topology associated with
information that it sends to its peers.
Transmit Delay Transmit delay in seconds, interface state, and device priority.
Designated Router Designated router ID and respective interface IP address.
Backup Designated router Backup designated router ID and respective interface IP address.
Timer intervals configured Configuration of timer intervals.
Hello Number of seconds until the next hello packet is sent out this
interface.
Strict TTL checking enabled Only one hop is allowed.
Strict TTL checking enabled, up to 4 A set number of hops has been explicitly configured.
hops allowed
Neighbor Count Count of network neighbors and list of adjacent neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1590
Routing
show ip ospf neighbor
show ip ospf neighbor
To display Open Shortest Path First (OSPF) neighbor information on a per-interface basis, use the
showipospfneighbor command in privileged EXEC mode.
show ip ospf neighbor [interface-type interface-number] [neighbor-id] [detail] [summary
[per-instance]]
Syntax Description interface-type interface-number (Optional) Type and number associated with a specific OSPF interface.
neighbor-id (Optional) Neighbor hostname or IP address in A.B.C.D format.
detail (Optional) Displays all neighbors given in detail (lists all neighbors).
summary (Optional) Displays total number summary of all neighbors.
per-instance (Optional) Displays total number of neighbors in each neighbor state. The
output is printed for each configured OSPF instance separately.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following sample output from the show ip ospf neighbor command shows a single line of
summary information for each neighbor:
Device#show ip ospf neighbor
Neighbor ID Pri State Dead Time Address Interface
10.199.199.137 1 FULL/DR 0:00:31 192.168.80.37 Ethernet0
172.16.48.1 1 FULL/DROTHER 0:00:33 172.16.48.1 Fddi0
172.16.48.200 1 FULL/DROTHER 0:00:33 172.16.48.200 Fddi0
10.199.199.137 5 FULL/DR 0:00:33 172.16.48.189 Fddi0
The following is sample output showing summary information about the neighbor that matches the
neighbor ID:
Device#show ip ospf neighbor 10.199.199.137
Neighbor 10.199.199.137, interface address 192.168.80.37
In the area 0.0.0.0 via interface Ethernet0
Neighbor priority is 1, State is FULL
Options 2
Dead timer due in 0:00:32
Link State retransmission due in 0:00:04
Neighbor 10.199.199.137, interface address 172.16.48.189
In the area 0.0.0.0 via interface Fddi0
Neighbor priority is 5, State is FULL
Options 2
Dead timer due in 0:00:32
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1591
Routing
show ip ospf neighbor
Link State retransmission due in 0:00:03
If you specify the interface along with the neighbor ID, the system displays the neighbors that match
the neighbor ID on the interface, as in the following sample display:
Device#show ip ospf neighbor ethernet 0 10.199.199.137
Neighbor 10.199.199.137, interface address 192.168.80.37
In the area 0.0.0.0 via interface Ethernet0
Neighbor priority is 1, State is FULL
Options 2
Dead timer due in 0:00:37
Link State retransmission due in 0:00:04
You can also specify the interface without the neighbor ID to show all neighbors on the specified
interface, as in the following sample display:
Device#show ip ospf neighbor fddi 0
ID Pri State Dead Time Address Interface
172.16.48.1 1 FULL/DROTHER 0:00:33 172.16.48.1 Fddi0
172.16.48.200 1 FULL/DROTHER 0:00:32 172.16.48.200 Fddi0
10.199.199.137 5 FULL/DR 0:00:32 172.16.48.189 Fddi0
The following is sample output from the show ip ospf neighbor detail command:
Device#show ip ospf neighbor detail
Neighbor 192.168.5.2, interface address 10.225.200.28
In the area 0 via interface GigabitEthernet1/0/0
Neighbor priority is 1, State is FULL, 6 state changes
DR is 10.225.200.28 BDR is 10.225.200.30
Options is 0x42
LLS Options is 0x1 (LR), last OOB-Resync 00:03:08 ago
Dead timer due in 00:00:36
Neighbor is up for 00:09:46
Index 1/1, retransmission queue length 0, number of retransmission 1
First 0x0(0)/0x0(0) Next 0x0(0)/0x0(0)
Last retransmission scan length is 1, maximum is 1
Last retransmission scan time is 0 msec, maximum is 0 msec
The table below describes the significant fields shown in the displays.
Table 194: show ip ospf neighbor detail Field Descriptions
Field Description
Neighbor Neighbor router ID.
interface address IP address of the interface.
In the area Area and interface through which the OSPF neighbor is known.
Neighbor priority Router priority of the neighbor and neighbor state.
State OSPF state. If one OSPF neighbor has enabled TTL security, the other
side of the connection will show the neighbor in the INIT state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1592
Routing
show ip ospf neighbor
Field Description
state changes Number of state changes since the neighbor was created. This value can
be reset using the clearipospfcountersneighbor command.
DR is Router ID of the designated router for the interface.
BDR is Router ID of the backup designated router for the interface.
Options Hello packet options field contents. (E-bit only. Possible values are 0 and
2; 2 indicates area is not a stub; 0 indicates area is a stub.)
LLS Options..., last OOB-Resync Link-Local Signaling and out-of-band (OOB) link-state database
resynchronization performed hours:minutes:seconds ago. This is nonstop
forwarding (NSF) information. The field indicates the last successful
out-of-band resynchronization with the NSF-capable router.
Dead timer due in Expected time in hours:minutes:seconds before Cisco IOS software will
declare the neighbor dead.
Neighbor is up for Number of hours:minutes:seconds since the neighbor went into the
two-way state.
Index Neighbor location in the area-wide and autonomous system-wide
retransmission queue.
retransmission queue length Number of elements in the retransmission queue.
number of retransmission Number of times update packets have been re-sent during flooding.
First Memory location of the flooding details.
Next Memory location of the flooding details.
Last retransmission scan length Number of link state advertisements (LSAs) in the last retransmission
packet.
maximum Maximum number of LSAs sent in any retransmission packet.
Last retransmission scan time Time taken to build the last retransmission packet.
maximum Maximum time, in milliseconds, taken to build any retransmission packet.
The following is sample output from the show ip ospf neighbor command showing a single line
of summary information for each neighbor. If one OSPF neighbor has enabled TTL security, the
other side of the connection will show the neighbor in the INIT state.
Device#show ip ospf neighbor
Neighbor ID Pri State Dead Time Address Interface
10.199.199.137 1 FULL/DR 0:00:31 192.168.80.37 Ethernet0
172.16.48.1 1 FULL/DROTHER 0:00:33 172.16.48.1 Fddi0
172.16.48.200 1 FULL/DROTHER 0:00:33 172.16.48.200 Fddi0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1593
Routing
show ip ospf neighbor
10.199.199.137 5 FULL/DR 0:00:33 172.16.48.189 Fddi0
172.16.1.201 1 INIT/DROTHER 00.00.35 10.1.1.201 Ethernet0/0
Cisco IOS Release 15.1(3)S
The following sample output from the show ip ospf neighbor command shows the network from
the neighbor’s point of view:
Device#show ip ospf neighbor 192.0.2.1
OSPF Router with ID (192.1.1.1) (Process ID 1)
Area with ID (0)
Neighbor with Router ID 192.0.2.1:
Reachable over:
Ethernet0/0, IP address 192.0.2.1, cost 10
SPF was executed 1 times, distance to computing router 10
Router distance table:
192.1.1.1 i [10]
192.0.2.1 i [0]
192.3.3.3 i [10]
192.4.4.4 i [20]
192.5.5.5 i [20]
Network LSA distance table:
192.2.12.2 i [10]
192.2.13.3 i [20]
192.2.14.4 i [20]
192.2.15.5 i [20]
The following is sample output from the show ip ospf neighbor summary command:
Device#show ip ospf neighbor summary
Neighbor summary for all OSPF processes
DOWN 0
ATTEMPT 0
INIT 0
2WAY 0
EXSTART 0
EXCHANGE 0
LOADING 0
FULL 1
Total count 1 (Undergoing NSF 0)
The following is sample output from the show ip ospf neighbor summary per-instance
command:
Device#show ip ospf neighbor summary
OSPF Router with ID (1.0.0.10) (Process ID 1)
DOWN 0
ATTEMPT 0
INIT 0
2WAY 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1594
Routing
show ip ospf neighbor
EXSTART 0
EXCHANGE 0
LOADING 0
FULL 1
Total count 1 (Undergoing NSF 0)
Neighbor summary for all OSPF processes
DOWN 0
ATTEMPT 0
INIT 0
2WAY 0
EXSTART 0
EXCHANGE 0
LOADING 0
FULL 1
Total count 1 (Undergoing NSF 0)
Table 195: show ip ospf neighbor summary and show ip ospf neighbor summary per-instance Field Descriptions
Field Description
DOWN No information (hellos) has been received from this neighbor, but hello packets can still be
sent to the neighbor in this state.
ATTEMPT This state is only valid for manually configured neighbors in a Non-Broadcast Multi-Access
(NBMA) environment. In Attempt state, the router sends unicast hello packets every poll
interval to the neighbor, from which hellos have not been received within the dead interval.
INIT This state specifies that the router has received a hello packet from its neighbor, but the
receiving router's ID was not included in the hello packet. When a router receives a hello
packet from a neighbor, it should list the sender's router ID in its hello packet as an
acknowledgment that it received a valid hello packet.
2WAY This state designates that bi-directional communication has been established between two
routers.
EXSTART This state is the first step in creating an adjacency between the two neighboring routers. The
goal of this step is to decide which router is active, and to decide upon the initial DD sequence
number. Neighbor conversations in this state or greater are called adjacencies.
EXCHANGE In this state, OSPF routers exchange database descriptor (DBD) packets. Database descriptors
contain link-state advertisement (LSA) headers only and describe the contents of the entire
link-state database. Each DBD packet has a sequence number which can be incremented only
by the active router which is explicitly acknowledged by the secondary router. Routers also
send link-state request packets and link-state update packets (which contain the entire LSA)
in this state. The contents of the DBD received are compared to the information contained in
the routers link-state database to check if new or more current link-state information is available
with the neighbor.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1595
Routing
show ip ospf neighbor
Field Description
LOADING In this state, the actual exchange of link state information occurs. Based on the information
provided by the DBDs, routers send link-state request packets. The neighbor then provides
the requested link-state information in link-state update packets. During the adjacency, if a
device receives an outdated or missing LSA, it requests that LSA by sending a link-state
request packet. All link-state update packets are acknowledged.
FULL In this state, devices are fully adjacent with each other. All the device and network LSAs are
exchanged and the devices' databases are fully synchronized.
Full is the normal state for an OSPF device. If a device is stuck in another state, it's an indication
that there are problems in forming adjacencies. The only exception to this is the 2-way state,
which is normal in a broadcast network. Devices achieve the full state with their DR and BDR
only. Neighbors always see each other as 2-way.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1596
Routing
show ip ospf virtual-links
show ip ospf virtual-links
To display parameters and the current state of Open Shortest Path First (OSPF) virtual links, use the
showipospfvirtual-links command in EXEC mode.
show ip ospf virtual-links
Syntax Description This command has no arguments or keywords.
Command Modes EXEC
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The information displayed by the showipospfvirtual-links command is useful in debugging OSPF routing
operations.
Examples The following is sample output from the showipospfvirtual-links command:
Device#show ip ospf virtual-links
Virtual Link to router 192.168.101.2 is up
Transit area 0.0.0.1, via interface Ethernet0, Cost of using 10
Transmit Delay is 1 sec, State POINT_TO_POINT
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Hello due in 0:00:08
Adjacency State FULL
The table below describes the significant fields shown in the display.
Table 196: show ip ospf virtual-links Field Descriptions
Field Description
Virtual Link to router 192.168.101.2 is up Specifies the OSPF neighbor, and if the link to that neighbor is
up or down.
Transit area 0.0.0.1 The transit area through which the virtual link is formed.
via interface Ethernet0 The interface through which the virtual link is formed.
Cost of using 10 The cost of reaching the OSPF neighbor through the virtual link.
Transmit Delay is 1 sec The transmit delay (in seconds) on the virtual link.
State POINT_TO_POINT The state of the OSPF neighbor.
Timer intervals... The various timer intervals configured for the link.
Hello due in 0:00:08 When the next hello is expected from the neighbor.
Adjacency State FULL The adjacency state between the neighbors.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1597
Routing
summary-address (OSPF)
summary-address (OSPF)
To create aggregate addresses for Open Shortest Path First (OSPF), use the summary-address command in
router configuration mode. To restore the default, use the no form of this command.
summary-address commandsummary-address {ip-address mask | prefix mask} [not-advertise] [tag
tag] [nssa-only]
no summary-address {ip-address mask | prefix mask} [not-advertise] [tag tag] [nssa-only]
Syntax Description ip-address Summary address designated for a range of addresses.
mask IP subnet mask used for the summary route.
prefix IP route prefix for the destination.
not-advertise (Optional) Suppresses routes that match the specified prefix/mask pair. This keyword applies
to OSPF only.
tag tag (Optional) Specifies the tag value that can be used as a “match” value for controlling
redistribution via route maps. This keyword applies to OSPF only.
nssa-only (Optional) Sets the nssa-only attribute for the summary route (if any) generated for the
specified prefix, which limits the summary to not-so-stubby-area (NSSA) areas.
Command Default This command behavior is disabled by default.
Command Modes Router configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines R outes learned from other routing protocols can be summarized. The metric used to advertise the summary
is the lowest metric of all the more specific routes. This command helps reduce the size of the routing table.
Using this command for OSPF causes an OSPF Autonomous System Boundary Router (ASBR) to advertise
one external route as an aggregate for all redistributed routes that are covered by the address. For OSPF, this
command summarizes only routes from other routing protocols that are being redistributed into OSPF. Use
the area range command for route summarization between OSPF areas.
OSPF does not support the summary-address 0.0.0.0 0.0.0.0command.
Examples In the following example, the summary address 10.1.0.0 includes address 10.1.1.0, 10.1.2.0, 10.1.3.0,
and so on. Only the address 10.1.0.0 is advertised in an external link-state advertisement.
Device(config)#summary-address 10.1.0.0 255.255.0.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1598
Routing
summary-address (OSPF)
Related Commands Command Description
area range Consolidates and summarizes routes at an area boundary.
ip ospf authentication-key Assigns a password to be used by neighboring routers that are using the simple
password authentication of OSPF.
ip ospf message-digest-key Enables OSPF MD5 authentication.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1599
Routing
timers throttle spf
timers throttle spf
To turn on Open Shortest Path First ( OSPF) shortest path first (SPF) throttling, use the timers throttle spf
command in the appropriate configuration mode. To turn off OSPF SPF throttling, use the no form of this
command.
timers throttle spf spf-start spf-hold spf-max-wait
no timers throttle spf spf-start spf-hold spf-max-wait
Syntax Description spf-start Initial delay to schedule an SPF calculation after a change, in milliseconds. Range is from
1 to 600000. In OSPF for IPv6, the default value is 5000.
spf-hold Minimum hold time between two consecutive SPF calculations, in milliseconds. Range is
from 1 to 600000. In OSPF for IPv6, the default value is 10,000.
spf-max-wait Maximum wait time between two consecutive SPF calculations, in milliseconds. Range is
from 1 to 600000. In OSPF for IPv6, the default value is 10,000.
Command Default SPF throttling is not set.
Command Modes Address family configuration (config-router-af) Router address family topology configuration
(config-router-af-topology) Router configuration (config-router) OSPF for IPv6 router configuration (config-rtr)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The first wait interval between SPF calculations is the amount of time in milliseconds specified by the
spf-startargument. Each consecutive wait interval is two times the current hold level in milliseconds until the
wait time reaches the maximum time in milliseconds as specified by the spf-max-wait argument. Subsequent
wait times remain at the maximum until the values are reset or a link-state advertisement (LSA) is received
between SPF calculations.
Release 12.2(33)SRB
If you plan to configure the Multi-Topology Routing (MTR) feature, you need to enter the timers throttle
spf command in router address family topology configuration mode in order to make this OSPF router
configuration command become topology-aware.
Release 15.2(1)T
When you configure the ospfv3 network manet command on any interface attached to the OSPFv3 process,
the default values for the spf-start, spf-hold, and the spf-max-wait arguments are reduced to 1000 milliseconds,
1000 milliseconds, and 2000 milliseconds respectively.
Examples The following example shows how to configure a router with the delay, hold, and maximum interval
values for the timers throttle spf command set at 5, 1000, and 90,000 milliseconds, respectively.
router ospf 1
router-id 10.10.10.2
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1600
Routing
timers throttle spf
log-adjacency-changes
timers throttle spf 5 1000 90000
redistribute static subnets
network 10.21.21.0 0.0.0.255 area 0
network 10.22.22.0 0.0.0.255 area 00
The following example shows how to configure a router using IPv6 with the delay, hold, and maximum
interval values for the timers throttle spf command set at 500, 1000, and 10,000 milliseconds,
respectively.
ipv6 router ospf 1
event-log size 10000 one-shot
log-adjacency-changes
timers throttle spf 500 1000 10000
Related Commands Command Description
ospfv3 network manet Sets the network type to Mobile Ad Hoc Network (MANET).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1601
Routing
timers throttle spf
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1602
PA R T XI
Security
• Security, on page 1605
Security
• aaa accounting, on page 1609
• aaa accounting dot1x, on page 1612
• aaa accounting identity, on page 1614
• aaa authentication dot1x, on page 1616
• aaa authorization, on page 1618
• aaa new-model, on page 1622
• access-session mac-move deny, on page 1624
• access-session host-mode multi-host, on page 1626
• action, on page 1628
• api-key (Parameter Map), on page 1629
• authentication host-mode, on page 1630
• authentication logging verbose, on page 1632
• authentication mac-move permit, on page 1633
• authentication priority, on page 1635
• authentication timer reauthenticate, on page 1637
• authentication violation, on page 1639
• cisp enable, on page 1641
• clear aaa cache group, on page 1642
• clear device-tracking database, on page 1643
• clear errdisable interface vlan, on page 1647
• clear fqdn, on page 1648
• clear mac address-table, on page 1649
• confidentiality-offset, on page 1651
• crypto pki trustpool import, on page 1652
• debug aaa cache group, on page 1655
• debug aaa dead-criteria transaction, on page 1656
• debug umbrella, on page 1658
• delay-protection, on page 1659
• deny (MAC access-list configuration), on page 1660
• device-role (IPv6 snooping), on page 1663
• device-role (IPv6 nd inspection), on page 1664
• device-role (IPv6 nd inspection), on page 1665
• device-tracking (interface config), on page 1666
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1605
Security
• device-tracking (VLAN config), on page 1669
• device-tracking binding, on page 1672
• device-tracking logging, on page 1692
• device-tracking policy, on page 1696
• device-tracking tracking, on page 1709
• device-tracking upgrade-cli, on page 1713
• dnscrypt (Parameter Map), on page 1716
• dot1x authenticator eap profile, on page 1717
• dot1x critical (global configuration), on page 1718
• dot1x logging verbose, on page 1719
• dot1x max-start, on page 1720
• dot1x pae, on page 1721
• dot1x supplicant controlled transient, on page 1722
• dot1x supplicant force-multicast, on page 1723
• dot1x test eapol-capable, on page 1724
• dot1x test timeout, on page 1725
• dot1x timeout, on page 1726
• dscp, on page 1728
• dtls, on page 1729
• enable password, on page 1731
• enable secret, on page 1733
• epm access-control open, on page 1736
• fqdn ttl-timeout factor, on page 1737
• include-icv-indicator, on page 1738
• ip access-list, on page 1739
• ip access-list role-based, on page 1742
• ip admission, on page 1743
• ip admission name, on page 1744
• ip dhcp snooping database, on page 1746
• ip dhcp snooping information option format remote-id, on page 1748
• ip dhcp snooping verify no-relay-agent-address, on page 1749
• ip http access-class, on page 1750
• ip radius source-interface, on page 1752
• ip source binding, on page 1754
• ip ssh source-interface, on page 1755
• ip verify source, on page 1756
• ipv6 access-list, on page 1757
• ipv6 snooping policy, on page 1759
• key chain macsec, on page 1760
• key config-key password-encrypt, on page 1761
• key-server, on page 1763
• limit address-count, on page 1764
• local-domain (Parameter Map), on page 1765
• mab logging verbose, on page 1766
• mab request format attribute 32, on page 1767
• macsec-cipher-suite, on page 1769
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1606
Security
• macsec network-link, on page 1771
• match (access-map configuration), on page 1772
• mka pre-shared-key, on page 1774
• mka suppress syslogs sak-rekey, on page 1775
• orgid (Parameter Map), on page 1776
• parameter-map type regex, on page 1777
• parameter-map type umbrella global, on page 1780
• password encryption aes, on page 1781
• pattern (Parameter Map), on page 1783
• permit (MAC access-list configuration), on page 1785
• protocol (IPv6 snooping), on page 1788
• radius server, on page 1789
• radius-server dscp, on page 1791
• radius-server dead-criteria, on page 1792
• radius-server deadtime, on page 1794
• radius-server directed-request, on page 1796
• radius-server domain-stripping, on page 1798
• sak-rekey, on page 1802
• secret (Parameter Map), on page 1803
• security level (IPv6 snooping), on page 1804
• security passthru, on page 1805
• send-secure-announcements, on page 1806
• server-private (RADIUS), on page 1807
• server-private (TACACS+), on page 1809
• show aaa cache group, on page 1811
• show aaa clients, on page 1813
• show aaa command handler, on page 1814
• show aaa dead-criteria, on page 1815
• show aaa local, on page 1817
• show aaa servers, on page 1819
• show aaa sessions, on page 1820
• show access-lists fqdn statistics, on page 1821
• show authentication brief, on page 1822
• show authentication history, on page 1825
• show authentication sessions, on page 1826
• show device-tracking capture-policy, on page 1829
• show device-tracking counters, on page 1831
• show device-tracking database, on page 1833
• show device-tracking events, on page 1838
• show device-tracking features, on page 1840
• show device-tracking messages, on page 1841
• show device-tracking policies, on page 1842
• show device-tracking policy, on page 1843
• show dot1x, on page 1844
• show cisp, on page 1846
• show eap pac peer, on page 1848
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1607
Security
• show fqdn, on page 1849
• show ip access-lists, on page 1851
• show ip dhcp snooping statistics, on page 1854
• show platform software dns-umbrella statistics, on page 1857
• show platform software umbrella switch F0, on page 1858
• show radius server-group, on page 1860
• show storm-control, on page 1862
• show tech-support acl, on page 1864
• show tech-support identity, on page 1868
• show umbrella, on page 1877
• show vlan access-map, on page 1879
• show vlan filter, on page 1880
• show vlan group, on page 1881
• ssci-based-on-sci, on page 1882
• storm-control, on page 1883
• switchport port-security aging, on page 1886
• switchport port-security mac-address, on page 1888
• switchport port-security maximum, on page 1891
• switchport port-security violation, on page 1893
• tacacs server, on page 1895
• tls, on page 1896
• token (Parameter Map), on page 1898
• tracking (IPv6 snooping), on page 1899
• trusted-port, on page 1901
• umbrella, on page 1902
• use-updated-eth-header, on page 1903
• username, on page 1904
• vlan access-map, on page 1909
• vlan dot1Q tag native, on page 1911
• vlan filter, on page 1912
• vlan group, on page 1913
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1608
Security
aaa accounting
aaa accounting
To enable authentication, authorization, and accounting (AAA) accounting of requested services for billing
or security purposes when you use RADIUS or TACACS+, use the aaa accounting command in global
configuration mode. To disable AAA accounting, use the no form of this command.
aaa accounting {auth-proxy | system | network | exec | connections | commands level}
{default | list-name} {start-stop | stop-only | none} [broadcast] group group-name
no aaa accounting {auth-proxy | system | network | exec | connections | commands level}
{default | list-name} {start-stop | stop-only | none} [broadcast] group group-name
Syntax Description auth-proxy Provides information about all authenticated-proxy user events.
system Performs accounting for all system-level events not associated with users, such as reloads.
network Runs accounting for all network-related service requests.
exec Runs accounting for EXEC shell session. This keyword might return user profile
information such as what is generated by the autocommand command.
connection Provides information about all outbound connections made from the network access server.
commands Runs accounting for all commands at the specified privilege level. Valid privilege level
level entries are integers from 0 through 15.
default Uses the listed accounting methods that follow this argument as the default list of methods
for accounting services.
list-name Character string used to name the list of at least one of the accounting methods described
in
start-stop Sends a "start" accounting notice at the beginning of a process and a "stop" accounting
notice at the end of a process. The "start" accounting record is sent in the background. The
requested user process begins regardless of whether the "start" accounting notice was
received by the accounting server.
stop-only Sends a "stop" accounting notice at the end of the requested user process.
none Disables accounting services on this line or interface.
broadcast (Optional) Enables sending accounting records to multiple AAA servers. Simultaneously
sends accounting records to the first server in each group. If the first server is unavailable,
fail over occurs using the backup servers defined within that group.
group At least one of the keywords described in the AAA Accounting Methods table.
groupname
Command Default AAA accounting is disabled.
Command Modes Global configuration (config)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1609
Security
aaa accounting
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the aaa accounting command to enable accounting and to create named method lists defining specific
accounting methods on a per-line or per-interface basis.
Table 197: AAA Accounting Methods
Keyword Description
group radius Uses the list of all RADIUS servers for authentication
as defined by the aaa group server radius command.
group tacacs+ Uses the list of all TACACS+ servers for authentication
as defined by the aaa group server tacacs+ command.
group group-name Uses a subset of RADIUS or TACACS+ servers for
accounting as defined by the server group group-name.
In AAA Accounting Methods table, the group radius and group tacacs+ methods refer to a set of previously
defined RADIUS or TACACS+ servers. Use the radius server and tacacs server commands to configure
the host servers. Use the aaa group server radius and aaa group server tacacs+ commands to create a
named group of servers.
Cisco IOS XE software supports the following two methods of accounting:
• RADIUS—The network access server reports user activity to the RADIUS security server in the form
of accounting records. Each accounting record contains accounting attribute-value (AV) pairs and is
stored on the security server.
• TACACS+—The network access server reports user activity to the TACACS+ security server in the
form of accounting records. Each accounting record contains accounting attribute-value (AV) pairs and
is stored on the security server.
Method lists for accounting define the way accounting will be performed. Named accounting method lists
enable you to designate a particular security protocol to be used on specific lines or interfaces for particular
types of accounting services. Create a list by entering the list-name and the method , where list-name is any
character string used to name this list (excluding the names of methods, such as radius or tacacs+) and method
identifies the methods to be tried in sequence as given.
If the aaa accounting command for a particular accounting type is issued without a named method list
specified, the default method list is automatically applied to all interfaces or lines (where this accounting type
applies) except those that have a named method list explicitly defined. (A defined method list overrides the
default method list.) If no default method list is defined, then no accounting takes place.
Note System accounting does not use named accounting lists; you can only define the default list for system
accounting.
For minimal accounting, include the stop-only keyword to send a stop record accounting notice at the end
of the requested user process. For more accounting, you can include the start-stop keyword, so that RADIUS
or TACACS+ sends a start accounting notice at the beginning of the requested process and a stop accounting
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1610
Security
aaa accounting
notice at the end of the process. Accounting is stored only on the RADIUS or TACACS+ server. The none
keyword disables accounting services for the specified line or interface.
When AAA accounting is activated, the network access server monitors either RADIUS accounting attributes
or TACACS+ AV pairs pertinent to the connection, depending on the security method you have implemented.
The network access server reports these attributes as accounting records, which are then stored in an accounting
log on the security server.
Note This command cannot be used with TACACS or extended TACACS.
This example defines a default commands accounting method list, where accounting services are
provided by a TACACS+ security server, set for privilege level 15 commands with a stop-only
restriction:
Device> enable
Device# configure terminal
Device(config)# aaa accounting commands 15 default stop-only group TACACS+
Device(config)# exit
This example defines a default auth-proxy accounting method list, where accounting services are
provided by a TACACS+ security server with a stop-only restriction. The aaa accounting commands
activates authentication proxy accounting.
Device> enable
Device# configure terminal
Device(config)# aaa new model
Device(config)# aaa authentication login default group TACACS+
Device(config)# aaa authorization auth-proxy default group TACACS+
Device(config)# aaa accounting auth-proxy default start-stop group TACACS+
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1611
Security
aaa accounting dot1x
aaa accounting dot1x
To enable authentication, authorization, and accounting (AAA) accounting and to create method lists defining
specific accounting methods on a per-line or per-interface basis for IEEE 802.1x sessions, use the aaa
accounting dot1xcommand in global configuration mode. To disable IEEE 802.1x accounting, use the no
form of this command.
aaa accounting dot1x {name | default } start-stop {broadcast group {name | radius | tacacs+}
[group {name | radius | tacacs+} ... ] | group {name | radius | tacacs+} [group
{name | radius | tacacs+}... ]}
no aaa accounting dot1x {name | default }
Syntax Description name Name of a server group. This is optional when you enter it after the broadcast group and group
keywords.
default Specifies the accounting methods that follow as the default list for accounting services.
start-stop Sends a start accounting notice at the beginning of a process and a stop accounting notice at the
end of a process. The start accounting record is sent in the background. The requested user
process begins regardless of whether or not the start accounting notice was received by the
accounting server.
broadcast Enables accounting records to be sent to multiple AAA servers and sends accounting records
to the first server in each group. If the first server is unavailable, the device uses the list of
backup servers to identify the first server.
group Specifies the server group to be used for accounting services. These are valid server group
names:
• name — Name of a server group.
• radius — Lists of all RADIUS hosts.
• tacacs+ — Lists of all TACACS+ hosts.
The group keyword is optional when you enter it after the broadcast group and group keywords.
You can enter more than optional group keyword.
radius (Optional) Enables RADIUS accounting.
tacacs+ (Optional) Enables TACACS+ accounting.
Command Default AAA accounting is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1612
Security
aaa accounting dot1x
Usage Guidelines This command requires access to a RADIUS server.
We recommend that you enter the dot1x reauthentication interface configuration command before configuring
IEEE 802.1x RADIUS accounting on an interface.
This example shows how to configure IEEE 802.1x accounting:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# aaa accounting dot1x default start-stop group radius
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1613
Security
aaa accounting identity
aaa accounting identity
To enable authentication, authorization, and accounting (AAA) accounting for IEEE 802.1x, MAC
authentication bypass (MAB), and web authentication sessions, use the aaa accounting identity command
in global configuration mode. To disable IEEE 802.1x accounting, use the no form of this command.
aaa accounting identity {name | default } start-stop {broadcast group {name | radius | tacacs+}
[group {name | radius | tacacs+} ... ] | group {name | radius | tacacs+} [group
{name | radius | tacacs+}... ]}
no aaa accounting identity {name | default }
Syntax Description name Name of a server group. This is optional when you enter it after the broadcast group and group
keywords.
default Uses the accounting methods that follow as the default list for accounting services.
start-stop Sends a start accounting notice at the beginning of a process and a stop accounting notice at the
end of a process. The start accounting record is sent in the background. The requested-user
process begins regardless of whether or not the start accounting notice was received by the
accounting server.
broadcast Enables accounting records to be sent to multiple AAA servers and send accounting records to
the first server in each group. If the first server is unavailable, the switch uses the list of backup
servers to identify the first server.
group Specifies the server group to be used for accounting services. These are valid server group
names:
• name — Name of a server group.
• radius — Lists of all RADIUS hosts.
• tacacs+ — Lists of all TACACS+ hosts.
The group keyword is optional when you enter it after the broadcast group and group keywords.
You can enter more than optional group keyword.
radius (Optional) Enables RADIUS authorization.
tacacs+ (Optional) Enables TACACS+ accounting.
Command Default AAA accounting is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To enable AAA accounting identity, you need to enable policy mode. To enable policy mode, enter the
authentication display new-style command in privileged EXEC mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1614
Security
aaa accounting identity
This example shows how to configure IEEE 802.1x accounting identity:
Device# authentication display new-style
Please note that while you can revert to legacy style
configuration at any time unless you have explicitly
entered new-style configuration, the following caveats
should be carefully read and understood.
(1) If you save the config in this mode, it will be written
to NVRAM in NEW-style config, and if you subsequently
reload the router without reverting to legacy config and
saving that, you will no longer be able to revert.
(2) In this and legacy mode, Webauth is not IPv6-capable. It
will only become IPv6-capable once you have entered new-
style config manually, or have reloaded with config saved
in 'authentication display new' mode.
Device# configure terminal
Device(config)# aaa accounting identity default start-stop group radius
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1615
Security
aaa authentication dot1x
aaa authentication dot1x
To specify one or more authentication, authorization, and accounting (AAA) methods for use on interfaces
running IEEE 802.1x, use the aaa authentication dot1x command in global configuration mode. To disable
authentication, use the no form of this command
aaa authentication dot1x { default listname } method1 [ method2 . . . ]
no aaa authentication dot1x { default listname } method1 [ method2 . . . ]
Syntax Description default Uses the listed authentication methods that follow this argument as the default list of
methods when a user logs in.
listname Character string used to name the list of authentication methods tried when a user logs in.
method1 A method can be least one of these keywords:
[method2...]
• enable: Uses the enable password for authentication.
• group radius: Uses the list of all the RADIUS servers for authentication.
• line: Uses the line password for authentication.
• local: Uses the local username database for authentication.
• local-case: Uses the case-sensitive local username database for authentication.
• none: Uses no authentication. The client is automatically authenticated by the device
without using the information supplied by the client.
• group radius-server-group-name: Uses the group RADIUS server for authentication.
• cache radius-server-group-name: Uses the cache RADIUS server for authentication.
Note You must configure the AAA authentication method list with both group
radius-server-group-name and cache radius-server-group-name to use AAA
cache-based authentication. For more information, see "Updating
Authorization and Authentication Method Lists to Specify How Cache
Information is Used" procedure of the "Configuring AAA Authorization and
Authentication Cache" configuration guide.
Command Default No authentication is performed.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 This command was modified. The cache keyword was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1616
Security
aaa authentication dot1x
Usage Guidelines The method argument identifies the list of methods that the authentication algorithm runs in the given sequence
to validate the password provided by the client. The only method that is truly 802.1x-compliant is the group
radius method, in which the client data is validated against a RADIUS authentication server. The remaining
methods enable AAA to authenticate the client by using locally configured data. For example, the local and
local-case methods use the username and password that are saved in the Cisco IOS configuration file. The
enable and line methods use the enable and line passwords for authentication.
If you specify group radius, you must configure the RADIUS server by entering the radius server server-name
global configuration command. If you are not using a RADIUS server, you can use the local or local-case
methods, which access the local username database to perform authentication. By specifying the enable or
line methods, you can supply the client with a password to provide access to the device.
Use the show running-config privileged EXEC command to display the configured lists of authentication
methods.
Examples The following example shows how to enable AAA and how to create an authentication list for 802.1x:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# aaa group server radius RASERV
Device(config)# server name RASERV-1
Device(config)# aaa authentication dot1x default group RASERV
Related Commands Command Description
debug dot1x Displays 802.1x debugging information.
identity profile default Creates an identity profile and enters dot1x profile configuration mode.
show dot1x Displays details for an identity profile.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1617
Security
aaa authorization
aaa authorization
To set the parameters that restrict user access to a network, use the aaa authorization command in global
configuration mode. To remove the parameters, use the no form of this command.
aaa authorization { auth-proxy | cache | commands level | config-commands | configuration
| console | credential-download | exec | multicast | network | reverse-access |template}
{default | list_name } [method1 [ method2 ...]]
no aaa authorization { auth-proxy | cache | commands level | config-commands | configuration
| console | credential-download | exec | multicast | network | reverse-access |template}
{default | list_name } [method1 [ method2 ...]]
Syntax Description auth-proxy Runs authorization for authentication proxy services.
cache Configures the authentication, authorization, and accounting (AAA)
server.
commands Runs authorization for all commands at the specified privilege level.
level Specific command level that should be authorized. Valid entries are
0 through 15.
config-commands Runs authorization to determine whether commands entered in
configuration mode are authorized.
configuration Downloads the configuration from the AAA server.
console Enables the console authorization for the AAA server.
credential-download Downloads EAP credential from Local/RADIUS/LDAP.
exec Enables the console authorization for the AAA server.
multicast Downloads the multicast configuration from the AAA server.
network Runs authorization for all network-related service requests, including
Serial Line Internet Protocol (SLIP), PPP, PPP Network Control
Programs (NCPs), and AppleTalk Remote Access (ARA).
reverse-access Runs authorization for reverse access connections, such as reverse
Telnet.
template Enables template authorization for the AAA server.
default Uses the listed authorization methods that follow this keyword as
the default list of methods for authorization.
list_name Character string used to name the list of authorization methods.
method1 [method2...] (Optional) An authorization method or multiple authorization
methods to be used for authorization. A method may be any one of
the keywords listed in the table below.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1618
Security
aaa authorization
Command Default Authorization is disabled for all actions (equivalent to the method keyword none).
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the aaa authorization command to enable authorization and to create named methods lists, which define
authorization methods that can be used when a user accesses the specified function. Method lists for
authorization define the ways in which authorization will be performed and the sequence in which these
methods will be performed. A method list is a named list that describes the authorization methods (such as
RADIUS or TACACS+) that must be used in sequence. Method lists enable you to designate one or more
security protocols to be used for authorization, which ensures a backup system in case the initial method fails.
Cisco IOS XE software uses the first method listed to authorize users for specific network services; if that
method fails to respond, the Cisco IOS XE software selects the next method listed in the method list. This
process continues until there is successful communication with a listed authorization method, or until all the
defined methods are exhausted.
Note The Cisco IOS XE software attempts authorization with the next listed method only when there is no response
from the previous method. If authorization fails at any point in this cycle--meaning that the security server or
the local username database responds by denying the user services--the authorization process stops and no
other authorization methods are attempted.
If the aaa authorization command for a particular authorization type is issued without a specified named
method list, the default method list is automatically applied to all interfaces or lines (where this authorization
type applies) except those that have a named method list explicitly defined. (A defined method list overrides
the default method list.) If no default method list is defined, then no authorization takes place. The default
authorization method list must be used to perform outbound authorization, such as authorizing the download
of IP pools from the RADIUS server.
Use the aaa authorization command to create a list by entering the values for the list-name and the method
arguments, where list-name is any character string used to name this list (excluding all method names) and
method identifies the list of authorization methods tried in the given sequence.
Note In the table that follows, the groupgroup-name, group ldap, group radius, and group tacacs+ methods refer
to a set of previously defined RADIUS or TACACS+ servers. Use the radius server and tacacs server
commands to configure the host servers. Use the aaa group server radius, aaa group server ldap, and aaa
group server tacacs+ commands to create a named group of servers.
This table describes the method keywords.
Table 198: aaa authorization Methods
Keyword Description
cache group-name Uses a cache server group for authorization.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1619
Security
aaa authorization
Keyword Description
group group-name Uses a subset of RADIUS or TACACS+ servers for
accounting as defined by the server group
group-name command.
group ldap Uses the list of all Lightweight Directory Access
Protocol (LDAP) servers for authentication.
group radius Uses the list of all RADIUS servers for authentication
as defined by the aaa group server radius command.
grouptacacs+ Uses the list of all TACACS+ servers for
authentication as defined by the aaa group server
tacacs+ command.
if-authenticated Allows the user to access the requested function if the
user is authenticated.
Note The if-authenticated method is a
terminating method. Therefore, if it is
listed as a method, any methods listed
after it will never be evaluated.
local Uses the local database for authorization.
none Indicates that no authorization is performed.
Cisco IOS XE software supports the following methods for authorization:
• Cache Server Groups—The device consults its cache server groups to authorize specific rights for users.
• If-Authenticated—The user is allowed to access the requested function provided the user has been
authenticated successfully.
• Local—The device consults its local database, as defined by the username command, to authorize
specific rights for users. Only a limited set of functions can be controlled through the local database.
• None—The network access server does not request authorization information; authorization is not
performed over this line or interface.
• RADIUS—The network access server requests authorization information from the RADIUS security
server group. RADIUS authorization defines specific rights for users by associating attributes, which are
stored in a database on the RADIUS server, with the appropriate user.
• TACACS+—The network access server exchanges authorization information with the TACACS+ security
daemon. TACACS+ authorization defines specific rights for users by associating attribute-value (AV)
pairs, which are stored in a database on the TACACS+ security server, with the appropriate user.
Method lists are specific to the type of authorization being requested. AAA supports five different types of
authorization:
• Commands—Applies to the EXEC mode commands a user issues. Command authorization attempts
authorization for all EXEC mode commands, including global configuration commands, associated with
a specific privilege level.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1620
Security
aaa authorization
• EXEC—Applies to the attributes associated with a user EXEC terminal session.
• Network—Applies to network connections. The network connections can include a PPP, SLIP, or ARA
connection.
• Reverse Access—Applies to reverse Telnet sessions.
• Configuration—Applies to the configuration downloaded from the AAA server.
When you create a named method list, you are defining a particular list of authorization methods for the
indicated authorization type.
Once defined, the method lists must be applied to specific lines or interfaces before any of the defined methods
are performed.
The authorization command causes a request packet containing a series of AV pairs to be sent to the RADIUS
or TACACS daemon as part of the authorization process. The daemon can do one of the following:
• Accept the request as is.
• Make changes to the request.
• Refuse the request and authorization.
For a list of supported RADIUS attributes, see the module RADIUS Attributes. For a list of supported
TACACS+ AV pairs, see the module TACACS+ Attribute-Value Pairs.
Note Five commands are 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 in the privilege
level command set.
The following example shows how to define the network authorization method list named mygroup,
which specifies that RADIUS authorization will be used on serial lines using PPP. If the RADIUS
server fails to respond, local network authorization will be performed.
Device> enable
Device# configure terminal
Device(config)# aaa authorization network mygroup group radius local
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1621
Security
aaa new-model
aaa new-model
To enable the authentication, authorization, and accounting (AAA) access control model, issue the aaa
new-model command in global configuration mode. To disable the AAA access control model, use the no
form of this command.
aaa new-model
no aaa new-model
Syntax Description This command has no arguments or keywords.
Command Default AAA is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command enables the AAA access control system.
If the login local command is configured for a virtual terminal line (VTY), and the aaa new-model command
is removed, you must reload the switch to get the default configuration or the login command. If the switch
is not reloaded, the switch defaults to the login local command under the VTY.
Note We do not recommend removing the aaa new-model command.
Examples The following example initializes AAA:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# exit
The following example shows a VTY configured and the aaa new-model command removed:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# line vty 0 15
Device(config-line)# login local
Device(config-line)# exit
Device(config)# no aaa new-model
Device(config)# exit
Device# show running-config | b line vty
line vty 0 4
login local !<=== Login local instead of "login"
line vty 5 15
login local
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1622
Security
aaa new-model
Related Commands Command Description
aaa accounting Enables AAA accounting of requested services for billing or security
purposes.
aaa authentication arap Enables an AAA authentication method for ARAP using TACACS+.
aaa authentication enable default Enables AAA authentication to determine if a user can access the
privileged command level.
aaa authentication login Sets AAA authentication at login.
aaa authentication ppp Specifies one or more AAA authentication method for use on serial
interfaces running PPP.
aaa authorization Sets parameters that restrict user access to a network.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1623
Security
access-session mac-move deny
access-session mac-move deny
To disable MAC move on a device, use the access-session mac-move deny global configuration command.
To return to the default setting, use the no form of this command.
access-session mac-move deny
no access-session mac-move deny
Syntax Description This command has no arguments or keywords.
Command Default MAC move is enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The no form of this command enables authenticated hosts to move between any authentication-enabled ports
(MAC authentication bypass [MAB], 802.1x, or Web-auth) on a device. For example, if there is a device
between an authenticated host and port, and that host moves to another port, the authentication session is
deleted from the first port, and the host is reauthenticated on the new port.
If MAC move is disabled, and an authenticated host moves to another port, it is not reauthenticated, and a
violation error occurs.
This example shows how to enable MAC move on a device:
Device> enable
Device# configure terminal
Device(config)# no access-session mac-move deny
Device(config)# exit
Related Commands Command Description
authentication event Sets the action for specific authentication events.
authentication fallback Configures a port to use web authentication as a fallback meth
authentication.
authentication host-mode Sets the authorization manager mode on a port.
authentication open Enables or disables open access on a port.
authentication order Sets the order of authentication methods used on a port.
authentication periodic Enables or disables reauthentication on a port.
authentication port-control Enables manual control of the port authorization state.
authentication priority Adds an authentication method to the port-priority list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1624
Security
access-session mac-move deny
Command Description
authentication timer Configures the timeout and reauthentication parameters fo
authentication violation Configures the violation modes that occur when a new dev
to a port with the maximum number of devices already co
show authentication Displays information about authentication manager events
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1625
Security
access-session host-mode multi-host
access-session host-mode multi-host
To allow hosts to gain access to a controlled port only after the first client is authenticated, use the
access-session host-mode multi-host command in interface configuration mode. To return to the default
value, use the no form of this command.
access-session host-mode multi-host [ peer ]
no access-session host-mode multi-host [ peer ]
Syntax Description peer Specifies that only a peer device can be authenticated first.
Command Default Access to a port is multi-auth, wherein multiple clients can be authenticated on the port.
Command Modes Interface Configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Cupertino 17.7.1 The keyword peer was added.
Usage Guidelines Before you use this command, you must enable the access-session port-control auto command.
In multi-host mode, only one of the attached hosts has to be successfully authorized for all hosts to be granted
network access. If the port becomes unauthorized (reauthentication fails or an Extensible Authentication
Protocol over LAN (EAPOL) logoff message is received), all attached clients are denied access to the network.
Starting Cisco IOS XE Release 17.7.1, you can enable a peer device to be authenticated first, using the
access-session host-mode multi-host peer command.
Consider a Cisco SD-Access fabric network where an extended node and its clients have to be securely
onboarded. We must ensure that until the extended node is authenticated, the clients connected to it do not
have access to the network. In such a case, use the access-session host-mode multi-host peer command to
authenticate the extended node first. (The extended node is the peer device that is connected to the authenticator
port.) Cisco ISE pushes this CLI through an interface template that is applied to the fabric edge node for IEEE
802.1X authentication. A change in the host mode clears all the existing sessions on the fabric edge. We
recommend enabling the access-session interface-template sticky timer command in the global configuration
mode to avoid the template from getting unbound from the edge node port. The sticky timer value should be
a minimum of 60 seconds to avoid the bind–unbind loop issues. The interface template is unbound after the
sticky timer expires.
Similarly, in cases where trunk ports are connected to the access device, use the access-session host-mode
multi-host peer command to authenticate only the peer MAC. This avoids authenticating all the MAC
addresses learnt.
Note The keyword peer is supported only in the fabric edge mode. It is not supported in the legacy mode.
The peer configuration clears all the existing sessions on the authenticator port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1626
Security
access-session host-mode multi-host
You can use the show access-session interface command to verify the port setting.
Example
The following example shows how to enable authorization of only the peer device on port1/0/2.
Device# configure terminal
Device(config)# interface GigabitEthernet 1/0/2
Device(config-if)# access-session host-mode multi-host peer
Device(config-if)# access-session closed
Device(config-if)# access-session port-control auto
Related Commands access-session closed Prevents preauthentication access on a port.
access-session port-control Sets the authorization state of a port.
show access-session Displays information about authentication sessions.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1627
Security
action
action
To set the action for the VLAN access map entry, use the action command in access-map configuration mode.
To return to the default setting, use the no form of this command.
action{drop | forward}
no action
Syntax Description drop Drops the packet when the specified conditions are matched.
forward Forwards the packet when the specified conditions are matched.
Command Default The default action is to forward packets.
Command Modes Access-map configuration (config-access-map)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You enter access-map configuration mode by using the vlan access-map global configuration command.
If the action is drop, you should define the access map, including configuring any access control list (ACL)
names in match clauses, before applying the map to a VLAN, or all packets could be dropped.
In access-map configuration mode, use the match access-map configuration command to define the match
conditions for a VLAN map. Use the action command to set the action that occurs when a packet matches
the conditions.
The drop and forward parameters are not used in the no form of the command.
You can verify your settings by entering the show vlan access-map privileged EXEC command.
Examples This example shows how to identify and apply a VLAN access map (vmap4) to VLANs 5 and 6 that
causes the VLAN to forward an IP packet if the packet matches the conditions defined in access list
al2:
Device> enable
Device# configure terminal
Device(config)# vlan access-map vmap4
Device(config-access-map)# match ip address al2
Device(config-access-map)# action forward
Device(config-access-map)# exit
Device(config)# vlan filter vmap4 vlan-list 5-6
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1628
Security
api-key (Parameter Map)
api-key (Parameter Map)
To configure the application programming interface (API) key used for authorization during device registration,
use the api-key command in parameter-map type inspect configuration mode. To remove the key, use the no
form of this command.
api-key value
no api-key
Syntax Description value The API key. You can obtain this from the Cisco Umbrella
registration server.
Command Default No key is created for the parameter map.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Cupertino 17.7.1 This command was introduced.
Usage Guidelines To perform API registration for the Umbrella Switch Connector, the api-key, orgid and secret commands
must be configured one after the other. The values for these commands can be retrieved from the Cisco
Umbrella registration server.
Examples The following example shows how to perform API registration for the Umbrella Switch Connector:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)# api-key 5f22922exxxxxxxxx51174af822734
Device(config-profile)# orgid 26xxx16
Device(config-profile)# secret 0 a0d176ebxxxxxxxfbb343dfc4fd209
Device(config-profile)# end
Related Commands Command Description
parameter-map type umbrella global Configures a parameter-map type in umbrella mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1629
Security
authentication host-mode
authentication host-mode
To set the authorization manager mode on a port, use the authentication host-mode command in interface
configuration mode. To return to the default setting, use the no form of this command.
authentication host-mode {multi-auth | multi-domain | multi-host | single-host}
no authentication host-mode
Syntax Description multi-auth Enables multiple-authorization mode (multi-auth mode) on the
port.
multi-domain Enables multiple-domain mode on the port.
multi-host Enables multiple-host mode on the port.
single-host Enables single-host mode on the port.
Command Default Single host mode is enabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Single-host mode should be configured if only one data host is connected. Do not connect a voice device to
authenticate on a single-host port. Voice device authorization fails if no voice VLAN is configured on the
port.
Multi-domain mode should be configured if data host is connected through an IP phone to the port.
Multi-domain mode should be configured if the voice device needs to be authenticated.
Multi-auth mode should be configured to allow devices behind a hub to obtain secured port access through
individual authentication. Only one voice device can be authenticated in this mode if a voice VLAN is
configured.
Multi-host mode also offers port access for multiple hosts behind a hub, but multi-host mode gives unrestricted
port access to the devices after the first user gets authenticated.
This example shows how to enable multi-auth mode on a port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication host-mode multi-auth
Device(config-if)# end
This example shows how to enable multi-domain mode on a port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication host-mode multi-domain
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1630
Security
authentication host-mode
This example shows how to enable multi-host mode on a port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication host-mode multi-host
Device(config-if)# end
This example shows how to enable single-host mode on a port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication host-mode single-host
Device(config-if)# end
You can verify your settings by entering the show authentication sessions interface interface
details privileged EXEC command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1631
Security
authentication logging verbose
authentication logging verbose
To filter detailed information from authentication system messages, use the authentication logging verbose
command in global configuration mode on the switch stack or on a standalone switch.
authentication logging verbose
no authentication logging verbose
Syntax Description This command has no arguments or keywords.
Command Default Detailed logging of system messages is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command filters details, such as anticipated success, from authentication system messages. Failure
messages are not filtered.
To filter verbose authentication system messages:
Device> enable
Device# configure terminal
Device(config)# authentication logging verbose
Device(config)# exit
You can verify your settings by entering the show running-config privileged EXEC command.
Related Commands Command Description
authentication logging verbose Filters details fro
dot1x logging verbose Filters details fro
mab logging verbose Filters details fro
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1632
Security
authentication mac-move permit
authentication mac-move permit
To enable MAC move on a device, use the authentication mac-move permit command in global
configuration mode. To disable MAC move, use the no form of this command.
authentication mac-move permit
no authentication mac-move permit
Syntax Description This command has no arguments or keywords.
Command Default MAC move is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The command enables authenticated hosts to move between any authentication-enabled ports (MAC
authentication bypass [MAB], 802.1x, or Web-auth) on a device. For example, if there is a device between
an authenticated host and port, and that host moves to another port, the authentication session is deleted from
the first port, and the host is reauthenticated on the new port.
If MAC move is disabled, and an authenticated host moves to another port, it is not reauthenticated, and a
violation error occurs.
This example shows how to enable MAC move on a device:
Device> enable
Device# configure terminal
Device(config)# authentication mac-move permit
Device(config)# exit
Related Commands Command Description
access-session mac-move deny Disables MAC move on a device.
authentication event Sets the action for specific authentication events
authentication fallback Configures a port to use web authentication as a
IEEE 802.1x authentication.
authentication host-mode Sets the authorization manager mode on a port.
authentication open Enables or disables open access on a port.
authentication order Sets the order of authentication methods used on
authentication periodic Enable or disables reauthentication on a port.
authentication port-control Enables manual control of the port authorization
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1633
Security
authentication mac-move permit
Command Description
authentication priority Adds an authentication method to the port-priority li
authentication timer Configures the timeout and reauthentication parame
authentication violation Configures the violation modes that occur when a ne
device connects to a port with the maximum number
show authentication Displays information about authentication manager
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1634
Security
authentication priority
authentication priority
To add an authentication method to the port-priority list, use the authentication priority command in interface
configuration mode. To return to the default, use the no form of this command.
authentication priority [dot1x | mab] {webauth}
no authentication priority [dot1x | mab] {webauth}
Syntax Description dot1x (Optional) Adds 802.1x to the order of authentication methods.
mab (Optional) Adds MAC authentication bypass (MAB) to the order of authenti
methods.
webauth Adds web authentication to the order of authentication methods.
Command Default The default priority is 802.1x authentication, followed by MAC authentication bypass and web authentication.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Ordering sets the order of methods that the device attempts when trying to authenticate a new device is
connected to a port.
When configuring multiple fallback methods on a port, set web authentication (webauth) last.
Assigning priorities to different authentication methods allows a higher-priority method to interrupt an
in-progress authentication method with a lower priority.
Note If a client is already authenticated, it might be reauthenticated if an interruption from a higher-priority method
occurs.
The default priority of an authentication method is equivalent to its position in execution-list order: 802.1x
authentication, MAC authentication bypass (MAB), and web authentication. Use the dot1x, mab, and webauth
keywords to change this default order.
This example shows how to set 802.1x as the first authentication method and web authentication as
the second authentication method:
Device(config-if)# authentication priority dot1x webauth
This example shows how to set MAB as the first authentication method and web authentication as
the second authentication method:
Device> enable
Device# configure terminal
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1635
Security
authentication priority
Device(config)# interface gigabitethernet 0/1/2
Device(config-if)# authentication priority mab webauth
Device(config-if)# end
Related Commands Command Description
authentication control-direction Configures the port mode as unidirectional or bidirectional.
authentication event fail Specifies how the Auth Manager handles authentication failures as a r
authentication event no-response action Specifies how the Auth Manager handles authentication failures as a r
authentication event server alive action Reinitializes an authorized Auth Manager session when a previously u
reinitialize and accounting server becomes available.
authentication event server dead action Authorizes Auth Manager sessions when the authentication, authoriza
authorize unreachable.
authentication fallback Enables a web authentication fallback method.
authentication host-mode Allows hosts to gain access to a controlled port.
authentication open Enables open access on a port.
authentication order Specifies the order in which the Auth Manager attempts to authenticat
authentication periodic Enables automatic reauthentication on a port.
authentication port-control Configures the authorization state of a controlled port.
authentication timer inactivity Configures the time after which an inactive Auth Manager session is t
authentication timer reauthenticate Specifies the period of time between which the Auth Manager attemp
authentication timer restart Specifies the period of time after which the Auth Manager attempts to
authentication violation Specifies the action to be taken when a security violation occurs on a
mab Enables MAC authentication bypass on a port.
show authentication registrations Displays information about the authentication methods that are registe
show authentication sessions Displays information about current Auth Manager sessions.
show authentication sessions interface Displays information about the Auth Manager for a given interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1636
Security
authentication timer reauthenticate
authentication timer reauthenticate
To specify the period of time between which the Auth Manager attempts to reauthenticate authorized ports,
use the authenticationtimerreauthenticate command in interface configuration or template configuration
mode. To reset the reauthentication interval to the default, use the no form of this command.
authentication timer reauthenticate { seconds | server }
no authentication timer reauthenticate
Syntax Description seconds The number of seconds between reauthentication attempts. The range is from 1 to 1073741823.
The default is 3600 seconds.
server Specifies that the interval between reauthentication attempts is defined by the Session-Timeout
value (RADIUS Attribute 27) on the authentication, authorization, and accounting (AAA) server.
Command Default The automatic reauthentication interval is set to 3600 seconds.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced
Cisco IOS XE Bengaluru 17.5.1 The supported time-out range was increased from 65535 seconds to
1073741823 seconds
Usage Guidelines Use the command authenticationtimer reauthenticate command to set the automatic reauthentication
interval of an authorized port. If you use the authenticationtimerinactivity command to configure an
inactivity interval, configure the reauthentication interval to be longer than the inactivity interval.
In releases prior to Cisco IOS XE Bengaluru 17.5.1, the supported timeout range is 1 to 65535 seconds. While
downgrading from or releases after Cisco IOS XE Bengaluru 17.5.1 set the configuration timeout to supported
values to avoid ISSD breakage.
Examples The following example shows how to set the reauthentication interval on a port to 1800 seconds:
Device >enable
Device #configure terminal
Device(config)#interface gigabitethernet2/0/1
Device(config-if)#authentication timer reauthenticate 1800
Device(config-if)#end
Related Commands Command Description
authenticationperiodic Enables automatic reauthentication.
authenticationtimerinactivity Specifies the interval after which the Auth Manager ends an inactive
session.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1637
Security
authentication timer reauthenticate
Command Description
authenticationtimerrestart Specifies the interval after which the Auth Manager attempts to authenticate
an unauthorized port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1638
Security
authentication violation
authentication violation
To configure the violation modes that occur when a new device connects to a port or when a new device
connects to a port after the maximum number of devices are connected to that port, use the authentication
violation command in interface configuration mode.
authentication violation{ protect|replace|restrict|shutdown }
no authentication violation{ protect|replace|restrict|shutdown }
Syntax Description protect Drops unexpected incoming MAC addresses. No syslog errors are
generated.
replace Removes the current session and initiates authentication with the
new host.
restrict Generates a syslog error when a violation error occurs.
shutdown Error-disables the port or the virtual port on which an unexpected
MAC address occurs.
Command Default Authentication violation shutdown mode is enabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the authentication violation command to specify the action to be taken when a security violation occurs
on a port.
This example shows how to configure an IEEE 802.1x-enabled port as error-disabled and to shut
down when a new device connects it:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication violation shutdown
Device(config-if)# end
This example shows how to configure an 802.1x-enabled port to generate a system error message
and to change the port to restricted mode when a new device connects to it:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication violation restrict
Device(config-if)# end
This example shows how to configure an 802.1x-enabled port to ignore a new device when it connects
to the port:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1639
Security
authentication violation
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication violation protect
Device(config-if)# end
This example shows how to configure an 802.1x-enabled port to remove the current session and
initiate authentication with a new device when it connects to the port:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 2/0/1
Device(config-if)# authentication violation replace
Device(config-if)# end
You can verify your settings by entering the show running-config interface interface-name command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1640
Security
cisp enable
cisp enable
To enable Client Information Signaling Protocol (CISP) on a device so that it acts as an authenticator to a
supplicant device and a supplicant to an authenticator device, use the cisp enable global configuration
command.
cisp enable
no cisp enable
Syntax Description This command has no arguments or keywords.
Command Default No default behavior or values.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The link between the authenticator and supplicant device is a trunk. When you enable VTP on both devices,
the VTP domain name must be the same, and the VTP mode must be server.
To avoid the MD5 checksum mismatch error when you configure VTP mode, verify that:
• VLANs are not configured on two different devices, which can be caused by two VTP servers in the
same domain.
• Both devices have different configuration revision numbers.
This example shows how to enable CISP:
Device> enable
Device# configure terminal
Device(config)# cisp enable
Device(config)# exit
Related Commands Command Description
dot1x credentialsprofile Configures a profile on a supplicant device.
dot1x supplicant force-multicast Forces 802.1X supplicant to send multicast pac
dot1x supplicant controlled transient Configures controlled access by 802.1X supplic
show cisp Displays CISP information for a specified inter
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1641
Security
clear aaa cache group
clear aaa cache group
To clear an individual entry or all entries in the cache, use the clear aaa cache group command in privileged
EXEC mode.
clear aaa cache group name { profile name | all }
Syntax Description name Text string representing the name of a cache server group.
profile name Specifies the name of an individual profile entry that must be cleared.
all Specifies that all the profiles in the named cache group be cleared.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines To update an old record with profile cache settings and to remove an old record from the cache, clear the
cache for the profile.
Examples The following example shows how to clear all the cache entries in the localusers group:
Device# clear aaa cache group localusers all
Related Commands Command Description
show aaa cache group Displays all the cache entries stored by the AAA cache.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1642
Security
clear device-tracking database
clear device-tracking database
To delete device-tracking database (binding table) entries, and clear counters, events, and messages, enter the
clear device-tracking command in privileged EXEC mode.
clear device-tracking { counters [ interface inteface_type_no | vlan vlan_id ] | database [ address
{ hostname | all } [ interface inteface_type_no | policy policy_name | vlan vlan_id ] | interface
inteface_type_no [ vlan vlan_id ] | mac mac_address [ interface inteface_type_no | policy policy_name
| vlan vlan_id ] | policy policy_name | prefix { prefix | all } [ interface inteface_type_no | policy
policy_name | vlan vlan_id ] | vlanid vlan_id ] | events | messages }
Syntax Description counters Clears device-tracking counters for the specified interface or VLAN.
Counters are displayed in the show device-tracking counters all privileged EXEC
command.
interface Enter an interface type and number. Use the question mark (?) online help function
inteface_type_no to display the types of interfaces available on the device.
The clear action is performed for the interface you specify.
vlan vlan_id Enter a VLAN ID. The clear action is performed for the VLAN ID you specify.
The valid value range is from 1 to 4095.
database Clears dynamic entries in the binding table.
Note Static entries configured by using the device-tracking binding vlan
vlan_id command are not deleted.
You can delete all the dynamic entries in the table, or optionally, you can specify
one or more IP addresses, MAC addresses, IPv6 prefixes, entries on a particular
interface or VLAN, or a policy.
hostname Enter the hostname or IP address on which you want to perform the clear action.
all Performs the clear action on all IP addresses or IPv6 prefixes.
policy policy_name Performs the clear action on the specified policy. Enter the policy name.
mac mac_address Performs the clear action on the specified MAC address. Enter the MAC address.
prefix prefix Performs the clear action on the specified IPv6 prefix. Enter a prefix or enter all
to indicate all prefixes.
events Clears the device-tracking events history.
Events are displayed in the show device-tracking events privileged EXEC
command.
messages Clears the device-tracking message history.
Events are displayed in the show device-tracking messages privileged EXEC
command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1643
Security
clear device-tracking database
Command Default Database entries go through their binding entry lifecycle.
Counters: Each counter is a nonnegative 32-bit integer and it wraps-around when the limit is reached.
Events and messages: After the limit of 255 is reached, starting with the oldest, events and messages are
overwritten.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples
The following example shows you how to clear all entries from the binding table.
Device# show device-tracking database Binding Table has 25 entries, 25 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.49 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 699 s
ARP 192.0.9.48 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 691 s
ARP 192.0.9.47 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 687 s
ARP 192.0.9.46 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 714 s
ARP 192.0.9.45 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 692 s
ARP 192.0.9.44 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 702 s
ARP 192.0.9.43 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 680 s
ARP 192.0.9.42 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.41 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.40 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.39 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 710 s
ARP 192.0.9.38 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 697 s
ARP 192.0.9.37 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 707 s
ARP 192.0.9.36 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 695 s
ARP 192.0.9.35 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.34 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 706 s
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1644
Security
clear device-tracking database
ARP 192.0.9.33 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.32 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 697 s
ARP 192.0.9.31 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.30 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 678 s
ARP 192.0.9.29 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 696 s
ARP 192.0.9.28 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 704 s
ARP 192.0.9.27 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 713 s
ARP 192.0.9.26 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 695 s
ARP 192.0.9.25 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 686 s
Device# clear device-tracking database
*Dec 13 15:10:22.837: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.49 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.48 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.47 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.46 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.45 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.44 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.43 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.42 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.41 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.40 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.39 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.38 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.37 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.36 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.35 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.34 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.33 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.32 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.31 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.30 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.29 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.28 VLAN=200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1645
Security
clear device-tracking database
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.27 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.26 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.25 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
Device# show device-tracking database
<no output; binding table cleared>
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1646
Security
clear errdisable interface vlan
clear errdisable interface vlan
To reenable a VLAN that was error-disabled, use the clear errdisable interface command in privileged
EXEC mode.
clear errdisable interface interface-id vlan [vlan-list]
Syntax Description interface-id Specifies an interface.
vlan list (Optional) Specifies a list of VLANs to be reenabled. If
Command Default No default behavior or values.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can reenable a port by using the shutdown and no shutdown interface configuration commands, or you
can clear error-disable for VLANs by using the clear errdisable interface command.
Examples This example shows how to reenable all VLANs that were error-disabled on Gigabit Ethernet port
4/0/2:
Device# clear errdisable interface gigabitethernet4/0/2 vlan
Related Commands Command Description
errdisable detect cause Enables error-disabled detection
errdisable recovery Configures the recovery mecha
show errdisable detect Displays error-disabled detectio
show errdisable recovery Displays error-disabled recover
show interfaces status err-disabled Displays interface status of a lis
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1647
Security
clear fqdn
clear fqdn
To clear the fully qualified domain name (FQDN) local cache entries, use the clear fqdn command in privileged
EXEC mode.
clear fqdn { database { all | fqdn name [ ipv4 address | ipv6 address ] } | packet statistics }
Syntax Description database all Clears all the FQDN local cache entries.
database fqdn name Clears the specified FQDN local cache entry.
ipv4 address Clears a particular IP binding matched to the FQDN name.
ipv6 address Clears a particular IPv6 binding matched to the FQDN name.
packet statistics Resets all the FQDN packet statistics counters to 0.
Command Default No default behavior or values.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 This command was modified. The ipv6 keyword was introduced.
Examples The following example shows how to clear all the FQDN local cache entries:
Device> enable
Device# clear fqdn database all
The following example shows how to clear a particular IPv4 binding matched to an FQDN name:
Device> enable
Device# clear fqdn database fqdn 123.cisco.com ipv4 10.102.103.10
The following example shows how to clear a particular IPv6 binding matched to an FQDN name:
Device> enable
Device# clear fqdn database fqdn 123.cisco.com ipv6 2001:DB8::1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1648
Security
clear mac address-table
clear mac address-table
To delete from the MAC address table a specific dynamic address, all dynamic addresses on a particular
interface, all dynamic addresses on stack members, or all dynamic addresses on a particular VLAN, use the
clear mac address-table command in privileged EXEC mode. This command also clears the MAC address
notification global counters.
clear mac address-table {dynamic [address mac-addr | interface interface-id | vlan vlan-id]
| move update | notification}
Syntax Description dynamic Deletes all dynamic MAC addresses.
address mac-addr (Optional) Deletes the specified dynamic MAC addr
interface interface-id (Optional) Deletes all dynamic MAC addresses on th
vlan vlan-id (Optional) Deletes all dynamic MAC addresses for t
move update Clears the MAC address table move-update counters
notification Clears the notifications in the history table and reset
Command Default No default behavior or values.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can verify that the information was deleted by entering the show mac address-table command.
This example shows how to remove a specific MAC address from the dynamic address table:
Device> enable
Device# clear mac address-table dynamic address 0008.0070.0007
Related Commands Command Description
mac address-table notification Enables the MAC address notification feature.
mac address-table move update {receive Configures MAC address-table move update on the device.
| transmit}
show mac address-table Displays the MAC address table static and dynamic entries.
show mac address-table move update Displays the MAC address-table move update information on the
device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1649
Security
clear mac address-table
Command Description
show mac address-table notification Displays the MAC address notification settings for all interfaces
or on the specified interface when the interface keyword is
appended.
snmp trap mac-notification change Enables the SNMP MAC address notification trap on a specific
interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1650
Security
confidentiality-offset
confidentiality-offset
To enable MACsec Key Agreement protocol (MKA) to set the confidentiality offset for MACsec operations,
use the confidentiality-offset command in MKA-policy configuration mode. To disable confidentiality offset,
use the no form of this command.
confidentiality-offset
no confidentiality-offset
Syntax Description This command has no arguments or keywords.
Command Default Confidentiality offset is disabled.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example shows how to enable the confidentiality offset:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# confidentiality-offset
Related Commands Command Description
mka policy Configures an MKA policy.
delay-protection Configures MKA to use delay protection in sending MKPDU.
include-icv-indicator Includes ICV indicator in MKPDU.
key-server Configures MKA key-server options.
macsec-cipher-suite Configures cipher suite for deriving SAK.
sak-rekey Configures the SAK rekey interval.
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1651
Security
crypto pki trustpool import
crypto pki trustpool import
To manually import (download) a certificate authority (CA) certificate bundle into a public key infrastructure
(PKI) trustpool to update or replace an existing CA bundle, use the crypto pki trustpool import command
in global configuration mode. To remove any of the configured parameters, use the no form of this command.
crypto pki trustpool import {ca-bundle | clean [{terminal | url url}] | terminal | url url}
no crypto pki trustpool import {ca-bundle | clean [{terminal | url url}] | terminal | url url}
Syntax Description ca-bundle Imports a CA certificate bundle configured in the trustpool policy.
clean Removes all the downloaded PKI trustpool certificates before the new certificates are
downloaded. Use the optional terminal keyword to remove the existing CA certificate bundle
terminal setting, or the url keyword and url argument to remove the URL file system setting.
terminal Import a CA certificate bundle through the terminal (cut-and-paste) in privacy-enhanced mail
(PEM) format.
url url Imports a CA certificate bundle through the specified URL.
Command Default The PKI trustpool feature is enabled. The device uses the built-in CA certificate bundle in the PKI trustpool,
which is updated automatically.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines PKI trustpool certificates are automatically updated. When the PKI trustpool certificates are not current, use
the crypto pki trustpool import command to update them from another location.
Note Security threats, as well as the cryptographic technologies that help protect against them, are constantly
changing. For more information about the latest Cisco cryptographic recommendations, see the Next Generation
Cryptography white paper.
The url argument specifies or changes the URL file system of the CA. The following table lists the available
URL file systems.
Table 199: URL File Systems
File System Description
archive: Imports from the archive file system.
cns: Imports from the Cluster Namespace (CNS) file system.
disk0: Imports from the disc0 file system.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1652
Security
crypto pki trustpool import
File System Description
disk1: Imports from the disc1 file system.
ftp: Imports from the FTP file system.
http: Imports from the HTTP file system. The URL must be in the following formats:
• http://CAname:80, where CAname is the Domain Name System (DNS)
• http://ipv4-address:80, for example: http://10.10.10.1:80.
• http://[ipv6-address]:80, for example: http://[2001:DB8:1:1::1]:80. The IPv6 address is a
hexadecimal notation, and must be enclosed within brackets in the URL.
https: Imports from the HTTPS file system. The URL must use the same format as the HTTP: file
system format.
null: Imports from the null file system.
nvram: Imports from the NVRAM file system.
pram: Imports from the Parameter Random-access Memory (PRAM) file system.
rcp: Imports from the remote copy protocol (RCP) file system.
scp: Imports from the secure copy protocol (SCP) file system.
snmp: Imports from the Simple Network Management Protocol (SNMP).
system: Imports from the system file.
tar: Imports from the UNIX TAR file system.
tftp: Imports from the TFTP file system.
Note The URL must be in the form: tftp://CAname/filespecification.
tmpsys: Imports from the Cisco IOS tmpsys file system.
unix: Imports from the UNIX file system.
xmodem: Imports from the xmodem simple file transfer protocol system.
ymodem: Imports from the ymodem simple file transfer protocol system.
Examples The following example shows how to remove all the downloaded PKI trustpool CA certificates and
subsequently update the CA certificates in the PKI trustpool by downloading a new CA certification
bundle:
Device> enable
Device# configure terminal
Device(config)# crypto pki trustpool import clean
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1653
Security
crypto pki trustpool import
The following example shows how to update all the CA certificates in the PKI trustpool by
downloading a new CA certification bundle without removing all the downloaded PKI trustpool CA
certificates:
Device(config)# crypto pki trustpool import url http://www.cisco.com/security/pki/trs/ios.p7b
Related Commands Command Description
crypto pki trustpool policy Configures PKI trustpool policy
parameters.
show crypto pki trustpool Displays the PKI trustpool
certificates of the device, and
optionally shows the PKI trustpool
policy.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1654
Security
debug aaa cache group
debug aaa cache group
To debug the caching mechanism and ensure that caching entries are cached from AAA server responses and
found when queried, use the debug aaa cache group command in privileged EXEC mode.
debug aaa cache group
Syntax Description This command has no arguments or keywords.
Command Default Debug information for all the cached entries is displayed.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to display debug information about cached entries.
Examples The following example displays the debug information about all the cached entries:
Device# debug aaa cache group
Related Commands Command Description
clear aaa cache group Clears an individual entry or all the entries in the cache.
show aaa cache group Displays cache entries stored by the AAA cache.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1655
Security
debug aaa dead-criteria transaction
debug aaa dead-criteria transaction
To display authentication, authorization, and accounting (AAA) dead-criteria transaction values, use the
debugaaadead-criteriatransactioncommand in privileged EXEC mode. To disable dead-criteria debugging,
use the no form of this command.
debug aaa dead-criteria transaction
no debug aaa dead-criteria transaction
Syntax Description This command has no arguments or keywords.
Command Default If the command is not configured, debugging is not turned on.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Dead-criteria transaction values may change with every AAA transaction. Some of the values that can be
displayed are estimated outstanding transaction, retransmit tries, and dead-detect intervals. These values are
explained in the table below.
Examples The following example shows dead-criteria transaction information for a particular server group:
Device> enable
Device# debug aaa dead-criteria transaction
AAA Transaction debugs debugging is on
*Nov 14 23:44:17.403: AAA/SG/TRANSAC: Computed Retransmit Tries: 10, Current Tries: 3,
Current Max Tries: 10
*Nov 14 23:44:17.403: AAA/SG/TRANSAC: Computed Dead Detect Interval: 10s, Elapsed Time:
317s, Current Max Interval: 10s
*Nov 14 23:44:17.403: AAA/SG/TRANSAC: Estimated Outstanding Transaction: 6, Current Max
Transaction: 6
The table below describes the significant fields shown in the display.
Table 200: debug aaa dead-criteria transaction Field Descriptions
Field Description
AAA/SG/TRANSAC AAA server-group transaction.
Computed Retransmit Tries Currently computed number of retransmissions before the server is
marked as dead.
Current Tries Number of successive failures since the last valid response.
Current Max Tries Maximum number of tries since the last successful transaction.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1656
Security
debug aaa dead-criteria transaction
Field Description
Computed Dead Detect Interval Period of inactivity (the number of seconds since the last successful
transaction) that can elapse before the server is marked as dead. The
period of inactivity starts when a transaction is sent to a server that is
considered live. The dead-detect interval is the period that the device
waits for responses from the server before the device marks the server
as dead.
Elapsed Time Amount of time that has elapsed since the last valid response.
Current Max Interval Maximum period of inactivity since the last successful transaction.
Estimated Outstanding Transaction Estimated number of transaction that are associated with the server.
Current Max Transaction Maximum transaction since the last successful transaction.
Related Commands Command Description
radius-server dead-criteria Forces one or both of the criteria, used to mark a RADIUS server as dead,
to be the indicated constant.
show aaa dead-criteria Displays dead-criteria detection information for an AAA server.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1657
Security
debug umbrella
debug umbrella
To enable debugging of the Cisco Umbrella Integration feature, use the debug umbrella command in privileged
EXEC mode. To disable debugging, use the no form of this command.
debug umbrella {config | device-registration | dnscrypt | redundancy}
no debug umbrella {config | device-registration | dnscrypt | redundancy}
Syntax Description config Enables configuration debugging.
device-registration Enables device registration debugging.
dnscrypt Enables DNSCrypt debugging.
redundancy Enables redundancy debugging.
Command Default Debugging is disabled.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to enable Cisco Umbrella configuration debugging:
Device> enable
Device# debug umbrella config
Umbrella config debugging is on
Device# configure terminal
Device(config)# interface gigabitethernet 1/0/12
Device(config-if)# umbrella in test
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Umbrella token configured, so set mode as TOKEN
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:check user configured resolver count
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Umbrella interface with no direct cloud access
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Umbrella mandatory parameter 'token' or
'api-key/secret/orgid' configured
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Processing is umbrella enabled check
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Is umbrella enabled check failed:sw idb info not found
*Nov 27 08:34:41.088: UMBRELLA-CONFIG:Send the interface info to device registration proces
*Nov 27 08:34:41.089: UMBRELLA-CONFIG:Add interface GigabitEthernet1/0/12 request sent to
DP
*Nov 27 08:34:41.089: UMBRELLA-CONFIG:Configured 'umbrella in test' on interface
GigabitEthernet1/0/12
*Nov 27 08:34:41.089: UMBRELLA-CONFIG:Cannot add domain patterns to DSA: Nothing to add
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1658
Security
delay-protection
delay-protection
To configure MKA to use delay protection in sending MACsec Key Agreement Protocol Data Units (MKPDUs),
use the delay-protection command in MKA-policy configuration mode. To disable delay protection, use the
no form of this command.
delay-protection
no delay-protection
Syntax Description This command has no arguments or keywords.
Command Default Delay protection for sending MKPDUs is disabled.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example shows how to configure MKA to use delay protection in sending MKPDUs:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# delay-protection
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
include-icv-indicator Includes ICV indicator in MKPDU.
key-server Configures MKA key-server options.
macsec-cipher-suite Configures cipher suite for deriving SAK.
sak-rekey Configures the SAK rekey interval.
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1659
Security
deny (MAC access-list configuration)
deny (MAC access-list configuration)
To prevent non-IP traffic from being forwarded if the conditions are matched, use the deny command in MAC
access-list extended configuration mode. To remove a deny condition from the named MAC access list, use
the no form of this command.
deny {any | host src-MAC-addr | src-MAC-addr mask} {any | host dst-MAC-addr |
dst-MAC-addr mask} [type mask | aarp | amber | appletalk | dec-spanning | decnet-iv |
diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | lsap lsap mask | mop-console
| mop-dump | msdos | mumps | netbios | vines-echo | vines-ip | xns-idp][cos cos]
no deny {any | host src-MAC-addr | src-MAC-addr mask} {any | host dst-MAC-addr |
dst-MAC-addr mask} [type mask | aarp | amber | appletalk | dec-spanning | decnet-iv |
diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | lsap lsap mask | mop-console
| mop-dump | msdos | mumps | netbios | vines-echo | vines-ip | xns-idp][cos cos]
Syntax Description any Denies any source or destination MAC address.
host src-MAC-addr | src-MAC-addr mask Defines a host MAC address and optional subnet
matches the defined address, non-IP traffic from t
host dst-MAC-addr | dst-MAC-addr mask Defines a destination MAC address and optional
a packet matches the defined address, non-IP traff
type mask (Optional) Specifies the EtherType number of a pac
to identify the protocol of the packet.
The type is 0 to 65535, specified in hexadecimal.
The mask is a mask of don’t care bits applied to t
aarp (Optional) Specifies EtherType AppleTalk Addres
address to a network address.
amber (Optional) Specifies EtherType DEC-Amber.
appletalk (Optional) Specifies EtherType AppleTalk/EtherT
dec-spanning (Optional) Specifies EtherType Digital Equipmen
decnet-iv (Optional) Specifies EtherType DECnet Phase IV
diagnostic (Optional) Specifies EtherType DEC-Diagnostic.
dsm (Optional) Specifies EtherType DEC-DSM.
etype-6000 (Optional) Specifies EtherType 0x6000.
etype-8042 (Optional) Specifies EtherType 0x8042.
lat (Optional) Specifies EtherType DEC-LAT.
lavc-sca (Optional) Specifies EtherType DEC-LAVC-SCA
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1660
Security
deny (MAC access-list configuration)
lsap lsap-number mask (Optional) Specifies the LSAP number (0 to 6
identify the protocol of the packet.
mask is a mask of don’t care bits applied to th
mop-console (Optional) Specifies EtherType DEC-MOP Re
mop-dump (Optional) Specifies EtherType DEC-MOP Du
msdos (Optional) Specifies EtherType DEC-MSDOS
mumps (Optional) Specifies EtherType DEC-MUMPS
netbios (Optional) Specifies EtherType DEC- Networ
vines-echo (Optional) Specifies EtherType Virtual Integra
Banyan Systems.
vines-ip (Optional) Specifies EtherType VINES IP.
xns-idp (Optional) Specifies EtherType Xerox Networ
an arbitrary EtherType in decimal, hexadecim
cos cos (Optional) Specifies a class of service (CoS) n
CoS can be performed only in hardware. A war
is configured.
Command Default This command has no defaults. However, the default action for a MAC-named ACL is to deny.
Command Modes MAC-access list extended configuration (config-ext-macl)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You enter MAC-access list extended configuration mode by using the mac access-list extended global
configuration command.
If you use the host keyword, you cannot enter an address mask; if you do not use the host keyword, you must
enter an address mask.
When an access control entry (ACE) is added to an access control list, an implied deny-any-any condition
exists at the end of the list. That is, if there are no matches, the packets are denied. However, before the first
ACE is added, the list permits all packets.
To filter IPX traffic, you use the type mask or lsap lsap mask keywords, depending on the type of IPX
encapsulation being used. Filter criteria for IPX encapsulation types as specified in Novell terminology and
Cisco IOS XE terminology are listed in the table.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1661
Security
deny (MAC access-list configuration)
Table 201: IPX Filtering Criteria
IPX Encapsulation Type Filter Criterion
Cisco IOS XE Name Novel Name
arpa Ethernet II EtherType 0x8137
snap Ethernet-snap EtherType 0x8137
sap Ethernet 802.2 LSAP 0xE0E0
novell-ether Ethernet 802.3 LSAP 0xFFFF
This example shows how to define the named MAC extended access list to deny NETBIOS traffic
from any source to MAC address 00c0.00a0.03fa. Traffic matching this list is denied.
Device> enable
Device# configure terminal
Device(config)# mac access-list extended mac_layer
Device(config-ext-macl)# deny any host 00c0.00a0.03fa netbios.
Device(config-ext-macl)# end
This example shows how to remove the deny condition from the named MAC extended access list:
Device> enable
Device# configure terminal
Device(config)# mac access-list extended mac_layer
Device(config-ext-macl)# no deny any 00c0.00a0.03fa 0000.0000.0000 netbios.
Device(config-ext-macl)# end
The following example shows how to deny all packets with EtherType 0x4321:
Device> enable
Device# configure terminal
Device(config)# mac access-list extended mac_layer
Device(config-ext-macl)# deny any any 0x4321 0
Device(config-ext-macl)# end
You can verify your settings by entering the show access-lists privileged EXEC command.
Related Commands Command Description
mac access-list extended Creates an access list based on MAC addresses for
permit Permits from the MAC access-list configuration.
Permits non-IP traffic to be forwarded if conditions
show access-lists Displays access control lists configured on a device
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1662
Security
device-role (IPv6 snooping)
device-role (IPv6 snooping)
To specify the role of the device attached to the port, use the device-role command in IPv6 snooping
configuration mode. To remove the specification, use the no form of this command.
device-role {node | switch}
no device-role {node | switch}
Syntax Description node Sets the role of the attached device to node.
switch Sets the role of the attached device to device.
Command Default The device role is node.
Command Modes IPv6 snooping configuration (config-ipv6-snooping)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The device-role command specifies the role of the device attached to the port. By default, the device role is
node.
The switch keyword indicates that the remote device is a switch and that the local switch is now operating in
multiswitch mode; binding entries learned from the port will be marked with trunk_port preference level. If
the port is configured as a trust-port, binding entries will be marked with trunk_trusted_port preference level.
This example shows how to define an IPv6 snooping policy name as policy1, place the device in
IPv6 snooping configuration mode, and configure the device as the node:
Device> enable
Device# configure terminal
Device(config)# ipv6 snooping policy policy1
Device(config-ipv6-snooping)# device-role node
Device(config-ipv6-snooping)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1663
Security
device-role (IPv6 nd inspection)
device-role (IPv6 nd inspection)
To specify the role of the device attached to the port, use the device-role command in neighbor discovery
(ND) inspection policy configuration mode.
device-role {host | switch}
Syntax Description host Sets the role of the attached device to host.
switch Sets the role of the attached device to switch.
Command Default The device role is host.
Command Modes ND inspection policy configuration (config-nd-inspection)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The device-role command specifies the role of the device attached to the port. By default, the device role is
host, and therefore all the inbound router advertisement and redirect messages are blocked.
The switch keyword indicates that the remote device is a switch and that the local switch is now operating in
multiswitch mode; binding entries learned from the port will be marked with trunk_port preference level. If
the port is configured as a trust-port, binding entries will be marked with trunk_trusted_port preference level.
The following example defines a Neighbor Discovery Protocol (NDP) policy name as policy1, places
the device in ND inspection policy configuration mode, and configures the device as the host:
Device> enable
Device# configure terminal
Device(config)# ipv6 nd inspection policy policy1
Device(config-nd-inspection)# device-role host
Device(config-nd-inspection)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1664
Security
device-role (IPv6 nd inspection)
device-role (IPv6 nd inspection)
To specify the role of the device attached to the port, use the device-role command in neighbor discovery
(ND) inspection policy configuration mode.
device-role {host | switch}
Syntax Description host Sets the role of the attached device to host.
switch Sets the role of the attached device to switch.
Command Default The device role is host.
Command Modes ND inspection policy configuration (config-nd-inspection)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The device-role command specifies the role of the device attached to the port. By default, the device role is
host, and therefore all the inbound router advertisement and redirect messages are blocked.
The switch keyword indicates that the remote device is a switch and that the local switch is now operating in
multiswitch mode; binding entries learned from the port will be marked with trunk_port preference level. If
the port is configured as a trust-port, binding entries will be marked with trunk_trusted_port preference level.
The following example defines a Neighbor Discovery Protocol (NDP) policy name as policy1, places
the device in ND inspection policy configuration mode, and configures the device as the host:
Device> enable
Device# configure terminal
Device(config)# ipv6 nd inspection policy policy1
Device(config-nd-inspection)# device-role host
Device(config-nd-inspection)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1665
Security
device-tracking (interface config)
device-tracking (interface config)
To enable SISF-based device tracking and attach the default policy to an interface or VLAN, or to enable the
feature and attach a custom policy enter the device-tracking command in interface configuration mode. To
detach the policy from the interface or VLAN and revert to default, use the no form of the command.
device-tracking [ attach-policy policy-name ] [ vlan { vlan-id | add vlan-id | all | except vlan-id | none
| remove vlan-id } ]
no device-tracking [ attach-policy policy-name ] [ vlan { vlan-id | add vlan-id | all | except vlan-id |
none | remove vlan-id } ]
Syntax Description attach-policy policy-name Attaches the custom policy that you specify, to the interface and all VLANs.
vlan { vlan-id | add vlan-id Configures the VLAN list for the policy and attaches the custom policy to the
| all | except vlan-id | none specified VLANs. You can specify the following particulars:
| remove vlan-id }
• vlan-id: Enter one or more VLAN IDs. The custom policy is attached to
all the VLAN IDs.
• addvlan-id: Adds specified VLANs to the existing list of VLAN IDs.
The custom policy is attached to all the VLAN IDs.
• all: Attaches the custom policy to all VLAN IDs.
This is the default option.
• exceptvlan-id: Attaches the custom policy to all VLAN IDs, except the
ones you specify here.
• none: Does not attach the custom policy to any VLAN.
removevlan-id: Removes specified VLANs from the existing list of
VLAN IDs. The custom policy is attached only to the VLAN IDs in the
list.
Command Default SISF-based device tracking is disabled and a policy is not attached to the interface.
Command Modes Interface configuration [Device((config-if)# )]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines If you enter the device-tracking command in the interface configuration mode, without any other keywords,
the system attaches the default policy the interface or VLAN. The default policy is a built-in policy with
default settings; you cannot change any of the attributes of the default policy.
If you configure the device-tracking attach-policypolicy-name command in the interface configuration mode,
you can specify a custom policy name. You must have created the custom policy in global configuration mode
already. The policy is attached to the specifed interface. You can then also specify the VLANs that you want
to attach it to.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1666
Security
device-tracking (interface config)
If you want to change the custom policy that is attached to a target, reconfigure the device-tracking
attach-policypolicy-name command.
If you want to disable the feature on a particular target, enter the no device-tracking command in the interface
configuration mode.
Examples
• Example: Enabling SISF-Based Device Tracking and Attaching the Default Policy, on page 1667
• Attaching a Custom Policy, on page 1667
• Example: Disabling SISF-Based Device-Tracking , on page 1668
Examples The following example shows how to enable SISF-based device tracking and attach the default policy
to an interface. The default policy has default policy parameters, none of which can be changed:
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# interface tengigabitethernet1/0/1
Device(config-if)# device-tracking
Device(config-if)# end
Device# show device-tracking policies detail
Target Type Policy Feature Target range
Te1/0/1 PORT default Device-tracking vlan all
Te1/0/2 PORT default Device-tracking vlan all
Device-tracking policy default configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
Policy default is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/1 PORT default Device-tracking vlan all
Te1/0/2 PORT default Device-tracking vlan all
Examples The following example shows how enable SISF-based device tracking and attach a custom policy
called sisf-01, to the same interface as the above example, that is, Te1/0/1. Doing so replaces the
existing default policy with custom policy sisf-01 on Te1/0/1.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# interface tengigabitethernet1/0/1
Device(config-if)# device-tracking attach-policy sisf-01
Device(config-if)# end
Device# show device-tracking policies detail
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-01 Device-tracking vlan all
Te1/0/2 PORT default Device-tracking vlan all
Device-tracking policy default configuration:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1667
Security
device-tracking (interface config)
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
Policy default is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/2 PORT default Device-tracking vlan all
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 3000
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-01 Device-tracking vlan all
Examples The following example shows how to disable SISF-based device-tracking on a target. The feature is
disabled on target Te1/0/1. This is the same interface where a custom policy is applied in the previous
example. The default policy continues to be available on the other interface where the feature is
enabled, that is, Te1/0/2.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# interface tengigabitethernet1/0/1
Device(config-if)# no device-tracking attach-policy sisf-01
Device(config-if)# end
Device# show device-tracking policies detail
Target Type Policy Feature Target range
Te1/0/2 PORT default Device-tracking vlan all
Device-tracking policy default configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
Policy default is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/2 PORT default Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1668
Security
device-tracking (VLAN config)
device-tracking (VLAN config)
To enable Switch Integrated Security Features (SISF)-based device tracking and attach the default policy to
a VLAN, or to enable the feature, attach a custom policy to a VLAN, and specify policy priority, enter the
device-tracking command in VLAN configuration mode. To detach the policy from a VLAN and revert to
default, use the no form of the command.
device-tracking [ attach-policy policy-name ] [ priority priority-value ]
Syntax Description attach-policy policy-name Attaches the custom policy that you specify, to the VLAN.
priority priority-value Note Although visible on the CLI, configuring this command has no
effect. Policy priority is system-determined. You cannot change
this.
Command Default SISF-based device tracking is disabled.
Command Modes VLAN configuration mode [Device((config-vlan-config)# )]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced
Usage Guidelines If you enter the device-tracking command in VLAN configuration mode, without any other keywords, the
system attaches the default policy to the VLAN. The default policy is a built-in policy with default settings;
you cannot change any of the parameters of the default policy.
If you configure the device-tracking attach-policypolicy-name command in VLAN configuration mode, the
custom policy you specify is attached to the VLAN. With a custom policy, you can configure certain parameters
of a custom policy.
You can enable the feature and attach a policy - custom or default - to one or more VLANs or a range of
VLANs.
Examples
• Example: Enabling SISF-Based Device Tracking and Attaching the Default Policy, on page 1669
• Example: Attaching a Custom Policy to a VLAN, on page 1670
• Example: Attaching a Custom Policy to a Range of VLANs, on page 1670
Examples The following example shows how to enable SISF-based device tracking and attach the default policy
to VLAN 500:
Device# show device-tracking policies
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-03 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1669
Security
device-tracking (VLAN config)
Te1/0/1 PORT default Address Resolution Relay vlan all
Te1/0/2 PORT default Device-tracking vlan all
vlan 333 VLAN sisf-01 Device-tracking vlan all
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)#vlan configuration 500
Device(config-vlan-config)# device-tracking
Device(config-vlan-config)# end
Device#show device-tracking policies
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-03 Device-tracking vlan all
Te1/0/1 PORT default Address Resolution Relay vlan all
Te1/0/2 PORT default Device-tracking vlan all
vlan 333 VLAN sisf-01 Device-tracking vlan allvlan 500
VLAN default Device-tracking vlan all
Examples The following example shows how to attach a custom policy called sisf-03, to the same VLAN as
the above example, that is, VLAN 500. Doing so replaces the existing default policy with custom
policy sisf-03 on the VLAN:
Device# show device-tracking policies
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-03 Device-tracking vlan all
Te1/0/1 PORT default Address Resolution Relay vlan all
Te1/0/2 PORT default Device-tracking vlan all
vlan 333 VLAN sisf-01 Device-tracking vlan all
vlan 500 VLAN default Device-tracking vlan all
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# vlan configuration 500
Device(config-vlan-config)# device-tracking attach-policy sisf-03
Device(config-vlan-config)# end
Device# show device-tracking policies
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-03 Device-tracking vlan all
Te1/0/1 PORT default Address Resolution Relay vlan all
Te1/0/2 PORT default Device-tracking vlan all
vlan 333 VLAN sisf-01 Device-tracking vlan allvlan 500
VLAN sisf-03 Device-tracking vlan all
Examples The following example shows how to attach a custom policy to a range of VLANs (VLANs 10 to
15):
Device(config)# vlan configuration 10-15
Device(config-vlan-config)#device-tracking attach-policy sisf-01
Device(config-vlan-config)#end
Device# show device-tracking policies
Target Type Policy Feature Target range
Te1/0/2 PORT default Device-tracking vlan all
vlan 10 VLAN sisf-01 Device-tracking vlan all
vlan 11 VLAN sisf-01 Device-tracking vlan all
vlan 12 VLAN sisf-01 Device-tracking vlan all
vlan 13 VLAN sisf-01 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1670
Security
device-tracking (VLAN config)
vlan 14 VLAN sisf-01 Device-tracking vlan all
vlan 15 VLAN sisf-01 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1671
Security
device-tracking binding
device-tracking binding
To specify how binding entries are maintained in the binding table, enter the device-tracking binding command
in global configuration mode. With this command you can configure the lifetime of each state, the maximum
number of entries allowed in a binding table, and whether binding entry events are logged. You can also use
this command to configure static binding entries. To revert to the default value, use the no form of the command.
device-tracking binding { down-lifetime | logging | max-entries | reachable-lifetime | stale-lifetime |
vlan }
For the sake of clarity, the remaining command string after each one of the above options is listed separately:
• device-tracking binding down-lifetime { seconds | infinite }
no device-tracking binding down-lifetime
• device-tracking binding logging
no device-tracking binding logging
• device-tracking binding max-entries no_of_entries [ mac-limit no_of_entries | port-limit
no_of_entries [ mac-limit no_of_entries ] | vlan-limit no_of_entries [ mac-limit no_of_entries |
port-limit no_of_entries [ mac-limit no_of_entries ] ] ]
no device-tracking binding max-entries
• device-tracking binding reachable-lifetime { seconds | infinite } [ down-lifetime { seconds | infinite
} | stale-lifetime { seconds | infinite } [ down-lifetime { seconds | infinite } ] ]
no device-tracking binding reachable-lifetime
• device-tracking binding stale-lifetime { seconds | infinite } [ down-lifetime { seconds | infinite } ]
no device-tracking binding stale-lifetime
• device-tracking binding vlan vlan_id { ipv4_add ipv6_add ipv6_prefix } [ interface inteface_type_no
] [ 48-bit-hardware-address ] [ reachable-lifetime { seconds | default | infinite } | tracking
{ default | disable | enable [ retry-interval { seconds | default } ] } [ reachable-lifetime {
seconds | default | infinite } ] ]
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1672
Security
device-tracking binding
Syntax Description down-lifetime { seconds Provides the option to configure a countdown timer for a binding entry in the
| infinite } DOWN state, or, to disable the timer.
A binding entry enters the DOWN state when the host’s connecting interface is
administratively down. If a timer is configured, one of these events may occur
before timer expiry - either the interface can be up again, or, the entry can remain
in the DOWN state. If the interface is up before timer expiry, the timer is stopped,
and the state of the entry changes. If the entry remains in the DOWN state after
timer expiry, it is removed from the binding table. If the timer is disabled or turned
off, the entry is never removed from the binding table and can remain in the DOWN
state indefinitely, or until the interface is up again.
Configure one of these options:
• seconds: Configure a value for the down-lifetime timer. Enter a value between
1 and 86400 seconds. The default value is 86400 seconds (24 hours).
• infinite: Disables the timer for the DOWN state. This means that a timer is
not started when an entry enters the DOWN state.
logging Enables generation of logs for binding entry events.
device-tracking binding Configures the maximum number of entries for a binding table. Enter a value
max-entries between 1 and 200000. The default value is 200000.
no_of_entries [
Note This limit applies only to dynamic entries and not static binding
mac-limit no_of_entries
entries.
| port-limit
no_of_entries |
Optionally, you can also configure these limits:
vlan-limit no_of_entries
] • mac-limit no_of_entries: Configures the maximum number of entries allowed
per MAC address. Enter a value between 1 and 100000. By default, a limit
is not set.
• port-limit no_of_entriesConfigures the maximum number of entries allowed
per interface. Enter a value between 1 and 100000. By default, a limit is not
set.
• vlan-limit no_of_entries: Configures the maximum number of entries allowed
per VLAN. Enter a value between 1 and 100000. By default, a limit is not
set.
The no form of the command resets the max-entries value to 200000 and sets the
mac-limit, port-limit, vlan-limit to "no limit".
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1673
Security
device-tracking binding
reachable-lifetime { Provides the option to configure a countdown timer for a binding entry in the
seconds | infinite } REACHABLE state, or, to disable the timer.
If a timer is configured, either one of these events may occur before timer expiry
- incoming packets are received from the host, or there are no incoming packets
from the host. Every time an incoming packet is received from the host, the timer
is reset. If no incoming packets are received and the timer expires, then the state
of the entry changes based on the reachability of the host. If the timer is disabled
or turned off, the entry can remain in the REACHABLE state, indefinitely.
Configure one of these options:
• seconds: Configure a value for the reachable-lifetime timer. Enter a value
between 1 and 86400 seconds. The default value is 300 seconds (5 minutes).
• infinite: Disables the timer for the REACHABLE state. This means that a
timer is not started when an entry enters the REACHABLE state.
stale-lifetime { seconds Provides the option to configure a countdown timer for a binding entry in the
| infinite } STALE state, or, to disable the timer.
If a timer is configured, either one of these events may occur before timer expiry
- incoming packets are received from the host, or there are no incoming packets
from the host. If an incoming packet is received, the timer is stopped and the entry
transitions to a new state. If no incoming packets are received and the timer expires,
then the entry is removed from the binding table. If the timer is disabled or turned
off, the entry can remain in the STALE state, indefinitely.
If polling is enabled, a final attempt is made to probe the host at stale timer expiry.
Note If polling is enabled, polling occurs when the reachable lifetime timer
expires (3 times), and then a final attempt at stale timer expiry as
well. The time required to poll an entry after expiry of reachable
lifetime, is subtracted from the stale lifetime.
Configure one of these options:
• seconds: Configure a value for the stale-lifetime timer. Enter a value between
1 and 86400 seconds. The default value is 86400 seconds (24 hours).
• infinite: Disables the timer for the STALE state. This means that a timer is
not started when an entry enters the STALE state.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1674
Security
device-tracking binding
device-tracking binding Creates a static binding entry in the binding table. You can also specify how static
vlan vlan_id { ipv4_add binding entries are maintained in the binding table.
ipv6_add ipv6_prefix }
Note The limit you configure for the max-entries no_of_entries option
[ interface
(above) does not apply to static binding entires. There is no limit to
inteface_type_no ] [
the number of static entries you can create.
48-bit-hardware-address
] [ reachable-lifetime
• Enter an IP address or prefix:
{ seconds | default |
infinite } | tracking { • ipv4_add : Enter an IPv4 address.
default | disable |
• ipv6_add : Enter an IPv6 address.
enable [
retry-interval { seconds • ipv6_prefix : Enter an IPv6 prefix.
| default } ] } [
reachable-lifetime { • interface inteface_type_no: Enter an interface type and number. Use the
seconds | default | question mark (?) online help function to display the types of interfaces
infinite } ] ] available on the device.
• (Optional) 48-bit-hardware-address: Enter a MAC address. If you do not
configure a MAC address for the binding entry, any MAC address is allowed.
• (Optional) reachable-lifetime {seconds | default | infinite }: Configures the
reachable lifetime settings for a static binding entry in the REACHABLE
state. If you want to configure a reachable lifetime for a static binding entry,
you must specify the MAC address for the entry.
If you do not configure a value, the same value as configured for
device-tracking binding reachable-lifetime applies.
seconds: Configure a value for the reachable-lifetime timer. Enter a value
between 1 and 86400 seconds. The default value is 300 seconds (5 minutes).
default: Uses the same value as configured for dynamic entries in the binding
table.
infinite: Disables the timer for the REACHABLE state. This means that a
timer is not started when a static binding entry enters the REACHABLE state.
• (Optional) tracking {default | disable | enable}: Configures polling related
settings for a static binding entry.
default:Polling is disabled.
disable: Disables polling for a static binding entry.
enable: Enables polling for a static binding entry.
When you enable tracking, you also have the option to configure a
retry-interval. This is a multiplicative factor or "base value", for the backoff
algorithm. The backoff algorithm determines the wait time between the 3
polling attempts that occur after reachable lifetime expiry.
Enter a value between 1 and 3600 seconds. The default value is one.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1675
Security
device-tracking binding
Command Default If you do not configure a value, the default values for down, reachable, and stale lifetimes, and maximum
number of binding entries allowed in a binding table are applicable - as long as a policy-level value is not set.
See the Usage Guidelines below for further details.
Command Modes Global configuration [Device(config)# ]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The device-tracking binding command enables you to specify how entries are maintained in a binding table,
at a global level. The settings therefore apply to all interfaces and VLANs where SISF-based device-tracking
is enabled. But for the system to start extracting binding information from packets that enter the network and
to create binding entries to which the settings you configure here will apply, there must exist a policy that is
attached an interface or VLAN.
If there is no policy on any interface or VLAN, the only entries that can exist in a binding table are any static
binding entries you create.
Changing Any Binding Entry Setting
When you reconfigure a value or setting with the device-tracking binding command, the change applies only
to subsequently created binding entries. The changed configuration does not apply to existing entries. The
older setting applies to an older entry.
To display the current settings, enter the show device-tracking database command in privileged EXEC
mode.
Global versus Policy-Level Settings
For some of the settings you configure with this command, there are policy level counterparts. (A policy level
paramter is configured in the device-tracking configuration mode and applies only to that policy). The tables
below clarifies when a globally configured value takes precedence and when a policy-level value takes
precedence:
Option under device-tracking binding global Policy-level counterpart in the device-tracking
configuration command configuration mode
device-tracking binding reachable-lifetime { tracking enable [reachable-lifetime [seconds | infinite]
seconds | infinite } ]
Device(config)# device-tracking binding Device(config)# device-tracking policy sisf-01
reachable-lifetime 2000 Device(config-device-tracking)#
Device(config-device-tracking)# tracking enable
reachable-lifetime 250
If a policy-level value and a globally configured value exists, the policy-level value applies.
If only a globally configured value exists, the globally configured value applies.
If only a policy-level value exists the policy-level value applies.
See: Example: Configuring a Reachable, Stale, and Down Lifetime at the Global vs Policy Level, on page
1680.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1676
Security
device-tracking binding
Option under device-tracking binding global Policy-level counterpart in the device-tracking
configuration command configuration mode
device-tracking binding stale-lifetime { seconds tracking disable [stale-lifetime [seconds | infinite] ]
| infinite }
Device(config)# device-tracking binding Device(config)# device-tracking policy sisf-01
stale-lifetime 2000 Device(config-device-tracking)#
Device(config-device-tracking)# tracking enable
stale-lifetime 500
If a policy-level value and a globally configured value exists, the policy-level value applies.
If only a globally configured value exists, the globally configured value applies.
If only a policy-level value exists the policy-level value applies.
See: Example: Configuring a Reachable, Stale, and Down Lifetime at the Global vs Policy Level, on page
1680.
Option under device-tracking binding global Policy-level counterpart in the device-tracking
configuration command configuration mode
device-tracking binding max-entries no_of_entries limit address-countip-per-port
[ mac-limit no_of_entries | port-limit no_of_entries
| vlan-limit no_of_entries ]
Device(config)# device-tracking binding Device(config)# device-tracking policy
max-entries 30 vlan-limit 25 port-limit 20 sisf-01
mac-limit 19 Device(config-device-tracking)#
Device(config-device-tracking)# limit
address-count 30
If a policy-level value and globally configured values exist, the creation of binding entries is stopped when
a limit is reached - this can be one of the global values or the policy-level value.
If only globally configured values exist, the creation of binding entries is stopped when a limit is reached.
If only a policy-level value exists, the creation of binding entries is stopped when the policy-level limit is
reached.
Example: Global vs Policy-Level Address Limits, on page 1684.
Option under device-tracking binding global Policy-level counterpart in the device-tracking configuration
configuration command mode
device-tracking binding max-entries IPv4 per MAC and IPv6 per MAC
no_of_entries
While you cannot configure either one of the above limits in
[ mac-limit no_of_entries ]
a policy, a programmatically created policy may have either
one, both, or neither one of the limits.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1677
Security
device-tracking binding
Option under device-tracking binding global Policy-level counterpart in the device-tracking configuration
configuration command mode
Device(config)# device-tracking binding Device# show device-tracking policy LISP-DT-GLEAN-VLAN
max-entries 300
mac-limit 3 Policy LISP-DT-GLEAN-VLAN configuration:
security-level glean (*)
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count for IPv4 per mac 4 (*)
limit address-count for IPv6 per mac 12 (*)
tracking enable
<output truncated>
If a policy-level value and globally configured values exists, the creation of binding entries is stopped when
a limit is reached - this can be one of the global values or the policy-level value.
If only globally configured values exist, the creation of binding entries is stopped when a limit is reached.
If only a policy-level value exists, the creation of binding entries is stopped when the policy-level limit is
reached.
Configuring Down, Reachable, Stale Lifetimes
When you configure a non-default value for the down-lifetime, or reachable-lifetime, or stale-lifetime
keywords, the system reverts the lifetimes that you do not configure, to default values. The following example
clarifies this behaviour: Example: Configuring Non-Default Values for Reachable, Stale, and Down Lifetimes,
on page 1680.
To display the currently configured lifetime values, enter the show running-config | include device-tracking
command in privileged EXEC mode.
Configuring MAC, Port, VLAN Limits
When you configure a non-default value for the mac-limit, or port-limit, or vlan-limit keywords, the system
reverts the limits that you do not configure, to default values.
To configure all three limits in the same command line, first configure the VLAN limit, then the port limit,
and finally the MAC limit:
Device(config)# device-tracking binding max-entries 15 vlan-limit 2 port-limit 20 mac-limit
5
You can also use this system behavior when you want to reset one or more - but not all limits, to their default
values. Although the default for all three keywords is that there is no limit, you cannot enter the number "0"
to set a limit to its default value. Zero is not within the valid value range for any of the limits. To reset one or
more limits to their default values, leave out the corresponding keyword. The following example clarifies this
behaviour: Example: Setting VLAN, Port, and MAC Limits to Default Values, on page 1688.
Enabling Logging of Binding Entry Events
When you configure the device-tracking binding logging global configuration command to generate logs
for binding entry events, you may also have to configure a few general logging settings, depending on your
requirements:
• (Required) The logging buffered informational command in global configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1678
Security
device-tracking binding
With this command you enable message logging at a device level and you specify a severity level.
Configuring the command allows logs to be copied and stored to a local, internal buffer. Specifying a
severity level causes messages at that level and numerically lower levels to be logged.
Logs generated for binding entry events have a severity level of 6 (meaning, informational). For example:
%SISF-6-ENTRY_CREATED: Entry created IP=192.0.2.24 VLAN=200 MAC=001b.4411.4ab6 I/F=Te1/0/4
Preflevel=00FF
• (Optional) The logging console command in global configuration mode.
With this command you send the logs to the console (all available TTY lines).
Caution A low severity level may cause the number of messages being displayed on the
console to increase significantly. Further, the console is a slow display device.
In message storms some logging messages may be silently dropped when the
console queue becomes full. Set severity levels accordingly.
If you don't want to configure this command, you can view logs when required by entering the show
logging command in privileged EXEC mode.
If the logging console command is not enabled, logs are not displayed on the device console, but if you have
configured device-tracking binding logging and logging buffered informational, logs will be generated
and available in the local buffer.
For information about the kind of binding entry events for which logs are generated, see the system message
guide for the corresponding release: System Message Guides. Search for SISF-6.
While the device-tracking binding logging command logs binding entry events, there is also the
device-tracking logging command, which enables snooping security logging. The two command log different
kinds of events and the generated logs have different severity levels.
Creating a Static Binding Entry
If there are silent but reachable hosts in the Layer 2 domain, and you want to retain binding information for
these silent hosts, you can create static binding entries.
While there is no limit to the number of static entries you can create, these entries also contribute to the size
of the binding table. Consider the number of such entries you require, before you create them.
You can create a static binding entry even if a policy is not attached to the interface or VLAN specified in the
static binding entry.
When you configure a static binding entry followed by its settings (for example, reachable-lifetime), the
configuration applies only to that static binding entry and not to any other entries, static or dynamic. The
following example shows you how to created a static binding entry: Example: Creating a Static Binding Entry,
on page 1683.
Examples
• Example: Configuring Non-Default Values for Reachable, Stale, and Down Lifetimes, on page
1680
• Example: Configuring a Reachable, Stale, and Down Lifetime at the Global vs Policy Level,
on page 1680
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1679
Security
device-tracking binding
• Example: Creating a Static Binding Entry, on page 1683
• Example: Global vs Policy-Level Address Limits, on page 1684
• Example: Setting VLAN, Port, and MAC Limits to Default Values, on page 1688
• Example: Global vs Policy-Level Limits Relating to MAC Addresses, on page 1689
Example: Configuring Non-Default Values for Reachable, Stale, and Down Lifetimes
The following example clarifies system behaviour when you configure values for reachable, stale, and down
lifetimes seperately (the effect is not cumulative). It also show you how to configure values in a way that
configuration is retained for all the lifetimes.
In the first step of this example only a reachable-lifetime is configured. This means the down-lifetime and
stale lifetime are set to default, because the stale-lifetime and down-lifetime keywords have been left out:
Device(config)# device-tracking binding reachable-lifetime 700
Device(config)# exit
Device# show running-config | include device-tracking
device-tracking policy sisf-01
device-tracking attach-policy sisf-01
device-tracking attach-policy sisf-01 vlan 200device-tracking binding reachable-lifetime
700
device-tracking binding logging
In the next step of this example, a stale-lifetime of 1500 seconds and a down-lifetime of 1000 seconds is
configured. With this, the reachable-lifetime configured in the previous step, is to default:
Device(config)# device-tracking binding stale-lifetime 1500 down-lifetime 1000
Device(config)# exit
Device# show running-config | include device-tracking
device-tracking policy sisf-01
device-tracking attach-policy sisf-01
device-tracking attach-policy sisf-01 vlan 200device-tracking binding stale-lifetime 1500
down-lifetime 1000
device-tracking binding logging
In the next step of this example, reachable, down, and stale lifetimes of 700, 1000, and 200 respectively, are
configured. With this, the value for the stale-lifetime is changed from 1500 seconds, to 1000 seconds. The
down-lifetime is changed from 1000 to 200. The reachable-lifetime is configured as 700 seconds.
Device(config)# device-tracking binding reachable-lifetime 700 stale-lifetime 1000
down-lifetime 200
Device(config)# exit
Device# show running-config | include device-tracking
device-tracking policy sisf-01
device-tracking attach-policy sisf-01
device-tracking attach-policy sisf-01 vlan 200device-tracking binding reachable-lifetime
700 stale-lifetime 1000 down-lifetime 200
device-tracking binding logging
If any one of the lifetimes requires a change and the values for the other lifetimes must be retained, all three
keywords must be reconfigured with the required values - everytime, and in the same command line.
Example: Configuring a Reachable, Stale, and Down Lifetime at the Global vs Policy Level
The following example shows you how to configure the reachable, stale, and down lifetimes for binding
entries, at a global level. This example also shows you how you can then override the global setting and
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1680
Security
device-tracking binding
configure a different lifetime for entries learnt on a particular interface or VLAN, by configuring a policy-level
setting.
In the first part of the example, the output of the show device-tracking policy policy-name command shows
that a policy-level value is not set and the default binding table settings are applicable to the existing entries.
After a reachable, stale, and down lifetime is configured with the device-tracking binding command in global
configuration mode, the new values are effective and are applied only to the four new entries that are added
to the table.
Note In the output of the show device-tracking database command, note the Time left column for the binding
entries. There is minor difference in the reachable lifetime of each entry. This is a system-imposed jitter (+/-
5 percent of the configured value), to ensure that system performance is not affected when a large number of
entries are added to the binding table. Binding entries go through their lifecycle in a staggered manner thus
preventing points of congestion.
Current configuration, which shows that policy-level reachable lifetime is not configured. The binding table
entries show that the current reachable lifetime is 500 seconds (time left + age):
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
Device# show device-tracking database
Binding Table has 4 entries, 4 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left <<<<
ARP 192.0.9.9 000a.959d.6816 Te1/0/4 200
0064 40s REACHABLE 466 s
ARP 192.0.9.8 000a.959d.6816 Te1/0/4 200
0064 40s REACHABLE 472 s
ARP 192.0.9.7 000a.959d.6816 Te1/0/4 200
0064 40s REACHABLE 470 s
ARP 192.0.9.6 000a.959d.6816 Te1/0/4 200
0064 40s REACHABLE 469 s
Configuration of reachable, stale and down lifetime at the global level. New values apply only to binding
entries created after this:
Device(config)# device-tracking binding reachable-lifetime 700 stale-lifetime 1000
down-lifetime 200
Device # show device-tracking database
Binding Table has 8 entries, 8 dynamic (limit 200000)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1681
Security
device-tracking binding
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.13 000a.959d.6816 Te1/0/4 200
00C8 4s REACHABLE 699 s <<<< new global value applied
ARP 192.0.9.12 000a.959d.6816 Te1/0/4 200
00C8 4s REACHABLE 719 s <<<< new global value applied
ARP 192.0.9.11 000a.959d.6816 Te1/0/4 200
00C8 4s REACHABLE 728 s <<<< new global value applied
ARP 192.0.9.10 000a.959d.6816 Te1/0/4 200
00C8 4s REACHABLE 712 s <<<< new global value applied
ARP 192.0.9.9 000a.959d.6816 Te1/0/4 200
0064 9mn STALE try 0 1209 s
ARP 192.0.9.8 000a.959d.6816 Te1/0/4 200
0064 9mn VERIFY 5 s try 3
ARP 192.0.9.7 000a.959d.6816 Te1/0/4 200
0064 9mn VERIFY 2816 ms try 3
ARP 192.0.9.6 000a.959d.6816 Te1/0/4 200
0064 9mn VERIFY 1792 ms try 3
In this second part of the example, a policy level value is configured and the reachable lifetime is set to 50
seconds. This new reachable lifetime is again applicable only to entries created after this.
Only a reachable lifetime is configured at the policy-level and not a stale and down lifetime. This means it is
still the global values that apply if the reachable lifetime of the two new entries expires and they move to the
STALE or DOWN state.
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# tracking enable reachable-lifetime 50
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
tracking enable reachable-lifetime 50 <<<< new value applies only to binding entries
created after this and on interfaces and VLANs where this policy is attached.
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
Device# show device-tracking database
Binding Table has 10 entries, 10 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.21 000a.959d.6816 Te1/0/4 200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1682
Security
device-tracking binding
0064 5s REACHABLE 45 s <<<< new policy-level value applied
ARP 192.0.9.20 000a.959d.6816 Te1/0/4 200
0064 5s REACHABLE 46 s <<<< new policy-level value applied
ARP 192.0.9.13 000a.959d.6816 Te1/0/4 200
00C8 14mn STALE try 0 865 s
ARP 192.0.9.12 000a.959d.6816 Te1/0/4 200
00C8 14mn STALE try 0 183 s
ARP 192.0.9.11 000a.959d.6816 Te1/0/4 200
00C8 14mn STALE try 0 178 s
ARP 192.0.9.10 000a.959d.6816 Te1/0/4 200
00C8 14mn STALE try 0 165 s
ARP 192.0.9.9 000a.959d.6816 Te1/0/4 200
0064 23mn STALE try 0 327 s
ARP 192.0.9.8 000a.959d.6816 Te1/0/4 200
0064 23mn STALE try 0 286 s
ARP 192.0.9.7 000a.959d.6816 Te1/0/4 200
0064 23mn STALE try 0 303 s
ARP 192.0.9.6 000a.959d.6816 Te1/0/4 200
0064 23mn STALE try 0 306 s
Device# show device-tracking database <<<< checking binding table again after new policy-level
reachable-lifetime expires
Binding Table has 7 entries, 7 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.21 000a.959d.6816 Te1/0/4 200
0064 3mn STALE try 0 887 s <<<< global value applies for stale-lifetime;
policy-level value was not configured
ARP 192.0.9.20 000a.959d.6816 Te1/0/4 200
0064 3mn STALE try 0 884 s <<<< global value applies for stale-lifetime;
policy-level value was not configured
ARP 192.0.9.13 000a.959d.6816 Te1/0/4 200
00C8 17mn STALE try 0 664 s
ARP 192.0.9.9 000a.959d.6816 Te1/0/4 200
0064 27mn STALE try 0 136 s
ARP 192.0.9.8 000a.959d.6816 Te1/0/4 200
0064 27mn STALE try 0 96 s
ARP 192.0.9.7 000a.959d.6816 Te1/0/4 200
0064 27mn STALE try 0 108 s
ARP 192.0.9.6 000a.959d.6816 Te1/0/4 200
0064 27mn STALE try 0 111 s
Example: Creating a Static Binding Entry
The following example shows you how to create a static binding entry. The "S" at the beginning of the entry
indicates that it is a static binding entry:
Device(config)# device-tracking binding vlan 100 192.0.2.1 interface tengigabitethernet1/0/1
00:00:5e:00:53:af reachable-lifetime infinite
Device(config)# exit
Device# show device-tracking database
Binding Table has 2 entries, 0 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1683
Security
device-tracking binding
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
S 192.0.2.1 0000.5e00.53af Te1/0/1 100
0100 14s REACHABLE N/A
Example: Global vs Policy-Level Address Limits
The following example show you how to assess which address limit is reached, when you configure address
limits at the global level and at the policy-level.
The global level settings refer to the values configured for the following command string: device-tracking
bindingmax-entries no_of_entries [mac-limit no_of_entries|port-limit no_of_entries|vlan-limit
no_of_entries]
The policy level parameter refers to the limit address-count option in the device-tracking configuration mode.
For this first part of the example, the configuration is as follows:
• Global configuration: max-entries=30, vlan-limit=25, port-limit=20, mac-limit=19.
• Policy-level configuration: limit address-count=45.
The output of the show device-tracking database details privileged EXEC command shows that the port
limit (max/port) is reached first. A maximum of 20 entries are allowed on a port or interface. No further
binding entries are created after this. While the mac limit is configured with a lower absolute value (19), the
output of the show device-tracking database mac privileged EXEC command shows that there are only 3
unique MAC address in the list of binding entries in the table - this limit is therefore not reached.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# device-tracking binding max-entries 30 vlan-limit 25 port-limit 20 mac-limit
19
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# limit address-count 45
Device(config-device-tracking)# end
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 45
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
Device# show device-tracking database details
Binding table configuration:
----------------------------
max/box : 30
max/vlan : 25
max/port : 20
max/mac : 19
Binding table current counters:
------------------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1684
Security
device-tracking binding
dynamic : 20
local : 0
total : 20 <<<< no further entries created after this.
Binding table counters by state:
----------------------------------
REACHABLE : 20
total : 20
<output truncated>
Device# show device-tracking database
Binding Table has 20 entries, 20 dynamic (limit 30)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.39 000c.959d.6816 Te1/0/4 200
0064 14s REACHABLE 37 s
ARP 192.0.9.38 000b.959d.6816 Te1/0/4 200
0064 14s REACHABLE 37 s
ARP 192.0.9.37 000b.959d.6816 Te1/0/4 200
0064 14s REACHABLE 36 s
ARP 192.0.9.36 000b.959d.6816 Te1/0/4 200
0064 14s REACHABLE 39 s
ARP 192.0.9.35 000b.959d.6816 Te1/0/4 200
0064 14s REACHABLE 38 s
ARP 192.0.9.34 000b.959d.6816 Te1/0/4 200
0064 14s REACHABLE 37 s
ARP 192.0.9.33 000b.959d.6816 Te1/0/4 200
0064 15s REACHABLE 36 s
ARP 192.0.9.32 000b.959d.6816 Te1/0/4 200
0064 15s REACHABLE 37 s
ARP 192.0.9.31 000b.959d.6816 Te1/0/4 200
0064 15s REACHABLE 36 s
ARP 192.0.9.30 000b.959d.6816 Te1/0/4 200
0064 15s REACHABLE 36 s
ARP 192.0.9.29 000b.959d.6816 Te1/0/4 200
0064 15s REACHABLE 35 s
ARP 192.0.9.28 000a.959d.6816 Te1/0/4 200
0064 15s REACHABLE 36 s
ARP 192.0.9.27 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 35 s
ARP 192.0.9.26 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 36 s
ARP 192.0.9.25 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 34 s
ARP 192.0.9.24 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 35 s
ARP 192.0.9.23 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 34 s
ARP 192.0.9.22 000a.959d.6816 Te1/0/4 200
0064 16s REACHABLE 36 s
ARP 192.0.9.21 000a.959d.6816 Te1/0/4 200
0064 17s REACHABLE 33 s
ARP 192.0.9.20 000a.959d.6816 Te1/0/4 200
0064 17s REACHABLE 33 s
Device# show device-tracking database mac
MAC Interface vlan prlvl state Time left
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1685
Security
device-tracking binding
Policy Input_index
000c.959d.6816 Te1/0/4 200 NO TRUST MAC-REACHABLE 27 s
sisf-01 12
000b.959d.6816 Te1/0/4 200 NO TRUST MAC-REACHABLE 27 s
sisf-01 12
000a.959d.6816 Te1/0/4 200 NO TRUST MAC-REACHABLE 27 s
sisf-01 12
For this second part of the example, the configuration is as follows:
• Global configuration: max-entries=30, vlan-limit=25, port-limit=20, mac-limit=19.
• Policy-level configuration: limit address-count=14.
The limit that is reached first is the policy-level, limit address-count. A maximum of 14 IP addresses (IPv4
and 1Pv6) are allowed on the port or interface where policy "sisf-01" is applied. No further binding entries
are created after this. While the mac limit is configured with a lower absolute value (19), there are only 3
unique MAC address in the list of binding entries in the table - this limit is therefore not reached.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# limit address-count 14
Device(config-device-tracking)# end
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 14
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
After the stale lifetime of all the existing entries has expired and the entries have been removed from the
binding table, new entries are added according to the reconfigured values:
Device# show device-tracking database <<<<checking time left for stale-lifetime to expire
for existing entries.
Binding Table has 20 entries, 20 dynamic (limit 30)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.39 000c.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 316 s
ARP 192.0.9.38 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 279 s
ARP 192.0.9.37 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 308 s
ARP 192.0.9.36 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 274 s
ARP 192.0.9.35 000b.959d.6816 Te1/0/4 200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1686
Security
device-tracking binding
0064 13mn STALE try 0 279 s
ARP 192.0.9.34 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 261 s
ARP 192.0.9.33 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 258 s
ARP 192.0.9.32 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 263 s
ARP 192.0.9.31 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 266 s
ARP 192.0.9.30 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 273 s
ARP 192.0.9.29 000b.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 277 s
ARP 192.0.9.28 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 282 s
ARP 192.0.9.27 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 272 s
ARP 192.0.9.26 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 268 s
ARP 192.0.9.25 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 244 s
ARP 192.0.9.24 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 248 s
ARP 192.0.9.23 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 284 s
ARP 192.0.9.22 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 241 s
ARP 192.0.9.21 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 256 s
ARP 192.0.9.20 000a.959d.6816 Te1/0/4 200
0064 13mn STALE try 0 243 s
Device# show device-tracking database <<<no output indicates no entries in the database
Device# show device-tracking database details
Binding table configuration:
----------------------------
max/box : 30
max/vlan : 25
max/port : 20
max/mac : 19
Binding table current counters:
------------------------------
dynamic : 14
local : 0
total : 14
Binding table counters by state:
----------------------------------
REACHABLE : 14
total : 14
<output truncated>
Device# show device-tracking database
Binding Table has 14 entries, 14 dynamic (limit 30)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1687
Security
device-tracking binding
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.68 0001.5e00.53af Te1/0/4 200
0064 4s REACHABLE 48 s
ARP 192.0.9.67 0001.5e00.53af Te1/0/4 200
0064 4s REACHABLE 48 s
ARP 192.0.9.66 0001.5e00.53af Te1/0/4 200
0064 4s REACHABLE 47 s
ARP 192.0.9.65 0001.5e00.53af Te1/0/4 200
0064 4s REACHABLE 48 s
ARP 192.0.9.64 0001.5e00.53af Te1/0/4 200
0064 4s REACHABLE 46 s
ARP 192.0.9.63 0000.5e00.53af Te1/0/4 200
0064 7s REACHABLE 44 s
ARP 192.0.9.62 0000.5e00.53af Te1/0/4 200
0064 7s REACHABLE 45 s
ARP 192.0.9.61 0000.5e00.53af Te1/0/4 200
0064 7s REACHABLE 43 s
ARP 192.0.9.60 0000.5e00.53af Te1/0/4 200
0064 7s REACHABLE 44 s
ARP 192.0.9.59 0000.5e00.53af Te1/0/4 200
0064 7s REACHABLE 44 s
ARP 192.0.9.58 0000.5e00.53af Te1/0/4 200
0064 8s REACHABLE 44 s
ARP 192.0.9.57 0000.5e00.53af Te1/0/4 200
0064 8s REACHABLE 44 s
ARP 192.0.9.56 0000.5e00.53af Te1/0/4 200
0064 10s REACHABLE 41 s
ARP 192.0.9.55 0000.5e00.53af Te1/0/4 200
0064 10s REACHABLE 40 s
Device# show device-tracking database mac
MAC Interface vlan prlvl state Time left
Policy Input_index
0001.5e00.53af Te1/0/4 200 NO TRUST MAC-REACHABLE 30 s
sisf-01 12
0000.5e00.53af Te1/0/4 200 NO TRUST MAC-REACHABLE 30 s
sisf-01 12
Example: Setting VLAN, Port, and MAC Limits to Default Values
The following example shows you how to reset one or more limits to their default values.
Device(config)# device-tracking binding max-entries 30 vlan-limit 25 port-limit 20 mac-limit
19 <<<< all three limits configured.
Device(config)#exit
Device# show device-tracking database details
Binding table configuration:
----------------------------
max/box : 30
max/vlan : 25
max/port : 20
max/mac : 19
<output truncated>
Device# configure terminal
Device(config)# device-tracking binding max-entries 30 vlan-limit 25 <<<< only VLAN limit
configured; port-limit and mac-limit keywords leftout.
Device(config)# exit
Device# show device-tracking database details
Binding table configuration:
----------------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1688
Security
device-tracking binding
max/box : 30
max/vlan : 25
max/port : no limit <<<reset to default
max/mac : no limit <<<reset to default
Example: Global vs Policy-Level Limits Relating to MAC Addresses
The following example shows how precendence is determined for global and policy-level MAC limits. The
global value specifies the maximum number of entries allowed per MAC address. The policy-level IPv4 per
MAC and IPv6 per MAC limits, which may be present only in a programmatic policy, specify the number of
IPv4 and IPv6 addresses allowed per MAC address.
In the first part of the example, the global value (10 entries allowed per MAC address) is higher than the
policy-level setting (3 IPv4 addresses allowed for each MAC address). The Binding table current counters,
in the output of the show device-tracking database details privileged EXEC command shows that and the
limit that is reached first is the policy level limit.
Note No configuration is displayed for the policy-level setting, because you cannot configure the "IPv4 per mac"
or the "IPv6 per mac" in any policy. In this example, the DT-PROGRAMMATIC policy is applied to target
by configuring the ip dhcp snooping vlan vlan command in global configuration mode. The IPv4 per mac
limit exists, because the programmatically created policy has a limit for this parameter.
Device# configure terminal
Device(config)# ip dhcp snooping vlan 200
Device(config)# end
Device# show device-tracking policy DT-PROGRAMMATIC
Policy DT-PROGRAMMATIC configuration:
security-level glean (*)
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count for IPv4 per mac 3 (*)
tracking enable
Policy DT-PROGRAMMATIC is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT DT-PROGRAMMATIC Device-tracking vlan 200
note:
Binding entry Down timer: 24 hours (*)
Binding entry Stale timer: 24 hours (*)
Device(config)# device-tracking binding max-entries 50 mac-limit 10
Device# show device-tracking database details
Binding table configuration:
----------------------------
max/box : 50
max/vlan : no limit
max/port : no limit
max/mac : 10
Binding table current counters:
------------------------------
dynamic : 3
local : 0
total : 3
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1689
Security
device-tracking binding
Binding table counters by state:
----------------------------------
REACHABLE : 2
total : 3
Device# show device-tracking database
Binding Table has 3 entries, 3 dynamic (limit 50)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan prlvl
age state Time left
ARP 192.0.9.8 000a.959d.6816 Te1/0/4 200 0064
4s REACHABLE 25 s
ARP 192.0.9.7 000a.959d.6816 Te1/0/4 200 0064
4s REACHABLE 27 s
ARP 192.0.9.6 000a.959d.6816 Te1/0/4 200 0064
55s VERIFY 5s try 2
<<<<<<policy-level limit reached; only up to 3 IPv4 addresses per MAC address are allowed.
Device# show device-tracking database mac
MAC Interface vlan prlvl state Time left
Policy Input_index
000a.959d.6816 Te1/0/4 200 NO TRUST MAC-STALE 93585 s
DT-PROGRAMMATIC 12
In the second part of the example, the global value (2 entries allowed per MAC address) is lower than the
policy-level setting (3 IPv4 addresses allowed for each MAC address). The Binding table current counters,
in the output of the show device-tracking database details privileged EXEC command shows that and the
limit that is reached first is the policy level limit.
Device# show device-tracking policy DT-PROGRAMMATIC
Policy DT-PROGRAMMATIC configuration:
security-level glean (*)
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count for IPv4 per mac 3 (*)
tracking enable
Policy DT-PROGRAMMATIC is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT DT-PROGRAMMATIC Device-tracking vlan 200
note:
Binding entry Down timer: 24 hours (*)
Binding entry Stale timer: 24 hours (*)
Device(config)# device-tracking binding max-entries 50 mac-limit 2
Device# show device-tracking database details
Binding table configuration:
----------------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1690
Security
device-tracking binding
max/box : 50
max/vlan : no limit
max/port : no limit
max/mac : 2
Binding table current counters:
------------------------------
dynamic : 2
local : 0
total : 2
Binding table counters by state:
----------------------------------
REACHABLE : 2
total : 2
Device# show device-tracking database
Binding Table has 3 entries, 3 dynamic (limit 50)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan prlvl
age state Time left
ARP 192.0.9.3 000a.959d.6816 Te1/0/4 200 0064
5s REACHABLE 27 s
ARP 192.0.9.4 000a.959d.6816 Te1/0/4 200 0064
6s REACHABLE 20 s
<<<<<<global limit reached; only up to 2 binding entries per MAC address is allowed.
Device# show device-tracking database mac
MAC Interface vlan prlvl state Time left
Policy Input_index
000a.959d.6816 Te1/0/4 200 NO TRUST MAC-STALE 93585 s
DT-PROGRAMMATIC 12
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1691
Security
device-tracking logging
device-tracking logging
To log snooping security events like packet drops, unresolved packets, and suspected MAC or IP theft,
configure the device-tracking logging command in global configuration mode. To disable logging, enter the
no form of the command.
device-tracking logging [ packet drop | resolution-veto | theft ]
no device-tracking logging [ packet drop | resolution-veto | theft ]
Syntax Description packet drop Logs packet drop events.
resolution-veto Logs unresolved packet events.
theft Logs IP and MAC theft events.
Command Default Events are not logged.
Command Modes Global configuration [Device(config)# ]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines Logs generated for snooping security events have a severity level of 4 (meaning, warnings). For example:
%SISF-4-PAK_DROP: Message dropped A=FE80::20D:FF:FE0E:F G=- V=10 I=Tu0 P=NDP::RA Reason=Packet
not authorized on port
You can view snooping security logs by entering the show logging | include SISF-4 command in privileged
EXEC mode.
For information about the snooping events for which logs are generated, see the system message guide for
the corresponding release: System Message Guides. Search for SISF-4.
Packet Drop Events
When you configure the packet drop keyword, a log is generated everytime a packet is dropped. The log
also includes the reason for the packet drop. The reasons include and are not limited to the following:
• Packet not authorized on port: This means that a security feature dropped the packet because a
packet of this kind is not expected on the port, based on the configuration. Examples of such security
features and the situations in which a packet is dropped, include and are not limited to the following:
The Router Advertisement Guard feature may decide to drop IPv6 Router Advertisement packets if they
are received on ports that are not configured as router-facing ports. The DHCP Guard feature may drop
packets from DHCP server (DHCP OFFER or DHCP REPLY) if they are received on a port which is
not configured as server-facing port.
• Packet accepted but not forwarded: This means that the packet is not forwarded, but it is still
considered valid to glean binding information from. This is usually seen when packets from a host are
seen by SISF during the validation phase (while the binding is in a transitional state).
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1692
Security
device-tracking logging
• Malformed Packet dropped in Guard mode: This means that the incoming packet is malformed and
cannot be parsed properly.
• Packet is throttled: This means the packet was dropped because it exceeds the throttling limit for
packets within a time interval. The system allows a maximum of 50 packets in 5 seconds.
• Silent drop: This happens to packets that are generated either by device-tracking instances to
communicate among the different instances across multiple switches, or as a response to an action trigged
by device-tracking. For instance, a response on the probe that was initiated by the device-tracking, to
determine the reachability status of the host reachability.
• Martian packet: This means that the incoming packet was dropped because it has Martian source IP
address, such as, a multicast, loopback, or unspecified address.
• Martian mac: This means that the incoming packet was dropped because it has a Martian MAC or
Link-Layer source address.
• Address limit per box reached: This means that the incoming packet was dropped, because the limit
configured with the device-tracking binding max-entries no_of_entries global configuration command,
was reached. Enter the show device-tracking database details privileged EXEC command to display
current limits.
• Address limit per vlan reached: This means that the incoming packet was dropped, because the
limit configured with the device-tracking binding max-entries no_of_entries vlan-limit no_of_entries
global configuration command, was reached. Enter the show device-tracking database details privileged
EXEC command to display current limits.
• Address limit per port reached: This means that the incoming packet was dropped, because the
limit configured with the device-tracking binding max-entries no_of_entries port-limit no_of_entries
global configuration command, was reached. Enter the show device-tracking database details privileged
EXEC command to display current limits.
• Address limit per policy reached : This means that the incoming packet was dropped, because the
limit configured with the limit address-count ip-per-port keyword in the device-tracking configuration
mode was reached. This is configured at a policy level. Enter the show device-tracking policypolicy-name
privileged EXEC command to display current limits.
• Address limit per mac reached: This means that the incoming packet was dropped, because the limit
configured with the device-tracking binding max-entries no_of_entries mac-limit no_of_entries global
configuration command, was reached. Enter the show device-tracking database details privileged
EXEC command to display current limits.
• Address Family limit per mac reached: This means that the incoming packet was dropped, because
the IPv4 per MAC or IPv6 per MAC limit specified in a programmatic policy was reached. You cannot
configure this policy parameter; a programmatically created policy may have either an IPv4 per MAC
limit, or an IPv6 per MAC limit, or both, or neither. Enter the show device-tracking policypolicy-name
privileged EXEC command to display the limit if it exists.
Resolution Veto Events
When you configure the resolution-veto keyword, a log is generated for every unresolved packet. This logging
option meant to be used only if the IPv6 Destination Guard feature is also enabled.
The IPv6 Destination Guard feature ensures that the device performs address resolution only for those addresses
that are known to be active on the link. All destinations that are active on the link are entered in the binding
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1693
Security
device-tracking logging
table. When a destination is not found in the binding table, address resolution is prevented. By configuring
resolution-veto logging you can keep track of such unresolved packets.
If the resolution-veto keyword is configured and the the IPv6 Destination Guard feature is not, logs are not
generated.
Theft Events
When you configure the theft keyword, a log is generated when SISF detects an IP theft, or a MAC theft or
both.
In the log, verified binding information (IP, MAC address, interface or VLAN) is preceded by the term
"Known" . A suspicious IP address and MAC address is preceded by the term "New" or "Cand". Interface
and VLAN information is also provided along with the suspiscious IP or MAC address - this helps you identify
where the suspiscious traffic was seen.
For example, see the following MAC theft log:
%SISF-4-MAC_THEFT: MAC Theft Cand IP=2001::12B VLAN=70 MAC=9cfc.e85e.139d Cand I/F=Gi1/0/4
Known IP=71.0.0.96 Known I/F=Ac0
These snippets of the log show the IP address of the suspiscious host and the interface on which it was seen:
Cand IP=2001::12B, VLAN=70, Cand I/F=Gi1/0/4.
This snippet of the log shows the known MAC address, which the suspiscious host is using:
MAC=9cfc.e85e.139d.
These snippets of the log show the IP address and interface of the existing, verified entry: Known IP=71.0.0.96
and Known I/F=Ac0.
Examples
• Example: Packet Drop Logs, on page 1694
• Example: Theft Logs, on page 1694
Example: Packet Drop Logs
The following are examples of logs generated for packet drop events:
%SISF-4-PAK_DROP: Message dropped A=FE80::20D:FF:FE0E:F G=- V=10 I=Tu0 P=NDP::RA Reason=Packet
not authorized on port
%SISF-4-PAK_DROP: Message dropped A=20.0.0.1 M=dead.beef.0001 V=20 I=Gi1/0/23 P=ARP
Reason=Packet accepted but not forwarded
Example: Theft Logs
The following are examples of logs generated for IP and MAC theft events:
%SISF-4-MAC_AND_IP_THEFT: MAC_AND_IP Theft A=FE80::EE1D:8BFF:FE9B:102 V=102 I=Vl102
M=ec1d.8b9b.0102 New=Tu0
%SISF-4-MAC_THEFT: MAC Theft IP=192.2.1.2 VLAN=102 MAC=cafe.cafe.cafe I/F=Gi1/0/3 New I/F
over fabric
%SISF-4-IP_THEFT: IP Theft IP=FE80::9873:1D5E:E6E9:1F7E VLAN=20 MAC=2079.18d5.13ad IF=Ac0
New I/F over fabric
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1694
Security
device-tracking logging
%SISF-4-IP_THEFT: IP Theft IP=10.0.187.5 VLAN=10 Cand-MAC=0069.0000.0001 Cand-I/F=Gi1/0/23
Known MAC over-fabric Known I/F over-fabric
%SISF-4-MAC_THEFT: MAC Theft Cand IP=2001::12B VLAN=70 MAC=9cfc.e85e.139d Cand I/F=Gi1/0/4
Known IP=71.0.0.96 Known I/F=Ac0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1695
Security
device-tracking policy
device-tracking policy
To create a custom device-tracking policy, and to enter the device-tracking configuration mode to configure
the various parameter of the policy, enter the device-tracking policy command in global configuration mode.
To delete a device tracking policy, use the no form of this command.
device-tracking policy policy-name
no device-tracking policy policy-name
Syntax Description policy-name Creates a device-tracking policy with the specified name - if it doesn't already exist. You can
also specify the name of a programmatically created policy.
After you configure a policy name, the device enters the device-tracking configuration mode,
where you can configure policy parameters. Enter a question mark (?) at the system prompt
to see the list of policy parameters that can be configured.
Command Default SISF-based device tracking is disabled.
Command Modes Global configuration [Device(config)# ]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Everest 16.6.1 Option to change certain parameters of programmatic policy
DT_PROGRAMMATIC was introduced.
Cisco IOS XE Fuji 16.9.1 The option to change the parameters of any programmatic policy was
deprecated.
Usage Guidelines When you enter the device-tracking policypolicy-name command in global configuration mode, the system
creates a custom policy with the specified name (if it does not already exist) and enters the device-tracking
configuration mode. In this mode, you can configure policy parameters.
After you create a policy and configure its parameters, you must attach it to an interface or VLAN. Only then
does the activity of extracting binding information (IP and MAC address) from packets that enter the network
and the creation of binding entries, actually begin. For more information about attaching a policy, see
device-tracking (interface config), on page 1666device-tracking (VLAN config), on page 1669.
To display detailed information about all the policies available on the device and the targets they are attached
to, enter the show device-tracking policies detail command in privileged EXEC mode.
Configuring Policy Parameters
You can configure the parameters of a policy only if it is a custom policy. You cannot change the parameters
of a programmatic policy. You also cannot change the parameters of the default policy.
To display the list of parameters for a policy, enter a question mark (?) at the system prompt in device-tracking
configuration mode:
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# ?
device-tracking policy configuration mode:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1696
Security
device-tracking policy
data-glean binding recovery by data traffic source address
gleaning
default Set a command to its defaults
destination-glean binding recovery by data traffic destination address
gleaning
device-role Sets the role of the device attached to the port
distribution-switch Distribution switch to sync with
exit Exit from device-tracking policy configuration mode
limit Specifies a limit
medium-type-wireless Force medium type to wireless
no Negate a command or set its defaults
prefix-glean Glean prefixes in RA and DHCP-PD traffic
protocol Sets the protocol to glean (default all)
security-level setup security level
tracking Override default tracking behavior
trusted-port setup trusted port
vpc setup vpc port
Keyword Description
data-glean Enables learning of addresses from a data packet snooped from a source
inside the network and populates the binding table with the data traffic
source address. Enter one of these options:
• log-only: Generates a syslog message upon data packet notification.
• recovery: Uses a protocol to enable binding table recovery. Enter
NDP or DHCP.
default Sets the policy paramter to its default value. You can set these policy
attributes to their default values:
• data-glean: Source address is not learnt or gleaned.
• destination-glean: Destination address is not learnt or gleaned
• device-role: Node.
• distribution-switch: Not supported.
• limit: An address count limit is not set.
• medium-type-wireless: <tbd>
• prefix-glean: Prefixes are not learnt.
• protocol: Addresses of all protocols (ARP, DHCP4, DHCP6, NDP,
and UDP) are gleaned.
• security-level: Guard.
• tracking: Polling is disabled.
• trusted-port: Disabled, that is, the guard function is enabled on
the configured target)
• vpc: Not supported.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1697
Security
device-tracking policy
Keyword Description
destination-glean Enables population of the binding table by gleaning the destination
address of data traffic. Enter one of these options:
• log-only: Generates a syslog message upon data packet notification.
• recovery: Uses a protocol to enable binding table recovery. Enter
NDP or DHCP.
device-role Indicates the type of device that is facing the port and this can be one
of the following:
• node: Allows creation of binding entries for a port.
• switch: Stops the creation of binding entries for a port. This option
is suited to multi-switch set-ups, where the possibility of large
device tracking tables is very high. Here, a port facing a device (an
uplink trunk port) can be configured to stop creating binding entries,
and the traffic arriving at such a port can be trusted, because the
switch on the other side of the trunk port will have device tracking
enabled and that will have checked the validity of the binding entry.
This option is commonly used along with the trusted-port
keyword. Configuring both the device-role and trusted-port
options on an uplink trunk port helps build an efficient and scalable
“secure zone”. Both parameters must be configured to achieve an
efficient distribution of the creation of binding table entries (thus
keeping the binding tables smaller).
distribution-switch Although visible on the CLI, this keyword is not supported. Any
configuration does not take effect.
exit Exits the device-tracking configuration mode and returns to global
configuration mode.
limit address-count Configures the maximum number of number of IPv4 and IPv6 addresses
to be allowed per port. The purpose of this limit is to ensure that binding
entries are restricted to only known and expected hosts.
ip-per-port: Enter the maximum number of IP addresses you want to
allow on a port. This limit applies to IPv4 and IPv6 addresses as a whole.
When the limit is reached, no further IP addresses can be added to the
binding table, and traffic from new hosts are dropped.
Enter a value between 1 and 32000.
medium-type-wireless Although visible on the CLI, this keyword is not supported. Any
configuration does not take effect.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1698
Security
device-tracking policy
Keyword Description
no Negates the command, that is, reverts a policy parameter to its default
value.
For information about what the default value is, see the default keyword.
• data-glean
• destination-glean
• device-role
• distribution-switch: Not supported.
• limit address-count
• medium-type-wireless
• prefix-glean
• protocol
• security-level
• tracking
• trusted-port
• vpc: Not supported.
prefix-glean only Enables learning of prefixes from either IPv6 Router Advertisements
or from DHCP-PD. You have the following option:
(Optional) only: Gleans only prefixes and not host addresses.
protocol Gleans addresses of specified protocols. By default, all are gleaned.
Enter one of these options:
• arp [prefix-list name]: Gleans addresses in ARP packets.
Optionally, enter the name of prefix-list that is to be matched.
• dhcp4 [prefix-list name]: Gleans addresses in DHCPv4 packets.
Optionally, enter the name of prefix-list that is to be matched.
• dhcp6 [prefix-list name]: Gleans addresses in DHCPv6 packets.
Optionally, enter the name of prefix-list that is to be matched.
• ndp [prefix-list name]: Gleans addresses in NDP packets.
Optionally, enter the name of prefix-list that is to be matched.
• udp [prefix-list name]: Although visible on the CLI, this option
is not supported. Any configuration does not take effect.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1699
Security
device-tracking policy
Keyword Description
security-level Specifies the level of security that is enforced. When a packet enters the
network, SISF extracts the IP and MAC address (the source of the
packet) and subsequent action, is dictated by the security level configured
in the policy.
Enter one of these options:
• glean: Extracts the IP and MAC address and enters them into the
binding table, without any verification. Use this option if you want
to only learn about the host and not rely on SISF for authentication
of the binding entry.
• guard: Extracts the IP and MAC address and checks this
information against the binding table. The outcome of the
verification determines if a binding entry is added, or updated, or
if the packet is dropped and the client is rejected
This is the default value for the security-level parameter.
• inspect: Although this keyword is available on the CLI, we
recommend not using it. The glean and guard options described
above address most use cases and network requirements.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1700
Security
device-tracking policy
Keyword Description
tracking Determines if an entry is polled after the reachable lifetime expires.
Polling is a periodic and conditional checking of the host to see the state
it is in, whether it is still connected, and whether it is communicating.
For more information about polling, see the Usage Guidelines below.
By default, polling is not enabled.
Enter one of these options:
• disable : Turns off polling action.
[stale-lifetime {seconds | infinite} ]: Optionally you can also
configure a stale-lifetime. If you do, configure one of the following
for the stale-lifetime timer:
• seconds: Configure a value for the stale-lifetime timer. Enter
a value between 1 and 86400 seconds. The default value is
86400 seconds (24 hours).
• infinite: Disables the timer for the STALE state. This means
that a timer is not started when an entry enters the STALE
state and the entry remains in the STALE state, indefinitely.
• enable: Turns on polling action.
[reachable-lifetime [seconds | infinite] ]: Optionally you can also
configure a reachable-lifetime. If you do, configure one of the
following for the reachable-lifetime timer:
• seconds: Configure a value for the reachable-lifetime timer.
Enter a value between 1 and 86400 seconds. The default value
is 300 seconds (5 minutes).
• infinite: Disables the timer for the REACHABLE state. This
means that a timer is not started when an entry enters the
REACHABLE state and the entry remains in the
REACHABLE state, indefinitely.
trusted-port This option disables the guard function on configured targets. Bindings
learned through a trusted-port have preference over bindings learned
through any other port. A trusted port is also given preference in case
of a collision while making an entry in the table.
This option is commonly used along with the device-role keyword.
Configuring both the device-role and trusted-port options on an uplink
trunk port helps achieve an efficient distribution of the creation of
binding table entries (thus keeping the binding tables smaller).
vpc Although visible on the CLI, this option is not supported. Any
configuration does not take effect.
Global versus Poicy-Level Settings
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1701
Security
device-tracking policy
You configure policy parameters in the device-tracking configuration mode and what you configure for a
policy applies only to that policy. Some of the policy parameters have counterparts in the global configuration
mode. For detailed information about the parameters that have global-level counterparts and to know which
value takes precendence (whether the globally configured or the policy-level value), see: device-tracking
binding, on page 1672.
Polling a Host
If you configure the tracking policy parameter, the switch sends a polling request after the reachable lifetime
expires. The switch polls the host up to 3 times at fixed, system-determined intervals. You can also specify
an interval by using the device-tracking tracking retry-interval seconds command in global configuration
mode. The polling request is in the form of an Address Resolution Protocol (ARP) probe or a Neighbor
Solicitation message. During this time the state of the entry changes to VERIFY.
If a polling response is received (thus confirming reachability of the host), the state of the entry changes back
to REACHABLE. If the switch does not receive a polling response after 3 attempts, the entry changes to the
STALE state.
Note Using the tracking policy parameter, you can enable or disable polling at a policy-level regardless of whether
the polling is enabled or disabled at the global configuration level (the device-tracking tracking command
in global configuration mode. See Example: Disabling Polling at a Policy-Level, on page 1703and device-tracking
tracking, on page 1709.
Changing the Limit Address-Count
If you configure a limit using the limit address-count policy parameter and then change it - the new limit is
applicable only to entries learned after the change. Further, regardless of whether the new limit is higher or
lower than the previous limit, existing entries are not affected and are allowed to go through their binding
entry lifecycle.
If the binding table is full (in accordance with the previous limit), any new entries are not added until the
existing entries complete their lifecycle. SISF attempts to create space for new entries by identifying and
removing only inactive entries . But if the entries are active, they are not removed and are allowed to go
through their binding entry lifecycle.
If you want to make the new lower limit take effect immediately, you can use either one of these options:
• Enter the clear device-tracking database command in privileged EXEC mode and specify an interface
or VLAN. This removes all existing entries from the database of only the specified target. New entries
are then learned and added as per the current limit address-count settings. See Example: Changing the
Address Count Limit, on page 1703.
• Remove and reattach the policy on the required target. Enter the no device-tracking policypolicy-name
command in interface or VLAN configuration mode to remove the policy. Removing the policy from an
interface or VLAN removes the bindings that are attached to the target. Enter the device-tracking
policypolicy-name command in interface or VLAN configuration mode to reattach it. Reattaching the
policy causes learning of all the binding entries according to the new limit.
Examples
• Example: Disabling Polling at a Policy-Level, on page 1703
• Example: Changing the Address Count Limit, on page 1703
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1702
Security
device-tracking policy
Example: Disabling Polling at a Policy-Level
The following example shows how you can disable polling at the policy-level even if polling is
enabled at the global level. Here, polling is disabled for all interfaces and VLANs were policy sisf-01
is applied.
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# device-tracking tracking
Device(config)# exit
Device# show running-config | include device-tracking device-tracking tracking
device-tracking policy sisf-01
device-tracking attach-policy sisf-01
device-tracking attach-policy sisf-01 vlan 200
device-tracking binding reachable-lifetime 700 stale-lifetime 1000 down-lifetime 200
device-tracking binding logging
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# tracking disable
Device(config-device-tracking)# end
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 5
tracking disable
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
vlan 200 VLAN sisf-01 Device-tracking vlan all
Example: Changing the Address Count Limit
The following example shows you how to make a change in the limit address-count policy parameter
setting take effect immediately. In this example, the clear command is used to remove all entries
from the binding table for the changed settings to take effect immediately.
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 25
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
vlan 200 VLAN sisf-01 Device-tracking vlan all
Device# show running-config | include device-tracking
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1703
Security
device-tracking policy
device-tracking policy sisf-01
device-tracking attach-policy sisf-01
device-tracking attach-policy sisf-01 vlan 200
device-tracking binding reachable-lifetime 700 stale-lifetime 1000 down-lifetime 200
device-tracking binding logging
*Dec 13 15:08:50.723: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.25 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.723: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.26 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.724: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.27 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.724: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.28 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.724: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.29 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.724: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.30 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.725: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.31 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.725: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.32 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.725: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.33 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.725: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.34 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.726: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.35 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.726: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.36 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.726: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.37 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.726: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.38 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.727: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.39 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.727: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.40 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.727: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.41 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.727: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.42 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.728: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.43 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.728: %SISF-6-ENTRY_MAX_ORANGE: Reaching 80% of max adr allowed per policy
(25) V=200 I=Te1/0/4 M=001d.4411.3ab7
*Dec 13 15:08:50.728: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.44 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.728: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.45 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.728: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.46 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.729: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.47 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.729: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.48 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:08:50.729: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.49 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
Device# show device-tracking database Binding Table has 25 entries, 25 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1704
Security
device-tracking policy
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.49 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 699 s
ARP 192.0.9.48 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 691 s
ARP 192.0.9.47 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 687 s
ARP 192.0.9.46 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 714 s
ARP 192.0.9.45 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 692 s
ARP 192.0.9.44 001d.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 702 s
ARP 192.0.9.43 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 680 s
ARP 192.0.9.42 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.41 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.40 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.39 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 710 s
ARP 192.0.9.38 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 697 s
ARP 192.0.9.37 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 707 s
ARP 192.0.9.36 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 695 s
ARP 192.0.9.35 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 708 s
ARP 192.0.9.34 001c.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 706 s
ARP 192.0.9.33 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.32 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 697 s
ARP 192.0.9.31 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 683 s
ARP 192.0.9.30 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 678 s
ARP 192.0.9.29 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 696 s
ARP 192.0.9.28 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 704 s
ARP 192.0.9.27 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 713 s
ARP 192.0.9.26 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 695 s
ARP 192.0.9.25 001b.4411.3ab7 Te1/0/4 200
00FF 22s REACHABLE 686 s
The address count limit is changed from 25 to a lower limit of 5. But because the existing entries
have not completed their binding entry lifecycle, they are not deleted from the binding table. In order
to make the new address count limit of 5 take effect immediately, the clear device-tracking database
command is used to delete all existing entries. New entries are then learned and added as per the
current limit address-count settings.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1705
Security
device-tracking policy
Device# configure terminal
Device(config)# device-tracking policy sisf-01
Device(config-device-tracking)# limit address-count 5
Device(config-device-tracking)# end
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
limit address-count 5
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
vlan 200 VLAN sisf-01 Device-tracking vlan all
Device# show device-tracking database
Binding Table has 25 entries, 25 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.49 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 654 s
ARP 192.0.9.48 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 646 s
ARP 192.0.9.47 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 642 s
ARP 192.0.9.46 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 669 s
ARP 192.0.9.45 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 647 s
ARP 192.0.9.44 001d.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 657 s
ARP 192.0.9.43 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 635 s
ARP 192.0.9.42 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 663 s
ARP 192.0.9.41 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 638 s
ARP 192.0.9.40 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 663 s
ARP 192.0.9.39 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 665 s
ARP 192.0.9.38 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 652 s
ARP 192.0.9.37 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 662 s
ARP 192.0.9.36 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 650 s
ARP 192.0.9.35 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 663 s
ARP 192.0.9.34 001c.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 661 s
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1706
Security
device-tracking policy
ARP 192.0.9.33 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 637 s
ARP 192.0.9.32 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 652 s
ARP 192.0.9.31 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 638 s
ARP 192.0.9.30 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 633 s
ARP 192.0.9.29 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 651 s
ARP 192.0.9.28 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 658 s
ARP 192.0.9.27 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 668 s
ARP 192.0.9.26 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 650 s
ARP 192.0.9.25 001b.4411.3ab7 Te1/0/4 200
00FF 67s REACHABLE 641 s
Device# clear device-tracking database
*Dec 13 15:10:22.837: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.49 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.48 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.47 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.838: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.46 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.45 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.44 VLAN=200
MAC=001d.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.43 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.839: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.42 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.41 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.40 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.840: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.39 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.38 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.37 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.841: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.36 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.35 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.34 VLAN=200
MAC=001c.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.33 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.842: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.32 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.31 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.30 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.843: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.29 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.28 VLAN=200
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1707
Security
device-tracking policy
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.27 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.26 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:10:22.844: %SISF-6-ENTRY_DELETED: Entry deleted IP=192.0.9.25 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
Device# show device-tracking database
<no output; binding table cleared>
*Dec 13 15:11:38.346: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.25 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:11:38.346: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.26 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:11:38.347: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.27 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:11:38.347: %SISF-6-ENTRY_MAX_ORANGE: Reaching 80% of max adr allowed per policy
(5) V=200 I=Te1/0/4 M=001b.4411.3ab7
*Dec 13 15:11:38.347: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.28 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
*Dec 13 15:11:38.347: %SISF-6-ENTRY_CREATED: Entry created IP=192.0.9.29 VLAN=200
MAC=001b.4411.3ab7 I/F=Te1/0/4 Preflevel=00FF
Device# show device-tracking database
Binding Table has 5 entries, 5 dynamic (limit 200000)
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface vlan
prlvl age state Time left
ARP 192.0.9.29 001b.4411.3ab7 Te1/0/4 200
00FF 15s REACHABLE 716 s
ARP 192.0.9.28 001b.4411.3ab7 Te1/0/4 200
00FF 15s REACHABLE 702 s
ARP 192.0.9.27 001b.4411.3ab7 Te1/0/4 200
00FF 15s REACHABLE 705 s
ARP 192.0.9.26 001b.4411.3ab7 Te1/0/4 200
00FF 15s REACHABLE 716 s
ARP 192.0.9.25 001b.4411.3ab7 Te1/0/4 200
00FF 15s REACHABLE 718 s
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1708
Security
device-tracking tracking
device-tracking tracking
To enable polling for IPv4 and IPv6 and configure the polling parameters, configure the device-tracking
tracking command in global configuration mode. To disable polling, enter the no form of the command.
Note This command does not enable the SISF-based device-tracking feature. It enables configuration of polling
parameters on a device where the device-tracking feature is enabled.
device-tracking tracking [ auto-source [ fallback ipv4_and_fallback_source_mask ip_prefix_mask [
override ] | retry-interval seconds ]
no device-tracking tracking [ auto-source | retry-interval ]
Syntax Description auto-source Causes the source address of an Address Resolution Protocol
(ARP) probe to be sourced in the following order of
preference:
• The first preference is to set the source address to the
VLAN SVI, if an SVI is configured.
• The second preference is to locate an IP-MAC binding
entry in device-tracking table, from same subnet and
use that as the source address.
• The third and last preference is to use 0.0.0.0 as the
source address.
fallback Causes the source address of an ARP probe to be sourced
ipv4_and_fallback_source_maskip_prefix_mask in the following order of preference:
• The first preference is to set the source address to the
VLAN SVI, if an SVI is configured.
• The second preference is to locate an IP-MAC binding
entry in device-tracking table, from same subnet and
use that as the source address.
• The third and last preference is to compute the source
address from the client's IPv4 address and the mask
provided.
The source MAC address is taken from the MAC
address of the switchport facing the client.
If you configure the fallback keyword, you must also
specify an IP address and mask.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1709
Security
device-tracking tracking
override Causes the source address of an ARP probe to be sourced
in the following order of preference:
• The first preference is to set the source address to the
VLAN SVI, if this is configured.
• The second and last preference is to use 0.0.0.0 as the
source address.
Note This keyword configures SISF to not select
the source address from the binding table. We
do not recommend using this option if an SVI
is not configured.
retry-interval seconds Configures a multiplicative factor or "base value", for the
backoff algorithm. The backoff algorithm determines the
wait time between the 3 polling attempts that occur after
reachable lifetime expiry.
Enter a value between 1 and 3600 seconds. The default
value is one.
When polling, there is an increasing wait time between the
3 polling attempts or retries. The backoff algorithm
determines this wait time. The value you configure for the
retry interval is multiplied by the backoff algorithm's wait
time.
For example, if the backoff algorithm determines a wait
time of 2, 4, and 6 seconds between the 3 attempts
respectively, and you configure a retry interval of 2 seconds,
the actual interval you will observe is as follows: 2*2
seconds of wait time before the first polling attempt, 2*4
seconds for the second polling attempt and 2*6 for the third
polling attempt.
If polling is enabled, but a retry interval is not configured,
the switch polls the host up to 3 times at system-determined
intervals.
This configuration applies to ARP probes and Neighbor
Solicitation messages.
Command Default Polling is disabled by default.
Command Modes Global configuration [Device(config)# ]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1710
Security
device-tracking tracking
Usage Guidelines Polling is a periodic and conditional checking of the host to see the state it is in, whether it is still connected,
and whether it is communicating. Polling enables you to assess the continued presence of a tracked device.
Polling occurs at these junctures: 3 times after the reachable lifetime timer expires, and a final attempt at stale
lifetime expiry.
• In an IPv4 network, polling is in the form of an ARP probe. Here, the switch sends unicast ARP probes
to the connected host, to determine the host's reachability status. When sending ARP probes, the system
constructs packets according to RFC 5227 specifications.
• In an IPv6 network, polling is in the form of a Neighbor Solicitation message. Here, the switch verifies
reachability of a connected host by using the unicast address of the connected host as the destination
address.
Configure the device-tracking tracking command in global configuration mode, to enable polling for IPv4
and IPv6.
Also configure the retry-interval seconds to configure the polling interval after reachable lifetime timer
expiry.
Note The auto-source, fallback ipv4_and_fallback_source_maskip_prefix_mask , and override keywords apply
only to ARP probes and not Neighbor Solicitation messages.
The value you configure for retry-interval seconds keywords applies to both IPv4 and IPv6.
Enter the show running-config | include device-tracking display current polling settings. For example:
Device# show running-config | include device-tracking
device-tracking tracking retry-interval 2
device-tracking policy sisf-01
device-tracking attach-policy sisf-01 vlan 200
device-tracking binding reachable-lifetime 50 stale-lifetime 150 down-lifetime 30
device-tracking binding logging
Enter the show device-tracking database command in privileged EXEC mode, to display the duration of the
various lifetimes of an entry. While polling, the system changes the state of the entry to VERIFY. Check the
Time left column in the output to observe the duration.
When you track the reachable and stale lifetime of an entry with the show device-tracking database command,
and polling is enabled, you may notice that the STALE lifetime is sometimes shorter than what you have
configured. This is because the time required for polling is subtracted from the stale lifetime.
Global versus Policy-Level Settings for Polling
After you configure device-tracking tracking command in global configuration mode, you still have the
flexibility to turn polling on or off, for individual interfaces and VLANs. For this you must enable or disable
polling in the policy. Note how the global and policy-level settings interact:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1711
Security
device-tracking tracking
Global Setting Policy-Level Setting Result
Polling is enabled at the global Polling is enabled on an interface Polling is effective on the interface
level. or VLAN. or VLAN.
Device(config)# Device(config-device-tracking)#
device-tracking tracking tracking enable
Polling is disabled on an interface Polling is not effective on the
or VLAN. interface or VLAN.
Device(config-device-tracking)#
tracking disable
Default polling is configured on the Because polling is enabled at the
interface or VLAN. global config level, polling is
effective on the interface or VLAN.
Device(config-device-tracking)#
default tracking
The no form of the command is The no form of the command sets
configured on the interface or the command to its default. But
VLAN. because polling is enabled at the
global config level, polling is
Device(config-device-tracking)#
effective on the interface or VLAN.
no tracking
Polling is disabled at the global Polling is enabled on an interface Polling is effective on the interface
level. or VLAN. or VLAN.
Device(config)# no Device(config-device-tracking)#
device-tracking tracking tracking enable
Polling is disabled on an interface Polling is not effective on the
or VLAN. interface or VLAN.
Device(config-device-tracking)#
tracking disable
Default polling is configured on the Polling is not effective on the
interface or VLAN. interface or VLAN.
Device(config-device-tracking)#
default tracking
The no form of the command is Polling is not effective on the
configured on the interface or interface or VLAN.
VLAN.
Device(config-device-tracking)#
no tracking
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1712
Security
device-tracking upgrade-cli
device-tracking upgrade-cli
To convert legacy IP Device Tracking (IPDT) and IPv6 Snooping commands to SISF commands, configure
the device-tracking upgrade-cli command in global configuration mode. To revert to legacy commands,
enter the no form of the command.
device-tracking upgrade-cli [ force | revert ]
no device-tracking upgrade-cli [ force | revert ]
Syntax Description force Skips the confirmation step and converts legacy IPDT and IPv6 Snooping commands to SISF
commands.
revert Reverts to legacy IPDT and IPv6 Snooping commands.
Command Default Legacy IPDT and IPv6 Snooping commands remain as-is.
Command Modes Global configuration [Device(config)# ]
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Based on the legacy configuration that exists on your device, the device-tracking upgrade-cli command
upgrades your CLI differently. Consider the following configuration scenarios and the corresponding migration
results before you migrate your existing configuration.
Note You cannot configure a mix of the old IPDT and IPv6 snooping CLI with the SISF-based device tracking
CLI.
Only IPDT Configuration Exists
If your device has only IPDT configuration, running the device-tracking upgrade-cli command converts the
configuration to use the new SISF policy that is created and attached to the interface. You can then update
this SISF policy.
If you continue to use the legacy commands, this restricts you to operate in a legacy mode where only the
legacy IPDT and IPv6 snooping commands are available on the device.
Only IPv6 Snooping Configuration Exists
On a device with existing IPv6 snooping configuration, the old IPv6 Snooping commands are available for
further configuration. The following options are available:
• (Recommended) Use the device-tracking upgrade-cli command to convert all your legacy configuration
to the new SISF-based device tracking commands. After conversion, only the new device tracking
commands will work on your device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1713
Security
device-tracking upgrade-cli
• Use the legacy IPv6 Snooping commands for your future configuration and do not run the device-tracking
upgrade-cli command. With this option, only the legacy IPv6 Snooping commands are available on your
device, and you cannot use the new SISF-based device tracking CLI commands.
Both IPDT and IPv6 Snooping Configuration Exist
On a device that has both legacy IPDT configuration and IPv6 snooping configuration, you can convert legacy
commands to the SISF-based device tracking CLI commands. However, note that only one snooping policy
can be attached to an interface, and the IPv6 snooping policy parameters override the IPDT settings.
Note If you do not migrate to the new SISF-based commands and continue to use the legacy IPv6 snooping or IPDT
commands, your IPv4 device tracking configuration information may be displayed in the IPv6 snooping
commands, as the SISF-based device tracking feature handles both IPv4 and IPv6 configuration. To avoid
this, we recommend that you convert your legacy configuration to SISF-based device tracking commands.
No IPDT or IPv6 Snooping Configuration Exists
If your device has no legacy IP Device Tracking or IPv6 Snooping configurations, you can use only the new
SISF-based device tracking commands for all your future configuration. The legacy IPDT commands and
IPv6 snooping commands are not available.
Examples
The following example shows you how to convert IPv6 Snooping commands to SISF-based
device-tracking commands.
Device# show ipv6 snooping features
Feature name priority state
Device-tracking 128 READY
Source guard 32 READY
Device# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Device(config)# device-tracking upgrade-cli
IPv6 Snooping and IPv4 device tracking CLI will be
converted to the new top level device-tracking CLI
Are you sure ? [yes]: yes
Number of Snooping Policies Upgraded: 2
Device(config)# exit
After conversion, only the new SISF-based device-tracking commands will work on your device:
Device# show ipv6 snooping features
^
% Invalid input detected at '^' marker.
Device# show device-tracking features
Feature name priority state
Device-tracking 128 READY
Source guard 32 READY
Device# show device-tracking policies
Target Type Policy Feature Target range
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1714
Security
device-tracking upgrade-cli
Te1/0/4 PORT sisf-01 Device-tracking vlan 200
vlan 200 VLAN sisf-01 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1715
Security
dnscrypt (Parameter Map)
dnscrypt (Parameter Map)
To enable Domain Name System (DNS) packet encryption for authenticating communications between a
Cisco device and the Cisco Umbrella Integration feature, use the dnscrypt command in parameter-map type
inspect configuration mode. To disable DNS packet encryption, use the no form of this command.
dnscrypt
no dnscrypt
Syntax Description This command has no arguments or keywords.
Command Default DNS packet encyrption for umbrella mode is not configured.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines When DNSCrypt is used, the DNS request packets' size is more than 512 bytes. Ensure that these packets are
allowed through the intermediary devices; otherwise, the response may not reach the intended recipients.
Examples The following example shows how to enable DNS packet encryption:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)# dnscrypt
Related Commands Command Description
parameter-map type umbrella global Configures a parameter map type in umbrella mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1716
Security
dot1x authenticator eap profile
dot1x authenticator eap profile
To configure the Extensible Authentication Protocol (EAP) profile to use during 802.1x authentication, use
the dot1x authenticator eap profile command in interface configuration mode. To disable the EAP profile,
use the no form of this command.
dot1x authenticator eap profile [name]
no dot1x authenticator eap profile
Syntax Description name EAP authenticator profile name.
Command Default EAP profile is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Cupertino 17.7.1 This command was introduced.
Usage Guidelines You must enter the switchport mode access command on a switch port before entering this command.
The following example shows how to configure Cisco TrustSec manual configuration and 802.1x
configurations together:
Device(config)# interface gigabitethernet 1/0/1
Device(config-if)# switchport mode access
Device(config-if)# cts manual
Device(config-if-cts-manual)# propagate sgt
Device(config-if-cts-manual)# policy static sgt 77 trusted
Device(config-if-cts-manual)# exit
Device(config-if)# dot1x pae authenticator
Device(config-if)# dot1x authenticator eap profile md5
Related Commands Command Description
switchport mode access Sets the trunking mode to access m
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1717
Security
dot1x critical (global configuration)
dot1x critical (global configuration)
To configure the IEEE 802.1X critical authentication parameters, use the dot1x critical command in global
configuration mode.
dot1x critical eapol
Syntax Description eapol Specifies that the switch send an EAPOL-Success message when the device successfully authenticates
the critical port.
Command Default eapol is disabled
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This example shows how to specify that the device sends an EAPOL-Success message when the
device successfully authenticates the critical port:
Device> enable
Device# configure terminal
Device(config)# dot1x critical eapol
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1718
Security
dot1x logging verbose
dot1x logging verbose
To filter detailed information from 802.1x system messages, use the dot1x logging verbose command in
global configuration mode on a device stack or on a standalone device.
dot1x logging verbose
no dot1x logging verbose
Syntax Description This command has no arguments or keywords.
Command Default Detailed logging of system messages is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command filters details, such as anticipated success, from 802.1x system messages. Failure messages
are not filtered.
The following example shows how to filter verbose 802.1x system messages:
Device> enable
Device# configure terminal
Device(config)# dot1x logging verbose
Device(config)# exit
Related Commands Command Description
authentication logging verbose Filters details from authentication s
dot1x logging verbose Filters details from 802.1x system
mab logging verbose Filters details from MAC authentic
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1719
Security
dot1x max-start
dot1x max-start
To set the maximum number of Extensible Authentication Protocol over LAN (EAPOL) start frames that a
supplicant sends (assuming that no response is received) to the client before concluding that the other end is
802.1X unaware, use the dot1x max-start command in interface configuration mode. To remove the maximum
number-of-times setting, use the no form of this command.
dot1x max-start number
no dot1x max-start
Syntax Description number Maximum number of times that the router sends an EAPOL start frame. The value is from 1 to
10. The default is 3.
Command Default The default maximum number setting is 3.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You must enter the switchport mode access command on a switch port before entering this command.
The following example shows that the maximum number of EAPOL Start requests has been set to
5:
Device> enable
Device# configure terminal
Device(config)# interface gigibitethernet 1/0/3
Device(config-if)# dot1x max-start 5
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1720
Security
dot1x pae
dot1x pae
To set the Port Access Entity (PAE) type, use the dot1x pae command in interface configuration mode. To
disable the PAE type that was set, use the no form of this command.
dot1x pae {supplicant | authenticator}
no dot1x pae {supplicant | authenticator}
Syntax Description supplicant The interface acts only as a supplicant and will not respond to messages that are meant for
an authenticator.
authenticator The interface acts only as an authenticator and will not respond to any messages meant for
a supplicant.
Command Default PAE type is not set.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the no dot1x pae interface configuration command to disable IEEE 802.1x authentication on the port.
When you configure IEEE 802.1x authentication on a port, such as by entering the dot1x port-control interface
configuration command, the device automatically configures the port as an IEEE 802.1x authenticator. After
the no dot1x pae interface configuration command is entered, the Authenticator PAE operation is disabled.
The following example shows that the interface has been set to act as a supplicant:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet 1/0/3
Device(config-if)# dot1x pae supplicant
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1721
Security
dot1x supplicant controlled transient
dot1x supplicant controlled transient
To control access to an 802.1x supplicant port during authentication, use the dot1x supplicant controlled
transient command in global configuration mode. To open the supplicant port during authentication, use the
no form of this command
dot1x supplicant controlled transient
no dot1x supplicant controlled transient
Syntax Description This command has no arguments or keywords.
Command Default Access is allowed to 802.1x supplicant ports during authentication.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines In the default state, when you connect a supplicant device to an authenticator switch that has BPCU guard
enabled, the authenticator port could be error-disabled if it receives a Spanning Tree Protocol (STP) bridge
protocol data unit (BPDU) packets before the supplicant switch has authenticated. You can control traffic
exiting the supplicant port during the authentication period. Entering the dot1x supplicant controlled transient
command temporarily blocks the supplicant port during authentication to ensure that the authenticator port
does not shut down before authentication completes. If authentication fails, the supplicant port opens. Entering
the no dot1x supplicant controlled transient command opens the supplicant port during the authentication
period. This is the default behavior.
We recommend using the dot1x supplicant controlled transient command on a supplicant device when
BPDU guard is enabled on the authenticator switch port with the spanning-tree bpduguard enable interface
configuration command.
This example shows how to control access to 802.1x supplicant ports on a device during authentication:
Device> enable
Device# configure terminal
Device(config)# dot1x supplicant controlled transient
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1722
Security
dot1x supplicant force-multicast
dot1x supplicant force-multicast
To force a supplicant switch to send only multicast Extensible Authentication Protocol over LAN (EAPOL)
packets whenever it receives multicast or unicast EAPOL packets, use the dot1x supplicant force-multicast
command in global configuration mode. To return to the default setting, use the no form of this command.
dot1x supplicant force-multicast
no dot1x supplicant force-multicast
Syntax Description This command has no arguments or keywords.
Command Default The supplicant device sends unicast EAPOL packets when it receives unicast EAPOL packets. Similarly, it
sends multicast EAPOL packets when it receives multicast EAPOL packets.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Enable this command on the supplicant device for Network Edge Access Topology (NEAT) to work in all
host modes.
This example shows how force a supplicant device to send multicast EAPOL packets to the
authenticator device:
Device> enable
Device# configure terminal
Device(config)# dot1x supplicant force-multicast
Device(config)# end
Related Commands Command Description
cisp enable Enables CISP on a device so that it
dot1x credentials Configures the 802.1x supplicant cr
dot1x pae supplicant Configures an interface to act only
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1723
Security
dot1x test eapol-capable
dot1x test eapol-capable
To monitor IEEE 802.1x activity on all the switch ports and to display information about the devices that are
connected to the ports that support IEEE 802.1x, use the dot1x test eapol-capable command in privileged
EXEC mode.
dot1x test eapol-capable [interface interface-id]
Syntax Description interface interface-id (Optional) Port to be queried.
Command Default There is no default setting.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to test the IEEE 802.1x capability of the devices connected to all ports or to specific ports
on a switch.
There is not a no form of this command.
This example shows how to enable the IEEE 802.1x readiness check on a switch to query a port. It
also shows the response received from the queried port verifying that the device connected to it is
IEEE 802.1x-capable:
Device> enable
Device# dot1x test eapol-capable interface gigabitethernet1/0/13
DOT1X_PORT_EAPOL_CAPABLE:DOT1X: MAC 00-01-02-4b-f1-a3 on gigabitethernet1/0/13 is EAPOL
capable
Related Commands Command Description
dot1x test timeout timeout Configures the timeout used to wa
readiness query.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1724
Security
dot1x test timeout
dot1x test timeout
To configure the timeout used to wait for EAPOL response from a port being queried for IEEE 802.1x readiness,
use the dot1x test timeout command in global configuration mode.
dot1x test timeout timeout
Syntax Description timeout Time in seconds to wait for an EAPOL response. The range
is from 1 to 65535 seconds.
Command Default The default setting is 10 seconds.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to configure the timeout used to wait for EAPOL response.
There is not a no form of this command.
This example shows how to configure the switch to wait 27 seconds for an EAPOL response:
Device> enable
Device# dot1x test timeout 27
You can verify the timeout configuration status by entering the show running-config command.
Related Commands Command Description
dot1x test eapol-capable [interface Checks for IEEE 802.1x readiness on devices connected to all
interface-id] or to specified IEEE 802.1x-capable ports.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1725
Security
dot1x timeout
dot1x timeout
To configure the value for retry timeouts, use the dot1x timeout command in global configuration or interface
configuration mode. To return to the default value for retry timeouts, use the no form of this command.
dot1x timeout {auth-period seconds | held-period seconds | quiet-period seconds | ratelimit-period
seconds | server-timeout seconds | start-period seconds | supp-timeout seconds | tx-period
seconds}
Syntax Description auth-period seconds Configures the time, in seconds for which a supplicant will stay in
the HELD state (that is, the length of time it will wait before trying
to send the credentials again after a failed attempt).
The range is from 1 to 65535. The default is 30.
held-period seconds Configures the time, in seconds for which a supplicant will stay in
the HELD state (that is, the length of time it will wait before trying
to send the credentials again after a failed attempt).
The range is from 1 to 65535. The default is 60
quiet-period seconds Configures the time, in seconds, that the authenticator (server)
remains quiet (in the HELD state) following a failed authentication
exchange before trying to reauthenticate the client.
The range is from 1 to 65535. The default is 60
ratelimit-period seconds Throttles the EAP-START packets that are sent from misbehaving
client PCs (for example, PCs that send EAP-START packets that
result in the wasting of device processing power).
• The authenticator ignores EAPOL-Start packets from clients
that have successfully authenticated for the rate-limit period
duration.
• The range is from 1 to 65535. By default, rate limiting is
disabled.
server-timeout seconds Configures the interval, in seconds, between two successive
EAPOL-Start frames when they are being retransmitted.
• The range is from 1 to 65535. The default is 30.
If the server does not send a response to an 802.1X packet within
the specified period, the packet is sent again.
start-period seconds Configures the interval, in seconds, between two successive
EAPOL-Start frames when they are being retransmitted.
The range is from 1 to 65535. The default is 30.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1726
Security
dot1x timeout
supp-timeout seconds Sets the authenticator-to-supplicant retransmission time for all EAP
messages other than EAP Request ID.
The range is from 1 to 65535. The default is 30.
tx-period seconds Configures the number of seconds between retransmission of EAP
request ID packets (assuming that no response is received) to the
client.
• The range is from 1 to 65535. The default is 30.
• If an 802.1X packet is sent to the supplicant and the supplicant
does not send a response after the retry period, the packet will
be sent again.
Command Default Periodic reauthentication and periodic rate-limiting are done.
Command Modes Global configuration (config)
Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You should change the default value of this command only to adjust for unusual circumstances such as
unreliable links or specific behavioral problems with certain clients and authentication servers.
The dot1x timeout reauth-period interface configuration command affects the behavior of the device only
if you have enabled periodic re-authentication by using the dot1x reauthentication interface configuration
command.
During the quiet period, the device does not accept or initiate any authentication requests. If you want to
provide a faster response time to the user, enter a number smaller than the default.
When the ratelimit-period is set to 0 (the default), the device does not ignore EAPOL packets from clients
that have been successfully authenticated and forwards them to the RADIUS server.
The following example shows that various 802.1X retransmission and timeout periods have been
set:
Device> enable
Device(config)# configure terminal
Device(config)# interface gigabitethernet 1/0/3
Device(config-if)# dot1x port-control auto
Device(config-if)# dot1x timeout auth-period 2000
Device(config-if)# dot1x timeout held-period 2400
Device(config-if)# dot1x timeout quiet-period 600
Device(config-if)# dot1x timeout start-period 90
Device(config-if)# dot1x timeout supp-timeout 300
Device(config-if)# dot1x timeout tx-period 60
Device(config-if)# dot1x timeout server-timeout 60
Device(config-if)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1727
Security
dscp
dscp
To configure DSCP marking for authentication and accounting on RADIUS packets, use the dscp command.
To disable DSCP marking for authentication and accounting on RADIUS packets, use the no form of this
command
dscp { acct dscp_acct_value | auth dscp_auth_value }
no dscp { acct dscp_acct_value | auth dscp_auth_value }
Syntax Description acct dscp_acct_value Configures RADIUS DSCP marking value for accounting. The valid range is from
1 to 63. The default value is 0.
auth dscp_auth_value Configures RADIUS DSCP marking value for authentication. The valid range is
from 1 to 63. The default value is 0.
Command Default The DSCP marking on RADIUS packets is disabled by default.
Command Modes RADIUS server configuration (config-radius-server)
RADIUS server group configuration (config-sg-radius)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was
introduced.
Example
This example shows how to configure DSCP marking for authentication and accounting on RADIUS
packets for a RADIUS server:
Device(config)#radius server abc
Device(config-radius-server)#address ipv4 10.1.1.1 auth-port 1645 acct-port 1646
Device(config-radius-server)#dscp auth 10 acct 20
Device(config-radius-server)#key cisco123
Device(config-radius-server)#end
This example shows how to configure DSCP marking for authentication and accounting on RADIUS
packets for a RADIUS server group:
Device(config)#aaa group server radius xyz
Device(config-sg-radius)#server name abc
Device(config-sg-radius)#ip radius source-interface Vlan18
Device(config-sg-radius)#dscp auth 30 acct 10
Device(config-sg-radius)#end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1728
Security
dtls
dtls
To configure Datagram Transport Layer Security (DTLS) parameters, use the dtls command in radius server
configuration mode. To return to the default setting, use the no form of this command.
dtls [{ connectiontimeout connection-timeout-value | idletimeout idle-timeout-value | [{ ip | ipv6 }] {
radius source-interface interface-name | vrf forwarding forwarding-table-name } | match-server-identity
{ email-address email-address | hostname hostname | ip-address ip-address } | port port-number |
retries number-of-connection-retries | trustpoint { client trustpoint name | server trustpoint name } }]
no dtls
Syntax Description connectiontimeout connection-timeout-value (Optional) Configures the DTLS connection timeout
value.
idletimeout idle-timeout-value (Optional) Configures the DTLS idle timeout value.
[ip | ipv6] {radius source-interface interface-name (Optional) Configures IP or IPv6 source parameters.
|vrf forwarding forwarding-table-name}
match-server-identity {email-address email-address Configures RadSec certification validation parameters.
| hostname host-name | ip-address ip-address}
port port-number (Optional) Configures the DTLS port number.
retries number-of-connection-retries (Optional) Configures the number of DTLS
connection retries.
trustpoint {client trustpoint name|server trustpoint (Optional) Configures the DTLS trustpoint for the
name} client and the server.
Command Default • The default value of DTLS connection timeout is 5 seconds.
• The default value of DTLS idle timeout is 60 seconds.
• The default DTLS port number is 2083.
• The default value of DTLS connection retries is 5.
Command Modes Radius server configuration (config-radius-server)
Command History Release Modification
Cisco IOS XE Everest 16.6.1 This command was introduced.
Cisco IOS XE Gibraltar 16.10.1 The match-server-identity keyword was introduced.
Cisco IOS XE Amsterdam 17.1.1 The ipv6 keyword was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1729
Security
dtls
Usage Guidelines We recommend that you use the same server type, either only Transport Layer Security (TLS) or only DTLS,
under an Authentication, Authorization, and Accounting (AAA) server group.
Examples The following example shows how to configure the DTLS connection timeout value to 10 seconds:
Device> enable
Device# configure terminal
Device(config)# radius server R1
Device(config-radius-server)# dtls connectiontimeout 10
Device(config-radius-server)# end
Related Commands Command Description
show aaa servers Displays information related to the DTLS server.
clear aaa counters servers radius Clears the RADIUS DTLS-specific statistics.
debug radius dtls Enables RADIUS DTLS-specific debugs.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1730
Security
enable password
enable password
To set a local password to control access to various privilege levels, use the enable password command in
global configuration mode. To remove control access of the local password, use the no form of this command.
enable password [level level] {[0] unencrypted-password | [ encryption-type] encrypted-password}
no enable password [level level]
Syntax Description level level (Optional) Specifies the level for which the password is applicable. You can spe
levels, using numbers 0 through 15. Level 1 is normal user EXEC mode user pr
specified in the command or in the no form of the command, the privilege level
0 (Optional) Specifies an unencrypted cleartext password. The password is conve
Algorithm (SHA) 256 secret and is stored in the device.
unencrypted-password Specifies the password to enter enable mode.
encryption-type (Optional) Cisco-proprietary algorithm used to encrypt the password. If you spe
next argument that you supply must be an encrypted password (a password alrea
device). You can specify type 7, which indicates that a hidden password follow
encrypted-password Encrypted password copied from another device configuration.
Command Default No password is defined.
Command Modes Global configuration (config)
Command History Release Modifi
Cisco IOS XE Everest 16.5.1a This co
Usage Guidelines If neither the enable password command nor the enable secret command is configured, and if a line password
is configured for the console, the console line password serves as the enable password for all VTY (Telnet
and Secure Shell [SSH]) sessions.
Use enable password command with the level option to define a password for a specific privilege level. After
you specify the level and the password, share the password with users who need to access this level. Use the
privilege level configuration command to specify the commands that are accessible at various levels.
Typically, you enter an encryption type only if you copy and paste a password that has already been encrypted
by a Cisco device, into this command.
Caution If you specify an encryption type and then enter a cleartext password, you will not be able to re-enter enable
mode. You cannot recover a lost password that has been encrypted earlier.
If the service password-encryption command is set, the encrypted form of the password you create with the
enable password command is displayed when the more nvram:startup-config command is run.
You can enable or disable password encryption with the service password-encryption command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1731
Security
enable password
An enable password is defined as follows:
• Must contain a combination of numerals from 1 to 25, and uppercase and lowercase alphanumeric
characters.
• Can have leading spaces, but they are ignored. However, intermediate and trailing spaces are recognized.
• Can contain the question mark (?) character if you precede the question mark with the key combination
Crtl-V when you create the password, for example, to create the password abc?123, do the following:
1. Enter abc.
2. Press Crtl-v.
3. Enter ?123.
Note When the system prompt you to enter the enable password command, you need not precede the question
mark with Ctrl-V; you can enter abc?123 at the password prompt.
Examples The following example shows how to enables the password pswd2 for privilege level 2:
Device> enable
Device# configure terminal
Device(config)# enable password level 2 pswd2
The following example shows how to set the encrypted password $1$i5Rkls3LoyxzS8t9, which has
been copied from a device configuration file, for privilege level 2 using encryption type 7:
Device> enable
Device# configure terminal
Device(config)# enable password level 2 5 $1$i5Rkls3LoyxzS8t9
Related Commands Command Description
enable secret Specifies an additional layer of security over the enable pass
service password-encryption Encrypts a password.
more nvram:startup-config Displays the startup configuration file contained in NVRAM
CONFIG_FILE environment variable.
privilege level Sets the privilege level for the user.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1732
Security
enable secret
enable secret
To specify an additional layer of security over the enable password command, use the enable secret command
in global configuration mode. To turn off the enable secret function, use the no form of this command.
enable secret [level level] {[0] unencrypted-password | encryption-type encrypted-password}
no enable secret [level level] [encryption-type encrypted-password]
Syntax Description level level (Optional) Specifies the level for which the password is applicable. You can spec
levels, using numerals 1 through 15. Level 1 is normal user EXEC mode privileges
in the command or in the no form of the command, the privilege level defaults to
0 (Optional) Specifies an unencrypted cleartext password. The password is convert
Algorithm (SHA) 256 secret and is stored in the device.
unencrypted-password Specifies the password for users to enter enable mode. This password should be diff
created with the enable password command.
encryption-type Cisco-proprietary algorithm used to hash the password:
• 5: Specifies a message digest algorithm 5-encrypted (MD5-encrypted) secre
• 8: Specifies a Password-Based Key Derivation Function 2 (PBKDF2) with S
• 9: Specifies a scrypt-hashed secret.
encrypted-password Hashed password that is copied from another device configuration.
Command Default No password is defined.
Command Modes Global configuration (config)
Command History Release Modifi
Cisco IOS XE Everest 16.5.1a This co
Usage Guidelines If neither the enable password command or the enable secret command is configured, and if a line password
is configured for the console, the console line password serves as the enable password for all vty (Telnet and
Secure Shell [SSH]) sessions.
Use the enable secret command to provide an additional layer of security over the enable password password.
The enable secret command provides better security by storing the password using a nonreversible
cryptographic function. The additional layer of security encryption is useful in environments where the
password is sent to the network or is stored on a TFTP server.
Typically, you enter an encryption type only when you paste an encrypted password that you copied from a
device configuration file, into this command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1733
Security
enable secret
Caution If you specify an encryption type and then enter a cleartext password, you will not be able to reenter enable
mode. You cannot recover a lost password that has been encrypted earlier.
If you use the same password for the enable password and enable secret commands, you receive an error
message warning that this practice is not recommended, but the password will be accepted. By using the same
password, however, you undermine the additional security the enable secret command provides.
Note After you set a password using the enable secret command, a password set using the enable password
command works only if the enable secret is disabled. Additionally, you cannot recover a lost password that
has been encrypted by any method.
If the service password-encryption command is set, the encrypted form of the password you create is displayed
when the more nvram:startup-config command is run.
You can enable or disable password encryption with the service password-encryption command.
An enable password is defined as follows:
• Must contain a combination of numerals from 1 to 25, and uppercase and lowercase alphanumeric
characters.
• Can have leading spaces, but they are ignored. However, intermediate and trailing spaces are recognized.
• Can contain the question mark (?) character if you precede the question mark with the key combination
Crtl-v when you create the password; for example, to create the password abc?123, do the following:
1. Enter abc.
2. Press Crtl-v.
3. Enter ?123.
Note When the system prompts you to enter the enable password command, you need not precede the question
mark with Ctrl-v; you can enter abc?123 at the password prompt.
Examples The following example shows how to specify a password with the enable secret command:
Device> enable
Device# configure terminal
Device(config)# enable secret password
After specifying a password with the enable secret command, users must enter this password to gain
access. Otherwise, passwords set using the enable password command will no longer work.
Password: password
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1734
Security
enable secret
The following example shows how to enable the encrypted password $1$FaD0$Xyti5Rkls3LoyxzS8,
which has been copied from a device configuration file, for privilege level 2, using the encryption
type 4:
Device> enable
Device# configure terminal
Device(config)# enable password level 2 4 $1$FaD0$Xyti5Rkls3LoyxzS8
The following example shows the warning message that is displayed when a user enters the enable
secret 4 encrypted-password command:
Device> enable
Device# configure terminal
Device(config)# enable secret 4 tnhtc92DXBhelxjYk8LWJrPV36S2i4ntXrpb4RFmfqY
WARNING: Command has been added to the configuration but Type 4 passwords have been
deprecated.
Migrate to a supported password type
Device(config)# end
Device# show running-config | inc secret
enable secret 4 tnhtc92DXBhelxjYk8LWJrPV36S2i4ntXrpb4RFmfqY
Related Commands Command Description
enable password Sets a local password to control access to various privil
more nvram:startup-config Displays the startup configuration file contained in NVR
CONFIG_FILE environment variable.
service password-encryption Encrypt passwords.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1735
Security
epm access-control open
epm access-control open
To configure an open directive for ports that do not have an access control list (ACL) configured, use the epm
access-control open command in global configuration mode. To disable the open directive, use the no form
of this command.
epm access-control open
no epm access-control open
Syntax Description This command has no arguments or keywords.
Command Default The default directive applies.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to configure an open directive that allows hosts without an authorization policy to access
ports configured with a static ACL. If you do not configure this command, the port applies the policies of the
configured ACL to the traffic. If no static ACL is configured on a port, both the default and open directives
allow access to the port.
You can verify your settings by entering the show running-config command.
This example shows how to configure an open directive.
Device> enable
Device# configure terminal
Device(config)# epm access-control open
Device(config)# exit
Related Commands Command Description
show running-config Displays the contents of the current running configuration
file.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1736
Security
fqdn ttl-timeout factor
fqdn ttl-timeout factor
To configure the time-to-live (TTL) timeout factor of a FQDN local cache entry, use the fqdn ttl-timeout
factor command in global configuration mode. To remove the TTL timeout factor, use the no form of this
command.
fqdn ttl-timeout factor { ttl-timeout | infinite }
no fqdn ttl-timeout factor { ttl-timeout | infinite }
Syntax Description ttl-timeout Specifies the TTL timeout factor. The range is from 1 to 300.
infinite The FQDN entry stays forever.
Command Default The default TTL timeout factor is 10.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 The command was introduced.
Usage Guidelines The local TTL value for the cached FQDN entry is calculated based on the TTL value received in the DNS
response packet multiplied by the configured TTL timeout factor. For example, if the received DNS response
has a TTL value of 100 seconds and multiplication factor is set to 10, then the local TTL for the cached FQDN
entry will be 1000 seconds.
Examples The following example shows how to set the FQDN TTL timeout factor:
Device> enable
Device# configure terminal
Device(config)# fqdn ttl-timeout-factor 100
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1737
Security
include-icv-indicator
include-icv-indicator
To include the integrity check value (ICV) indicator in MKPDU, use the include-icv-indicator command in
MKA-policy configuration mode. To disable the ICV indicator, use the no form of this command.
include-icv-indicator
no include-icv-indicator
Syntax Description This command has no arguments or keywords.
Command Default ICV indicator is included.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example shows how to include the ICV indicator in MKPDU:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# include-icv-indicator
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
delay-protection Configures MKA to use delay protection in sending MKPDU.
key-server Configures MKA key-server options.
macsec-cipher-suite Configures cipher suite for deriving SAK.
sak-rekey Configures the SAK rekey interval.
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1738
Security
ip access-list
ip access-list
To define an IP access list or object-group access control list (ACL) by name or number or to enable filtering
for packets with IP helper-address destinations, use the ip access-list command in global configuration mode.
To remove the IP access list or object-group ACL or to disable filtering for packets with IP helper-address
destinations, use the no form of this command.
ip access-list {{extended | resequence | standard}{access-list-numberaccess-list-name} | helper egress
check | log-update threshold threshold-number | logging {hash-generation | interval time} | persistent |
role-based access-list-name | fqdn access-list-name }
no ip access-list { { extended | resequence | standard } { access-list-number access-list-name } | helper
egress check | log-update threshold | logging { hash-generation | interval } | persistent | role-based
access-list-name | fqdn access-list-name }
Syntax Description standard Specifies a standard IP access list.
resequence Specifies a resequenced IP access list.
extended Specifies an extended IP access list. Required for object-group ACLs.
access-list-name Name of the IP access list or object-group ACL. Names cannot contain a space
or quotation mark, and must begin with an alphabetic character to prevent
ambiguity with numbered access lists.
access-list-number Number of the access list.
• A standard IP access list is in the ranges 1-99 or 1300-1999.
• An extended IP access list is in the ranges 100-199 or 2000-2699.
helper egress check Enables permit or deny matching capability for an outbound access list that is
applied to an interface, for traffic that is relayed via the IP helper feature to a
destination server address.
log-update Controls the access list log updates.
threshold Sets the access list logging threshold. The range is 0 to 2147483647.
threshold-number
logging Controls the access list logging.
hash-generation Enables syslog hash code generation.
interval time Sets the access list logging interval in milliseconds. The range is 0 to
2147483647.
persistent Access control entry (ACE) sequence numbers are persistent across reloads.
Note This is enabled by default and cannot be disabled.
role-based Specifies a role-based IP access list.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1739
Security
ip access-list
fqdn Specifies a FQDN IP access list.
Note The name must start with an alphabet.
Command Default No IP access list or object-group ACL is defined, and outbound ACLs do not match and filter IP helper relayed
traffic.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Bengaluru 17.5.1 The fqdn keyword was introduced.
Usage Guidelines Use this command to configure a named or numbered IP access list or an object-group ACL. This command
places the device in access-list configuration mode, where you must define the denied or permitted access
conditions by using the deny and permit commands.
Specifying the standard or extended or fqdn keyword with the ip access-list command determines the prompt
that appears when you enter access-list configuration mode. You must use the extended keyword when
defining object-group ACLs.
You can create object groups and IP access lists or object-group ACLs independently, which means that you
can use object-group names that do not yet exist.
Use the ip access-group command to apply the access list to an interface.
The ip access-list helper egress check command enables outbound ACL matching for permit or deny capability
on packets with IP helper-address destinations. When you use an outbound extended ACL with this command,
you can permit or deny IP helper relayed traffic based on source or destination User Datagram Protocol (UDP)
ports. The ip access-list helper egress check command is disabled by default; outbound ACLs will not match
and filter IP helper relayed traffic.
Examples The following example defines a standard access list named Internetfilter:
Device> enable
Device# configure terminal
Device(config)# ip access-list standard Internetfilter
Device(config-std-nacl)# permit 192.168.255.0 0.0.0.255
Device(config-std-nacl)# permit 10.88.0.0 0.0.255.255
Device(config-std-nacl)# permit 10.0.0.0 0.255.255.255
The following example shows how to set the FQDN TTL timeout factor and create an FQDN ACL
named facl.
Device> enable
Device# configure terminal
Device(config)# fqdn ttl-timeout-factor 100
Device(config)# ip access-list fqdn facl
Device(config-fqdn-acl)# 100 permit ip any any
Device(config-fqdn-acl)# 10 permit ip host 192.0.2.121 host dynamic www.google.com
Device(config-fqdn-acl)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1740
Security
ip access-list
The following example shows how to create an object-group ACL that permits packets from the
users in my_network_object_group if the protocol ports match the ports specified in
my_service_object_group:
Device> enable
Device# configure terminal
Device(config)# ip access-list extended my_ogacl_policy
Device(config-ext-nacl)# permit tcp object-group my_network_object_group portgroup
my_service_object_group any
Device(config-ext-nacl)# deny tcp any any
The following example shows how to enable outbound ACL filtering on packets with helper-address
destinations:
Device> enable
Device# configure terminal
Device(config)# ip access-list helper egress check
Related Commands Command Description
deny Sets conditions in a named IP access list or in an object-group ACL that will deny
packets.
ip access-group Applies an ACL or an object-group ACL to an interface or a service policy map.
object-group network Defines network object groups for use in object-group ACLs.
object-group service Defines service object groups for use in object-group ACLs.
permit Sets conditions in a named IP access list or in an object-group ACL that will permit
packets.
show ip access-list Displays the contents of IP access lists or object-group ACLs.
show object-group Displays information about object groups that are configured.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1741
Security
ip access-list role-based
ip access-list role-based
To create a role-based (security group) access control list (RBACL) and enter role-based ACL configuration
mode, use the ip access-list role-based command in global configuration mode. To remove the configuration,
use the no form of this command.
ip access-list role-based access-list-name
no ip access-list role-based access-list-name
Syntax Description access-list-name Name of the security group access control list (SGACL).
Command Default Role-based ACLs are not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines For SGACL logging, you must configure the permit ip log command. Also, this command must be configured
in Cisco Identity Services Engine (ISE) to enable logging for dynamic SGACLs.
The following example shows how to define an SGACL that can be applied to IPv4 traffic and enter
role-based access list configuration mode:
Device> enable
Device# configure terminal
Device(config)# ip access-list role-based rbacl1
Device(config-rb-acl)# permit ip log
Device(config-rb-acl)# end
Related Commands Command Description
permit ip log Permits logging that matches the configured entry.
show ip access-list Displays contents of all current IP access lists.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1742
Security
ip admission
ip admission
To enable web authentication, use the ip admission command in interface configuration mode or fallback-profile
configuration mode. To disable web authentication, use the no form of this command.
ip admission rule
no ip admission rule
Syntax Description rule IP admission rule name.
Command Default Web authentication is disabled.
Command Modes Interface configuration (config-if)
Fallback-profile configuration (config-fallback-profile)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The ip admission command applies a web authentication rule to a switch port.
This example shows how to apply a web authentication rule to a switchport:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip admission rule1
Device(config-if)# end
This example shows how to apply a web authentication rule to a fallback profile for use on an IEEE
802.1x enabled switch port.
Device> enable
Device# configure terminal
Device(config)# fallback profile profile1
Device(config-fallback-profile)# ip admission rule1
Device(config-fallback-profile)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1743
Security
ip admission name
ip admission name
To enable web authentication, use the ip admission name command in global configuration mode. To
disable web authentication, use the no form of this command.
ip admission name name {consent | proxy http} [absolute timer minutes | inactivity-time
minutes | list {acl | acl-name} | service-policy type tag service-policy-name]
no ip admission name name {consent | proxy http} [absolute timer minutes | inactivity-time
minutes | list {acl | acl-name} | service-policy type tag service-policy-name]
Syntax Description name Name of network admission control rule.
consent Associates an authentication proxy consent web page
with the IP admission rule specified using the
admission-name argument.
proxy http Configures web authentication custom page.
absolute-timer minutes (Optional) Elapsed time, in minutes, before the external
server times out.
inactivity-time minutes (Optional) Elapsed time, in minutes, before the external
file server is deemed unreachable.
list (Optional) Associates the named rule with an access
control list (ACL).
acl Applies a standard, extended list to a named admission
control rule. The value ranges from 1 through 199, or
from 1300 through 2699 for expanded range.
acl-name Applies a named access list to a named admission
control rule.
service-policy type tag (Optional) A control plane service policy is to be
configured.
service-policy-name Control plane tag service policy that is configured
using the policy-map type control tagpolicyname
command, keyword, and argument. This policy map
is used to apply the actions on the host when a tag is
received.
Command Default Web authentication is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1744
Security
ip admission name
Usage Guidelines The ip admission name command globally enables web authentication on a switch.
After you enable web authentication on a switch, use the ip access-group in and ip admission web-rule
interface configuration commands to enable web authentication on a specific interface.
Examples This example shows how to configure only web authentication on a switch port:
Device> enable
Device# configure terminal
Device(config) ip admission name http-rule proxy http
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip access-group 101 in
Device(config-if)# ip admission rule
Device(config-if)# end
This example shows how to configure IEEE 802.1x authentication with web authentication as a
fallback mechanism on a switch port:
Device> enable
Device# configure terminal
Device(config)# ip admission name rule2 proxy http
Device(config)# fallback profile profile1
Device(config)# ip access group 101 in
Device(config)# ip admission name rule2
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# dot1x port-control auto
Device(config-if)# dot1x fallback profile1
Device(config-if)# end
Related Commands Command Description
dot1x fallback Configures a port to use web
authentication as a fallback method
for clients that do not support
IEEE 802.1x authentication.
fallback profile Creates a web authentication
fallback profile.
ip admission Enables web authentication on a
port.
show authentication sessions interface interface detail Displays information about the web
authentication session status.
show ip admission Displays information about NAC
cached entries or the NAC
configuration.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1745
Security
ip dhcp snooping database
ip dhcp snooping database
To configure the Dynamic Host Configuration Protocol (DHCP)-snooping database, use the ip dhcp snooping
database command in global configuration mode. To disable the DHCP-snooping database, use the no form
of this command.
ip dhcp snooping database { crashinfo: url | flash: url | ftp: url | http: url | https: url
| rcp: url | scp: url | tftp: url | timeout seconds | usbflash0: url | write-delay
seconds }
no ip dhcp snooping database [ timeout | write-delay ]
abor
Syntax Description crashinfo:url Specifies the database URL for
storing entries using crashinfo.
flash:url Specifies the database URL for
storing entries using flash.
ftp:url Specifies the database URL for
storing entries using FTP.
http:url Specifies the database URL for
storing entries using HTTP.
https:url Specifies the database URL for
storing entries using secure HTTP
(https).
rcp:url Specifies the database URL for
storing entries using remote copy
(rcp).
scp:url Specifies the database URL for
storing entries using Secure Copy
(SCP).
tftp:url Specifies the database URL for
storing entries using TFTP.
timeout seconds Specifies the cancel timeout
interval; valid values are from 0 to
86400 seconds.
usbflash0:url Specifies the database URL for
storing entries using USB flash.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1746
Security
ip dhcp snooping database
write-delay seconds Specifies the amount of time before
writing the DHCP-snooping entries
to an external server after a change
is seen in the local DHCP-snooping
database; valid values are from 15
to 86400 seconds.
Command Default The DHCP-snooping database is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You must enable DHCP snooping on the interface before entering this command. Use the ip dhcp snooping
command to enable DHCP snooping.
This example shows how to specify the database URL using TFTP:
Device> enable
Device# configure terminal
Device(config)# ip dhcp snooping database tftp://10.90.90.90/snooping-rp2
Device(config)# exit
This example shows how to specify the amount of time before writing DHCP snooping entries to an
external server:
evice> enable
Device# configure terminal
Device(config)# ip dhcp snooping database write-delay 15
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1747
Security
ip dhcp snooping information option format remote-id
ip dhcp snooping information option format remote-id
To configure the option-82 remote-ID suboption, use the ip dhcp snooping information option format
remote-id command in global configuration mode on the device to configure the option-82 remote-ID
suboption. To configure the default remote-ID suboption, use the no form of this command.
ip dhcp snooping information option format remote-id {hostname | string string}
no ip dhcp snooping information option format remote-id {hostname | string string}
Syntax Description hostname Specify the device hostname as the remote ID.
string string Specify a remote ID, using from 1 to 63 ASCII characters (no spaces).
Command Default The device MAC address is the remote ID.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You must globally enable DHCP snooping by using the ip dhcp snooping global configuration command for
any DHCP snooping configuration to take effect.
When the option-82 feature is enabled, the default remote-ID suboption is the device MAC address. This
command allows you to configure either the device hostname or a string of up to 63 ASCII characters (but
no spaces) to be the remote ID.
Note If the hostname exceeds 63 characters, it will be truncated to 63 characters in the remote-ID configuration.
This example shows how to configure the option- 82 remote-ID suboption:
Device> enable
Device# configure terminal
Device(config)# ip dhcp snooping information option format remote-id hostname
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1748
Security
ip dhcp snooping verify no-relay-agent-address
ip dhcp snooping verify no-relay-agent-address
To disable the DHCP snooping feature from verifying that the relay agent address (giaddr) in a DHCP client
message matches the client hardware address on an untrusted port, use the ip dhcp snooping verify
no-relay-agent-address command in global configuration mode. To enable verification, use the no form of
this command.
ip dhcp snooping verify no-relay-agent-address
no ip dhcp snooping verify no-relay-agent-address
Syntax Description This command has no arguments or keywords.
Command Default The DHCP snooping feature verifies that the relay-agent IP address (giaddr) field in DHCP client message
on an untrusted port is 0.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines By default, the DHCP snooping feature verifies that the relay-agent IP address (giaddr) field in DHCP client
message on an untrusted port is 0; the message is dropped if the giaddr field is not 0. Use the ip dhcp snooping
verify no-relay-agent-address command to disable the verification. Use the no ip dhcp snooping verify
no-relay-agent-address to reenable verification.
This example shows how to enable verification of the giaddr in a DHCP client message:
Device> enable
Device# configure terminal
Device(config)# no ip dhcp snooping verify no-relay-agent-address
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1749
Security
ip http access-class
ip http access-class
To specify the access list that should be used to restrict access to the HTTP server, use the ip http access-class
command in global configuration mode. To remove a previously configured access list association, use the
no form of this command.
ip http access-class { access-list-number | ipv4 { access-list-number | access-list-name } |
ipv6 access-list-name }
no ip http access-class { access-list-number | ipv4 { access-list-number | access-list-name }
| ipv6 access-list-name }
Syntax Description access-list-number Standard IP access list number in the range 0 to 99, as configured by the access-list
global configuration command.
ipv4 Specifies the IPv4 access list to restrict access to the secure HTTP server.
access-list-name Name of a standard IPv4 access list, as configured by the ip access-list command.
ipv6 Specifies the IPv6 access list to restrict access to the secure HTTP server.
Command Default No access list is applied to the HTTP server.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If this command is configured, the specified access list is assigned to the HTTP server. Before the HTTP
server accepts a connection, it checks the access list. If the check fails, the HTTP server does not accept the
request for a connection.
Examples The following example shows how to define an access list as 20 and assign it to the HTTP server:
Device> enable
Device(config)# ip access-list standard 20
Device(config-std-nacl)# permit 209.165.202.130 0.0.0.255
Device(config-std-nacl)# permit 209.165.201.1 0.0.255.255
Device(config-std-nacl)# permit 209.165.200.225 0.255.255.255
Device(config-std-nacl)# exit
Device(config)# ip http access-class 20
Device(config-std-nacl)# exit
The following example shows how to define an IPv4 named access list as and assign it to the HTTP
server.
Device> enable
Device(config)# ip access-list standard Internet_filter
Device(config-std-nacl)# permit 1.2.3.4
Device(config-std-nacl)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1750
Security
ip http access-class
Device(config)# ip http access-class ipv4 Internet_filter
Device(config)# exit
Related Commands Command Description
ip access-list Assigns an ID to an access list and enters access list configuration mode.
ip http server Enables the HTTP 1.1 server, including the Cisco web browser user interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1751
Security
ip radius source-interface
ip radius source-interface
To force RADIUS to use the IP address of a specified interface for all outgoing RADIUS packets, use the ip
radius source-interface command in global configuration mode. To prevent RADIUS from using the IP
address of a specified interface for all outgoing RADIUS packets, use the no form of this command.
ip radius source-interface interface-name [vrf vrf-name]
no ip radius source-interface
Syntax Description interface-name Name of the interface that RADIUS uses for all of its outgoing packets.
vrf vrf-name (Optional) Per virtual route forwarding (VRF) configuration.
Command Default No default behavior or values.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to set the IP address of an interface to be used as the source address for all outgoing
RADIUS packets. The IP address is used as long as the interface is in the up state. The RADIUS server can
use one IP address entry for every network access client instead of maintaining a list of IP addresses. Radius
uses the IP address of the interface that it is associated to, regardless of whether the interface is in the up or
down state.
The ip radius source-interface command is especially useful in cases where the router has many interfaces
and you want to ensure that all RADIUS packets from a particular router have the same IP address.
The specified interface should have a valid IP address and should be in the up state for a valid configuration.
If the specified interface does not have a valid IP address or is in the down state, RADIUS selects a local IP
that corresponds to the best possible route to the AAA server. To avoid this, add a valid IP address to the
interface or bring the interface to the up state.
Use the vrf vrf-name keyword and argument to configure this command per VRF, which allows multiple
disjoined routing or forwarding tables, where the routes of one user have no correlation with the routes of
another user.
Examples The following example shows how to configure RADIUS to use the IP address of interface s2 for
all outgoing RADIUS packets:
ip radius source-interface s2
The following example shows how to configure RADIUS to use the IP address of interface Ethernet0
for VRF definition:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1752
Security
ip radius source-interface
ip radius source-interface Ethernet0 vrf vrf1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1753
Security
ip source binding
ip source binding
To add a static IP source binding entry, use the ip source binding command. Use the no form of this command
to delete a static IP source binding entry
ip source binding mac-address vlan vlan-id ip-address interface interface-id
no ip source binding mac-address vlan vlan-id ip-address interface interface-id
Syntax Description mac-address Binding MAC address.
vlan vlan-id Specifies the Layer 2 VLAN
identification; valid values are from
1 to 4094.
ip-address Binding IP address.
interface interface-id ID of the physical interface.
Command Default No IP source bindings are configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You can use this command to add a static IP source binding entry only.
The no format deletes the corresponding IP source binding entry. It requires the exact match of all required
parameter in order for the deletion to be successful. Note that each static IP binding entry is keyed by a MAC
address and a VLAN number. If the command contains the existing MAC address and VLAN number, the
existing binding entry is updated with the new parameters instead of creating a separate binding entry.
This example shows how to add a static IP source binding entry:
Device> enable
Device# configure terminal
Device(config) ip source binding 0100.0230.0002 vlan 11 10.0.0.4 interface
gigabitethernet1/0/1
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1754
Security
ip ssh source-interface
ip ssh source-interface
To specify the IP address of an interface as the source address for a Secure Shell (SSH) client device, use the
ip ssh source-interface command in global configuration mode. To remove the IP address as the source
address, use the no form of this command.
ip ssh source-interface interface
no ip ssh source-interface interface
Syntax Description interface The interface whose address is used as the source address for the SSH client.
Command Default The address of the closest interface to the destination is used as the source address (the closest interface is the
output interface through which the SSH packet is sent).
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Cisco IOS XE Gibraltar 16.11.1
Usage Guidelines By specifying this command, you can force the SSH client to use the IP address of the source interface as the
source address.
Examples In the following example, the IP address assigned to GigabitEthernet interface 1/0/1 is used as the
source address for the SSH client:
Device> enable
Device# configure terminal
Device(config)# ip ssh source-interface GigabitEthernet 1/0/1
Device(config)# exit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1755
Security
ip verify source
ip verify source
To enable IP source guard on an interface, use the ip verify source command in interface configuration mode.
To disable IP source guard, use the no form of this command.
ip verify source [mac-check][tracking]
no ip verify source
mac-check (Optional) Enables IP source guard with MAC address
verification.
tracking (Optional) Enables IP port security to learn static IP
address learning on a port.
Command Default IP source guard is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines To enable IP source guard with source IP address filtering, use the ip verify source interface configuration
command.
To enable IP source guard with source IP address filtering and MAC address verification, use the ip verify
source mac-check interface configuration command.
Examples This example shows how to enable IP source guard with source IP address filtering on an interface:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip verify source
Device(config-if)# end
This example shows how to enable IP source guard with MAC address verification:
Device> enable
Device# configure terminal
Device(config)# interface gigabitethernet1/0/1
Device(config-if)# ip verify source mac-check
Device(config-if)# end
You can verify your settings by entering the show ip verify source command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1756
Security
ipv6 access-list
ipv6 access-list
To define an IPv6 access list and to place the device in IPv6 access list configuration mode, use the ipv6
access-list command in global configuration mode. To remove the access list, use the no form of this command.
ipv6 access-list { access-list-name | fqdn access-list-name | match-local-traffic | log-update threshold
threshold-in-msgs | role-based access-list-name }
no ipv6 access-list { access-list-name | fqdn access-list-name | match-local-traffic | log-update
threshold threshold-in-msgs | role-based access-list-name }
Syntax Description access-list-name Name of the IPv6 access list. Names cannot contain a space or
quotation mark, and must begin with an alphabetic character. The
allowed length is 64 characters.
fqdn access-list-name Specifies an FQDN IPv6 access list.
match-local-traffic Enables matching for locally-generated traffic.
log-update threshold Determines how syslog messages are generated after the initial
threshold-in-msgs packet match.
• threshold-in-msgs: Number of packets generated.
role-based access-list-name Creates a role-based IPv6 ACL.
Command Default No IPv6 access list is defined.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 This command was modified. The fqdn keyword was introduced.
Usage Guidelines From IPv6 access list configuration mode, permit and deny conditions can be set for the defined IPv6 ACL.
Note IPv6 ACLs are defined by a unique name (IPv6 does not support numbered ACLs). An IPv4 ACL and an
IPv6 ACL cannot share the same name.
IPv6 is automatically configured as the protocol type in permit any any and deny any any statements that
are translated from global configuration mode to IPv6 access list configuration mode.
Every IPv6 ACL has implicit permit icmp any any nd-na, permit icmp any any nd-ns, and deny ipv6 any
any statements as its last match conditions. (The first two match conditions allow for ICMPv6 neighbor
discovery.) An IPv6 ACL must contain at least one entry for the implicit deny ipv6 any any statement to take
effect. The IPv6 neighbor discovery process makes use of the IPv6 network layer service. Therefore, by
default, IPv6 ACLs implicitly allow IPv6 neighbor discovery packets to be sent and received on an interface.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1757
Security
ipv6 access-list
In IPv4, the Address Resolution Protocol (ARP), which is equivalent to the IPv6 neighbor discovery process,
makes use of a separate data link layer protocol. Therefore, by default, IPv4 ACLs implicitly allow ARP
packets to be sent and received on an interface.
Use the ipv6 traffic-filter interface configuration command with the access-list-name argument to apply an
IPv6 ACL to an IPv6 interface. Use the ipv6 access-class line configuration command with the access-list-name
argument to apply an IPv6 ACL to incoming and outgoing IPv6 virtual terminal connections to and from the
device.
An IPv6 ACL applied to an interface with the ipv6 traffic-filter command filters traffic that is forwarded—not
originated from—by the device.
Examples The following example shows how to configure an IPv6 ACL list named list1, and place the device
in IPv6 access list configuration mode:
Device> enable
Device# configure terminal
Device(config)# ipv6 access-list list1
Device(config-ipv6-acl)# end
The following example shows how to configure an IPv6 ACL named list2 and applies the ACL to
outbound traffic on Ethernet interface 0. Specifically, the first ACL entry keeps all the packets from
the network FEC0:0:0:2::/64 (packets that have the site-local prefix FEC0:0:0:2 as the first 64 bits
of their source IPv6 address) from exiting from Gigabit Ethernet interface 0/1/2. The second entry
in the ACL permits all other traffic to exit from Ethernet interface 0. The second entry is necessary
because an implicit deny all condition is at the end of each IPv6 ACL.
Device> enable
Device# configure terminal
Device(config)# ipv6 access-list list2 deny FEC0:0:0:2::/64 any
Device(config)# ipv6 access-list list2 permit any any
Device(config)# interface gigabitethernet 0/1/2
Device(config-if)# ipv6 traffic-filter list2 out
Device(config-if)# end
The following example shows how to configure an IPv6 FQDN access list using a name, along with
ACL entries and domain names:
Device> enable
Device# configure terminal
Device(config)# ipv6 access-list fqdn facl
Device(config-ipv6-fqdn-acl)# sequence 10 permit ipv6 host 2001:DB8::1 host dynamic
www.example1.com
Device(config-ipv6-fqdn-acl)# sequence 20 permit tcp 2001:2:2::2/64 eq ftp host dynamic
www.example2.com log
Device(config-ipv6-fqdn-acl)# sequence 30 permit udp host dynamic www.example3.com any
sequence
Device(config-ipv6-fqdn-acl)# sequence 40 deny tcp any any eq www
Device(config-ipv6-fqdn-acl)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1758
Security
ipv6 snooping policy
ipv6 snooping policy
To configure an IPv6 snooping policy and enter IPv6 snooping configuration mode, use the ipv6 snooping
policy command in global configuration mode. To delete an IPv6 snooping policy, use the no form of this
command.
ipv6 snooping policy snooping-policy
no ipv6 snooping policy snooping-policy
Syntax Description snooping-policy User-defined name of the snooping policy. The policy name can be a symbolic string
(such as Engineering) or an integer (such as 0).
Command Default An IPv6 snooping policy is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the ipv6 snooping policy command to create an IPv6 snooping policy. When the ipv6 snooping policy
command is enabled, the configuration mode changes to IPv6 snooping configuration mode. In this mode,
the administrator can configure the following IPv6 first-hop security commands:
• The device-role command specifies the role of the device attached to the port.
• The limit address-count maximum command limits the number of IPv6 addresses allowed to be used
on the port.
• The protocol command specifies that addresses should be gleaned with Dynamic Host Configuration
Protocol (DHCP) or Neighbor Discovery Protocol (NDP).
• The security-level command specifies the level of security enforced.
• The tracking command overrides the default tracking policy on a port.
• The trusted-port command configures a port to become a trusted port; that is, limited or no verification
is performed when messages are received.
This example shows how to configure an IPv6 snooping policy:
Device> enable
Device# configure terminal
Device(config)# ipv6 snooping policy policy1
Device(config-ipv6-snooping)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1759
Security
key chain macsec
key chain macsec
To configure a MACsec key chain name on a device interface to fetch a Pre Shared Key (PSK), use the key
chain macsec command in global configuration mode. To disable it, use the no form of this command.
key chain name macsec
no key chain name [macsec ]
Syntax Description name Name of a key chain to be used to get keys.
Command Default Key chain macsec is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This example shows how to configure MACsec key chain to fetch a 128-bit Pre Shared Key (PSK):
Device> enable
Device# configure terminal
Device(config)# key chain kc1 macsec
Device(config-keychain-macsec)# key 1000
Device(config-keychain-macsec)# cryptographic-algorithm aes-128-cmac
Device(config-keychain-macsec-key)# key-string fb63e0269e2768c49bab8ee9a5c2258f
Device(config-keychain-macsec-key)# end
Device#
This example shows how to configure MACsec key chain to fetch a 256-bit Pre Shared Key (PSK):
Device> enable
Device# configure terminal
Device(config)# key chain kc1 macsec
Device(config-keychain-macsec)# key 2000
Device(config-keychain-macsec)# cryptographic-algorithm aes-256-cmac
Device(config-keychain-macsec-key)# key-string c865632acb269022447c417504a1b
f5db1c296449b52627ba01f2ba2574c2878
Device(config-keychain-macsec-key)# end
Device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1760
Security
key config-key password-encrypt
key config-key password-encrypt
To store a type 6 encryption key in private NVRAM, use the key config-key password-encrypt command
in global configuration mode. To disable the encryption, use the no form of this command.
key config-key password-encrypt [text]
no key config-key password-encrypt [text]
Syntax Description text (Optional) Password or master key.
Note We recommended that you do not use the text argument, and instead use interactive mode
(using the Enter key after you enter the key config-key password-encrypt command)
so that the preshared key is not printed anywhere and, therefore, cannot be seen.
Command Default Type 6 password encryption key is not stored in private NVRAM.
Command Modes Global configuration (config)
Command History Release Modif
Cisco IOS XE Everest 16.5.1a This c
introd
Usage Guidelines You can securely store plain text passwords in type 6 format in NVRAM using a CLI. Type 6 passwords are
encrypted. Although the encrypted passwords can be seen or retrieved, it is difficult to decrypt them to find
out the actual password. Use the key config-key password-encrypt command along with the password
encryption aes command to configure and enable the password (symmetric cipher Advanced Encryption
Standard [AES] is used to encrypt the keys). The password (key) configured using the key config-key
password-encrypt command is the master encryption key that is used to encrypt all other keys in the device.
If you configure the password encryption aes command without configuring the key config-key
password-encrypt command, the following message is displayed at startup or during a nonvolatile generation
(NVGEN) process, such as when the show running-config or copy running-config startup-config commands
are configured:
“Can not encrypt password. Please configure a configuration-key with ‘key config-key’”
Changing a Password
If the password (master key) is changed or reencrypted, use the key config-key password-encrypt command)
for the list registry to pass the old key and the new key to the application modules that are using type 6
encryption.
Deleting a Password
If the master key that was configured using the key config-key password-encrypt command is deleted from
the system, a warning is displayed (and a confirm prompt is issued) stating that all type 6 passwords will
become useless. As a security measure, after the passwords are encrypted, they will never be decrypted in the
Cisco IOS software. However, passwords can be re-encrypted, as explained in the previous paragraph.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1761
Security
key config-key password-encrypt
Caution If the password that is configured using the key config-key password-encrypt command is lost, it cannot be
recovered. We, therefore, recommend that you store the password in a safe location.
Unconfiguring Password Encryption
If you unconfigure password encryption using the no password encryption aes command, all the existing
type 6 passwords are left unchanged, and as long as the password (master key) that was configured using the
key config-key password-encrypt command exists, the type 6 passwords will be decrypted as and when
required by the application.
Storing Passwords
Because no one can read the password (configured using the key config-key password-encrypt command),
there is no way that the password can be retrieved from the device. Existing management stations cannot know
what it is unless the stations are enhanced to include this key somewhere, in which case, the password needs
to be stored securely within the management system. If configurations are stored using TFTP, the configurations
are not standalone, meaning that they cannot be loaded onto a device. Before or after the configurations are
loaded onto a device, the password must be manually added (using the key config-key password-encrypt
command). The password can be manually added to the stored configuration. However we do not recommend
this because adding the password manually allows anyone to decrypt all the passwords in that configuration.
Configuring New or Unknown Passwords
If you enter or cut and paste ciphertext that does not match the master key, or if there is no master key, the
ciphertext is accepted or saved, but an alert message is displayed:
“ciphertext>[for username bar>] is incompatible with the configured master key.”
If a new master key is configured, all plain keys are encrypted and made type 6 keys. The existing type 6 keys
are not encrypted. The existing type 6 keys are left as is.
If the old master key is lost or is unknown, you have the option of deleting the master key using the no key
config-key password-encrypt command. Deleting the master key causes the existing encrypted passwords
to remain encrypted in the device configuration. The passwords cannot be decrypted.
Examples The following example shows how a type 6 encryption key is stored in NVRAM:
Device> enable
Device# configure terminal
Device (config)# key config-key password-encrypt
Related Commands Command Description
password encryption aes Enables a type 6 encrypted presh
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1762
Security
key-server
key-server
To configure MKA key-server options, use the key-server command in MKA-policy configuration mode.
To disable MKA key-server options, use the no form of this command.
key-server priority value
no key-server priority
Syntax Description priority value Specifies the priority value of the MKA key-server.
Command Default MKA key-server is disabled.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Examples The following example shows how to configure the MKA key-server:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# key-server priority 33
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
delay-protection Configures MKA to use delay protection in sending MKPDU.
include-icv-indicator Includes ICV indicator in MKPDU.
macsec-cipher-suite Configures cipher suite for deriving SAK)
sak-rekey Configures the SAK rekey interval.
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1763
Security
limit address-count
limit address-count
To limit the number of IPv6 addresses allowed to be used on the port, use the limit address-count command
in Neighbor Discovery Protocol (NDP) inspection policy configuration mode or IPv6 snooping configuration
mode. To return to the default, use the no form of this command.
limit address-count maximum
no limit address-count
Syntax Description maximum The number of addresses allowed on the port. The range is from 1 to 10000.
Command Default The default is no limit.
Command Modes IPv6 snooping configuration (config-ipv6-snooping)
ND inspection policy configuration (config-nd-inspection)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines The limit address-count command limits the number of IPv6 addresses allowed to be used on the port on
which the policy is applied. Limiting the number of IPv6 addresses on a port helps limit the binding table
size. The range is from 1 to 10000.
This example shows how to define an NDP policy name as policy1, and limit the number of IPv6
addresses allowed on the port to 25:
Device> enable
Device# configure terminal
Device(config)# ipv6 nd inspection policy policy1
Device(config-nd-inspection)# limit address-count 25
Device(config-nd-inspection)# end
This example shows how to define an IPv6 snooping policy name as policy1, and limit the number
of IPv6 addresses allowed on the port to 25:
Device> enable
Device# configure terminal
Device(config)# ipv6 snooping policy policy1
Device(config-ipv6-snooping)# limit address-count 25
Device(config-ipv6-snooping)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1764
Security
local-domain (Parameter Map)
local-domain (Parameter Map)
To configure a local domain for the Cisco Umbrella Integration feature, use the local-domain command in
parameter-map type inspect configuration mode. To remove a local domain, use the no form of this command.
local-domain regex_param_map_name
no local-domain regex_param_map_name
Syntax Description regex_param_map_name Name of the regular expression parameter map.
Command Default No local domain is created for the parameter map.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines A maximum of 64 local domains can be configured, and the allowed domain name length is 100 characters.
Examples The following example shows how to configure a local domain:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)# local-domain dns_bypass
Related Commands Command Description
parameter-map type umbrella global Configures a parameter-map type in umbrella mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1765
Security
mab logging verbose
mab logging verbose
To filter detailed information from MAC authentication bypass (MAB) system messages, use the mab logging
verbose command in global configuration mode. Use the no form of this command to disable logging MAB
system messages.
mab logging verbose
no mab logging verbose
Syntax Description This command has no arguments or keywords.
Command Default Detailed logging of system messages is not enabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines This command filters details, such as anticipated success, from MAC authentication bypass (MAB) system
messages. Failure messages are not filtered.
To filter verbose MAB system messages:
Device> enable
Device# configure terminal
Device(config)# mab logging verbose
Device(config)# exit
You can verify your settings by entering the show running-config command.
Related Commands Command Description
authentication logging verbose Filters details from authentication system messages.
dot1x logging verbose Filters details from 802.1x system messages.
mab logging verbose Filters details from MAC authentication bypass (MAB) system messag
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1766
Security
mab request format attribute 32
mab request format attribute 32
To enable VLAN ID-based MAC authentication on a device, use the mab request format attribute 32
vlan access-vlan command in global configuration mode. To return to the default setting, use the no form
of this command.
mab request format attribute 32 vlan access-vlan
no mab request format attribute 32 vlan access-vlan
Syntax Description This command has no arguments or keywords
Command Default VLAN-ID based MAC authentication is disabled.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use this command to allow a RADIUS server to authenticate a new user based on the host MAC address and
VLAN. Use this feature on networks with the Microsoft IAS RADIUS server. The Cisco ACS ignores this
command.
This example shows how to enable VLAN-ID based MAC authentication on a device:
Device> enable
Device# configure terminal
Device(config)# mab request format attribute 32 vlan access-vlan
Device(config)# exit
Related Commands Command Description
authentication event Sets the action for specific authentication events.
authentication fallback Configures a port to use web authentication as a fallback meth
that do not support IEEE 802.1x authentication.
authentication host-mode Sets the authorization manager mode on a port.
authentication open Enables or disables open access on a port.
authentication order Sets the order of authentication methods used on a port.
authentication periodic Enables or disables reauthentication on a port.
authentication port-control Enables manual control of the port authorization state.
authentication priority Adds an authentication method to the port-priority list.
authentication timer Configures the timeout and reauthentication parameters for an
802.1x-enabled port.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1767
Security
mab request format attribute 32
Command Description
authentication violation Configures the violation modes that occur when a new device co
a port or when a new device connects to a port with the maximum
of devices already connected to that port.
mab Enables MAC-based authentication on a port.
mab eap Configures a port to use the Extensible Authentication Protocol (
show authentication Displays information about authentication manager events on the
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1768
Security
macsec-cipher-suite
macsec-cipher-suite
To configure cipher suite for deriving Security Association Key (SAK), use the macsec-cipher-suite command
in MKA-policy configuration mode. To disable cipher suite for SAK, use the no form of this command.
macsec-cipher-suite {gcm-aes-128 | gcm-aes-256 | gcm-aes-xpn-128 | gcm-aes-xpn-256}
no macsec-cipher-suite {gcm-aes-128 | gcm-aes-256 | gcm-aes-xpn-128 | gcm-aes-xpn-256}
Syntax Description gcm-aes-128 Configures cipher suite for deriving SAK with 128-bit encryption.
gcm-aes-256 Configures cipher suite for deriving SAK with 256-bit encryption.
gcm-aes-xpn-128 Configures cipher suite for deriving SAK with 128-bit encryption for Extended Packet
Numbering (XPN).
gcm-aes-xpn-256 Configures cipher suite for deriving SAK with 256-bit encryption for XPN.
Command Default GCM-AES-128 encryption is enabled.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If the device supports both GCM-AES-128 and GCM-AES-256 ciphers, it is highly recommended to define
and use a user-defined MKA policy to include both or only 256 bits cipher, based on your requirements..
Examples The following example shows how to configure MACsec cipher suite for deriving SAK with 256-bit
encryption:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# macsec-cipher-suite gcm-aes-256
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
delay-protection Configures MKA to use delay protection in sending MKPDU.
include-icv-indicator Includes ICV indicator in MKPDU.
key-server Configures MKA key-server options.
sak-rekey Configures the SAK rekey interval.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1769
Security
macsec-cipher-suite
Command Description
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1770
Security
macsec network-link
macsec network-link
To enable MACsec Key Agreement protocol (MKA) configuration on the uplink interfaces, use the macsec
network-link command in interface configuration mode. To disable it, use the no form of this command.
macsec network-link
no macsec network-link
Syntax Description macsec network-link Enables MKA MACsec configuration on device interfaces using EAP-TLS
authentication protocol.
Command Default MACsec network-link is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This example shows how to configure MACsec MKA on an interface using the EAP-TLS
authentication protocol:
Device> enable
Device# configure terminal
Device(config)# interface GigabitEthernet 1/0/20
Device(config-if)# macsec network-link
Device(config-if)# end
Device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1771
Security
match (access-map configuration)
match (access-map configuration)
To set the VLAN map to match packets against one or more access lists, use the match command in access-map
configuration mode. To remove the match parameters, use the no form of this command.
match {ip address {namenumber} [{namenumber}] [{namenumber}]... | ipv6 address {namenumber}
[{namenumber}] [{namenumber}]... | mac address {name} [{name}] [{name}]...}
no match {ip address {namenumber} [{namenumber}] [{namenumber}]... | ipv6 address
{namenumber} [{namenumber}] [{namenumber}]... | mac address {name} [{name}] [{name}]...}
Syntax Description ip address Sets the access map to match packets against an IP address access list.
ipv6 address Sets the access map to match packets against an IPv6 address access list.
mac address Sets the access map to match packets against a MAC address access list.
name Name of the access list to match packets against.
number Number of the access list to match packets against. This option is not valid for MAC access
lists.
Command Default The default action is to have no match parameters applied to a VLAN map.
Command Modes Access-map configuration (config-access-map)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines You enter access-map configuration mode by using the vlan access-map global configuration command.
You must enter one access list name or number; others are optional. You can match packets against one or
more access lists. Matching any of the lists counts as a match of the entry.
In access-map configuration mode, use the match command to define the match conditions for a VLAN map
applied to a VLAN. Use the action command to set the action that occurs when the packet matches the
conditions.
Packets are matched only against access lists of the same protocol type; IP packets are matched against IP
access lists, IPv6 packets are matched against IPv6 access lists, and all other packets are matched against
MAC access lists.
IP, IPv6, and MAC addresses can be specified for the same map entry.
Examples This example shows how to define and apply a VLAN access map vmap4 to VLANs 5 and 6 that
will cause the interface to drop an IP packet if the packet matches the conditions defined in access
list al2:
Device> enable
Device(config)# vlan access-map vmap4
Device(config-access-map)# match ip address al2
Device(config-access-map)# action drop
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1772
Security
match (access-map configuration)
Device(config-access-map)# exit
Device(config)# vlan filter vmap4 vlan-list 5-6
Device(config)# exit
You can verify your settings by entering the show vlan access-map command.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1773
Security
mka pre-shared-key
mka pre-shared-key
To configure MACsec Key Agreement (MKA) MACsec on a device interface using a Pre Shared Key (PSK),
use the mka pre-shared-key command in interface configuration mode. To disable it, use the no form of this
command.
mka pre-shared-key key-chain key-chain-name [{ fallback key-chain key-chain-name }]
no mka pre-shared-key key-chain key-chain-name [{ fallback key-chain key-chain-name }]
Syntax Description key-chain Enables MACsec MKA configuration on device interfaces using a primary PSK.
fallback (Optional) Enables MACsec MKA configuration on device interfaces using a fallback
key-chain PSK.
key-chain-name Name of the key chain.
Command Default MKA pre-shared-key is disabled.
Command Modes Interface configuration (config-if)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Bengaluru 17.6.2 The fallback key-chain keyword
was introduced.
Usage Guidelines When fallback key-chain is configured under an interface that is MACsec capable, both the primary and
fallback key chains will be associated with the interface.
This example shows how to configure MKA MACsec on an interface using a primary PSK:
Device> enable
Device# configure terminal
Device(config)# interface Gigabitethernet 1/0/20
Device(config-if)# mka pre-shared-key key-chain kc1
Device(config-if)# end
Device#
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1774
Security
mka suppress syslogs sak-rekey
mka suppress syslogs sak-rekey
To suppress MACsec Key Agreement (MKA) secure association key (SAK) rekey messages during logging,
use the mka suppress syslogs sak-rekey command in global configuration mode. To enable MKA SAK
rekey message logging, use the no form of this command.
mka suppres syslogs sak-rekey
no mka suppres syslogs sak-rekey
This command has no arguments or keywords.
Command Default All MKA SAK syslog messages are displayed on the console.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Gibraltar 16.9.1 This command was introduced.
Usage Guidelines MKA SAK syslogs are continuously generated at every rekey interval, and when MKA is configured on
multiple interfaces, the amount of syslog generated is too high. Use this command to suppress the MKA SAK
syslogs.
Example
The following example shows show to suppress MKA SAK syslog logging:
Device> enable
Device# configure terminal
Device(config)# mka suppress syslogs sak-rekey
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1775
Security
orgid (Parameter Map)
orgid (Parameter Map)
To configure the API organization ID used for authorization during device registration, use the orgid command
in parameter-map type inspect configuration mode. To remove the organization ID, use the no form of this
command.
orgid value
no orgid
Syntax Description value The API organization ID. You can obtain this from the Cisco
Umbrella registration server.
Command Default No organization ID is created for the parameter map.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Cupertino 17.7.1 This command was introduced.
Usage Guidelines To perform API registration for the Umbrella Switch Connector, the api-key, orgid and secret commands
must be configured one after the other. The values for these commands can be retrieved from the Cisco
Umbrella registration server.
Examples The following example shows how to perform API registration for the Umbrella Switch Connector:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)# api-key 5f22922exxxxxxxxx51174af822734
Device(config-profile)# orgid 26xxx16
Device(config-profile)# secret 0 a0d176ebxxxxxxxfbb343dfc4fd209
Device(config-profile)# end
Related Commands Command Description
parameter-map type umbrella global Configures a parameter-map type in umbrella mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1776
Security
parameter-map type regex
parameter-map type regex
To configure a parameter-map type with a regular expression to match a specific traffic pattern, use the
parameter-map type regex command in global configuration mode. To delete a parameter-map type with a
regular expression, use the no form of this command.
parameter-map type regex parameter-map-name
no parameter-map type regex
Syntax Description parameter-map-name Name of the parameter map. The name can have a maximum of 228 alphanumeric
characters.
Note We do not recommend the use of blank spaces. The system interprets
the first blank space as the end of the parameter-map name unless
the string is delimited by quotation marks.
Command Default A regex parameter map is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines You can enter a regular expression to match text strings either as an exact string or by using metacharacters
to match multiple variants of a text string. You can use a regular expression to match the content of certain
application traffic. For example, you can match a uniform resource identifier (URI) string inside an HTTP
packet using the match request regex command under an HTTP inspection class map.
Press Ctrl-V to ignore all of the special characters in the CLI, such as a question mark (?) or a tab. For example,
press d[Ctrl-V]g to enter d?g in the configuration.
The following table lists the metacharacters that have special meanings.
Table 202: regex Metacharacters
Character Description Notes
. Dot Matches any single character. For example, d.g matches dog, dag,
dtg, and any word that contains those characters.
( xxx ) Subexpression Segregates characters from surrounding characters so that you can
use other metacharacters on the subexpression. For example, d(o|a)g
matches dog and dag, but do|ag matches do and ag. A subexpression
can also be used with repeat quantifiers to differentiate the characters
meant for repetition. For example, ab(xy){3}z matches abxyxyxyz.
| Alternation Matches either of the expressions that it separates. For example,
dog|cat matches dog or cat.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1777
Security
parameter-map type regex
Character Description Notes
? Question mark Indicates that there are 0 or 1 occurrence of the previous expression.
For example, lo?se matches lse or lose.
Note You must enter Ctrl-V and then a question mark.
Otherwise, the Help function is invoked.
* Asterisk Indicates that there are 0, 1, or any number of occurrences of the
previous expression. For example, lo*se matches lse, lose, loose, and
so on.
+ Plus Indicates that there is at least one occurrence of the previous
expression. For example, lo+se matches lose and loose, but not lse.
{ x } Repeat quantifier Repeats exactly x times. For example, ab(xy){3}z matches abxyxyxyz.
{ x ,} Minimum repeat Repeats at least x times. For example, ab(xy){2,}z matches abxyxyz,
quantifier abxyxyxyz, and so on.
[ abc ] Character class Matches any character in the bracket. For example, [abc] matches a,
b, or c.
[^ abc ] Negated character class Matches a single character that is not contained within brackets. For
example, [^abc] matches any character other than a, b, or c, and
[^A-Z] matches any single character that is not an uppercase letter.
[ a - c] Character range class Matches any character in the specified range. [a-z] matches any
lowercase letter. You can mix characters and ranges. For example,
[abcq-z] matches a, b, c, q, r, s, t, u, v, w, x, y, z, and so does [a-cq-z].
Note The dash (-) character is literal only if it is the last or
first character within brackets, for example, [abc-] or
[-abc].
“” Quotation marks Preserves trailing or leading spaces in the string. For example, "test"
preserves the leading space when it looks for a match.
^ Caret Specifies the beginning of a line.
\ Escape character When preceding a literal character, matches the literal character. For
example, \[ matches the left square bracket.
char Character When the character is not a metacharacter, matches the literal
character.
\r Carriage return Matches the carriage return 0x0d.
\n New line Matches the new line 0x0a.
\t Tab Matches the tab 0x09.
\f Formfeed Matches the form feed 0x0c.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1778
Security
parameter-map type regex
Character Description Notes
\x nn Escaped hexadecimal Matches an ASCII character using hexadecimal numbers (exactly two
number digits).
\ nnn Escaped octal number Matches an ASCII character as an octal number (exactly three digits).
For example, the character 040 represents a space.
Examples The following example shows how to configure and apply a regex parameter map to an HTTP
application firewall parameter-map type whose URI matches any of the following regular expressions:
• “.*cmd.exe”
• “.*money”
• “.*shopping”
Device> enable
Device# configure terminal
Device(config)# parameter-map type regex uri-regex-cm
Device(config-profile)# pattern ".*cmd.exe"
Device(config-profile)# pattern ".*money"
Device(config-profile)# pattern ".*shopping"
Device(config-profile)# exit
Device(config)# class-map type inspect http uri-check-cm
Device(config-cmap)# match request uri regex uri-regex-cm
Device(config-cmap)# exit
Device(config)# policy-map type inspect http uri-check-pm
Device(config-pmap)# class type inspect http uri-check-cm
Device(config-pmap-c)# reset
The following example shows how to configure a regex parameter map whose case-insensitive pattern
matches multiple variants of the string hello:
Device# configure terminal
Device(config)# parameter-map type regex body_regex
Device(config-profile)# pattern ".*[Hh][Ee][Ll][Ll][Oo]"
Device(config-profile)# end
Related Commands Command Description
class-map type inspect Creates a Layer 3 and Layer 4 or a Layer 7 (application-specific) inspect-type
class map.
class type inspect Specifies the traffic (class) on which an action is to be performed.
match request regex Configures an HTTP firewall policy to permit or deny HTTP traffic on the basis
of request messages whose URI or arguments (parameters) match a defined regular
expression.
parameter-map type Creates or modifies a parameter map.
policy-map type inspect Creates a Layer 3 and Layer 4 or a Layer 7 (application-specific) inspect-type
policy map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1779
Security
parameter-map type umbrella global
parameter-map type umbrella global
To configure a parameter-map type in umbrella mode, use the parameter-map type umbrella global command
in global configuration mode. To delete a parameter-map type in umbrella mode, use the no form of this
command.
parameter-map type umbrella global
no parameter-map type umbrella
Syntax Description This command has no arguments or keywords.
Command Default Umbrella mode parameter-map is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following example shows how to set the parameter-map type to umbrella mode:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)#
Related Commands Command Description
parameter-map type Creates or modifies a parameter map.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1780
Security
password encryption aes
password encryption aes
To enable a type 6 encrypted preshared key, use the password encryption aes command in global configuration
mode. To disable password encryption, use the no form of this command.
password encryption aes
no password encryption aes
Syntax Description This command has no arguments or keywords.
Command Default Preshared keys are not encrypted.
Command Modes Global configuration (config)
Command History Release Modif
Cisco IOS XE Everest 16.5.1a This c
introd
Usage Guidelines You can securely store plain text passwords in type 6 format in NVRAM using a CLI. Type 6 passwords are
encrypted. Although the encrypted passwords can be seen or retrieved, it is difficult to decrypt them to find
out the actual password. Use the key config-key password-encrypt command along with the password
encryption aes command to configure and enable the password (symmetric cipher Advanced Encryption
Standard [AES] is used to encrypt the keys). The password (key) that is configured using the key config-key
password-encrypt command is the master encryption key that is used to encrypt all other keys in the router.
If you configure the password encryption aes command without configuring the key config-key
password-encrypt command, the following message is displayed at startup or during a nonvolatile generation
(NVGEN) process, such as when the show running-config or copy running-config startup-config commands
are run:
“Can not encrypt password. Please configure a configuration-key with ‘key config-key’”
Changing a Password
If the password (master key) is changed or re-encrypted using the key config-key password-encrypt command),
the list registry passes the old key and the new key to the application modules that are using type 6 encryption.
Deleting a Password
If the master key that was configured using the key config-key password-encrypt command is deleted from
the system, a warning is displayed (and a confirm prompt is issued) that states that all type 6 passwords will
no longer be applicable. As a security measure, after the passwords are encrypted, they will never be decrypted
in the Cisco IOS software. However, passwords can be re-encrypted as explained in the previous paragraph.
Caution If a password that is configured using the key config-key password-encrypt command is lost, it cannot be
recovered. Therefore, the password should be stored in a safe location.
Unconfiguring Password Encryption
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1781
Security
password encryption aes
If you unconfigure password encryption using the no password encryption aes command, all the existing
type 6 passwords are left unchanged. As long as the password (master key) that was configured using the key
config-key password-encrypt command exists, the type 6 passwords are decrypted as and when required by
the application.
Storing Passwords
Because no one can read the password (configured using the key config-key password-encrypt command),
there is no way that the password can be retrieved from the router. Existing management stations cannot know
what it is unless the stations are enhanced to include this key somewhere. Therefore, the password needs to
be stored securely within the management system. If configurations are stored using TFTP, the configurations
are not standalone, meaning that they cannot be loaded onto a router. Before or after the configurations are
loaded onto a router, the password must be manually added (using the key config-key password-encrypt
command). The password can be manually added to the stored configuration, but we do not recommend this
because adding the password manually allows anyone to decrypt all the passwords in that configuration.
Configuring New or Unknown Passwords
If you enter or cut and paste ciphertext that does not match the master key, or if there is no master key, the
ciphertext is accepted or saved, but the following alert message is displayed:
“ciphertext>[for username bar>] is incompatible with the configured master key.”
If a new master key is configured, all the plain keys are encrypted and converted to type 6 keys. The existing
type 6 keys are not encrypted. The existing type 6 keys are left as is.
If the old master key is lost or unknown, you have the option of deleting the master key using the no key
config-key password-encrypt command. This causes the existing encrypted passwords to remain encrypted
in the router configuration. The passwords will not be decrypted.
Examples The following example shows how a type 6 encrypted preshared key is enabled:
Device> enable
Device# configure terminal
Device (config)# password encryption aes
Related Commands Command Description
key config-key password-encrypt Stores a type 6 encryption key in p
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1782
Security
pattern (Parameter Map)
pattern (Parameter Map)
To configure a matching pattern that specifies a list of domains, URL keywords, or URL metacharacters that
must be allowed or blocked by the local URL filtering, use the pattern command in parameter-map type
inspect configuration mode. To remove the matching pattern, use the no form of this command.
pattern expression
no pattern expression
Syntax Description expression Matching pattern argument that refers to a domain name, URL
keyword, URL metacharacter entry, or a URL keyword, and
URL-metacharacter combination.
Command Default No pattern is created for the parameter map.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Usage Guidelines A matching pattern expression is configured for a parameter map created by the parameter-map type regex
command.
In a pattern expression, the characters /, {, and } are not allowed. The question mark (?) character is not
allowed because it is reserved for the CLI Help function. The asterisk (*) character is not allowed at the
beginning of a pattern.
For URL pattern matching, the period (.) character is interpreted as a dot, and not as a wildcard entry that
represents a single character, as is the case with regular expression pattern matching. Any character in the
host or domain name can be allowed or blocked through URL filtering.
A URL keyword is a complete word that comes after the domain name and is between the forward slash (/)
path delimiters. For example, in the URL http://www.example.com/hack/123.html, only hack is treated as a
keyword. The entire keyword in the URL must match a pattern. For example, if you have configured a pattern
named hack, the URL www.example.com/hacksite/123.html will not match the pattern. To match the URL,
your pattern must have hacksite.
URL metacharacters allow pattern matching of single characters or ranges of characters to URLs, similar to
the way a UNIX glob expression works. URL metacharacters are described in the following table.
Table 203: URL Metacharacters for URL Pattern Matching
Character Description
* Asterisk: Matches any sequence of 0 or more characters.
[ abc ] Character class: Matches any character within brackets. Character
matching is case sensitive. For example, [abc] matches a, b, or c.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1783
Security
pattern (Parameter Map)
Character Description
[ a-c ] Character range class: Matches any character in a specified range.
Character matching is case sensitive. For example, [a-z] matches
any lowercase letter. You can also mix characters and ranges. For
example, [abcq-z] matches a, b, c, q, r, s, t, u, v, w, x, y, z, and so
does [a-cq-z].
Note The dash (-) character is matched only if it is the last
or the first character within brackets, for example,
[abc-] or [-abc].
[ 0-9 ] Numerical range class: Matches any number within brackets. For
example, [0-9] matches 0, 1, 2, 3, 4, 5, 6, 7, 8, or 9.
URL metacharacters are combined with domain names and URL keywords for pattern matching. For example,
the pattern www.example[0-9][0-9].com can be used to block www.example01.com, www.example33.com,
www.example99.com, and so on. You can combine a keyword and a metacharacter and create a matching
pattern to block a URL. For example, you can use pattern hack* to block www.example.com/hacksite/123.html.
When you configure the parameter-map type regex command and then the pattern command, patterns that
are specified in the pattern command are used as filters in General Packet Radio Service (GPRS) Tunneling
Protocol (GTP) classes.
Examples The following example shows how to configure a matching pattern for a specified URL:
Device(config)# parameter-map type regex dns_bypass
Device(config-profile)# pattern www.example.com
The following example shows how to specify a case-insensitive pattern that matches multiple variants
of the string hello:
Device> enable
Device# configure terminal
Device(config)# parameter-map type regex body-regex
Device(config-profile)# pattern ".*[Hh][Ee][Ll][Ll][Oo]"
The following example shows an error message that appears on the console when an asterisk (*)
character is specified at the beginning of a pattern:
Device(config)# parameter-map type regex gtp-map
Device(config-profile)# pattern *.gprs.com
%Invalid first char + or * in regex pattern
Related Commands Command Description
parameter-map type regex Configures a regex parameter map that matches a specific regular expression
pattern and enters parameter-map type inspect configuration mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1784
Security
permit (MAC access-list configuration)
permit (MAC access-list configuration)
To allow non-IP traffic to be forwarded if the conditions are matched, use the permit command in MAC
access-list configuration mode. To remove a permit condition from the extended MAC access list, use the no
form of this command.
{permit {any | hostsrc-MAC-addr | src-MAC-addr mask} {any | hostdst-MAC-addr |
dst-MAC-addr mask} [type mask | aarp | amber | appletalk | dec-spanning | decnet-iv |
diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | lsaplsap mask | mop-console
| mop-dump | msdos | mumps | netbios | vines-echo | vines-ip | xns-idp][coscos]
nopermit {any | host src-MAC-addr | src-MAC-addr mask} {any | host dst-MAC-addr |
dst-MAC-addr mask} [type mask | aarp | amber | appletalk | dec-spanning | decnet-iv |
diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | lsap lsap mask | mop-console
| mop-dump | msdos | mumps | netbios | vines-echo | vines-ip | xns-idp][coscos]
Syntax Description any Denies any source or destination MAC address.
host src-MAC-addr | src-MAC-addr mask Specifies a host MAC address and optional subnet ma
defined address, non-IP traffic from that address is de
host dst-MAC-addr | dst-MAC-addr mask Specifies a destination MAC address and optional sub
matches the defined address, non-IP traffic to that add
type mask (Optional) Specifies the EtherType number of a packe
identify the protocol of the packet.
• type is 0 to 65535, specified in hexadecimal.
• mask is a mask of don’t care bits applied to the E
aarp (Optional) Specifies EtherType AppleTalk Address R
to a network address.
amber (Optional) Specifies EtherType DEC-Amber.
appletalk (Optional) Specifies EtherType AppleTalk/EtherTalk.
dec-spanning (Optional) Specifies EtherType Digital Equipment Co
decnet-iv (Optional) Specifies EtherType DECnet Phase IV pro
diagnostic (Optional) Specifies EtherType DEC-Diagnostic.
dsm (Optional) Specifies EtherType DEC-DSM.
etype-6000 (Optional) Specifies EtherType 0x6000.
etype-8042 (Optional) Specifies EtherType 0x8042.
lat (Optional) Specifies EtherType DEC-LAT.
lavc-sca (Optional) Specifies EtherType DEC-LAVC-SCA.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1785
Security
permit (MAC access-list configuration)
lsap lsap-number mask (Optional) Specifies the LSAP number (0 to 65535) of a
the protocol of the packet.
The mask is a mask of don’t care bits applied to the LSAP
mop-console (Optional) Specifies EtherType DEC-MOP Remote Cons
mop-dump (Optional) Specifies EtherType DEC-MOP Dump.
msdos (Optional) Specifies EtherType DEC-MSDOS.
mumps (Optional) Specifies EtherType DEC-MUMPS.
netbios (Optional) Specifies EtherType DEC- Network Basic Inp
vines-echo (Optional) Specifies EtherType Virtual Integrated Network
vines-ip (Optional) Specifies EtherType VINES IP.
xns-idp (Optional) Specifies EtherType Xerox Network Systems
cos cos (Optional) Specifies an arbitrary class of service (CoS) nu
CoS can be performed only in hardware. A warning mess
Command Default This command has no defaults. However, the default action for a MAC-named ACL is to deny.
Command Modes MAC-access list configuration
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Though visible in the command-line help strings, appletalk is not supported as a matching condition.
You enter MAC access-list configuration mode by using the mac access-list extended global configuration
command.
If you use the host keyword, you cannot enter an address mask; if you do not use the any or host keywords,
you must enter an address mask.
After an access control entry (ACE) is added to an access control list, an implied deny-any-any condition
exists at the end of the list. That is, if there are no matches, the packets are denied. However, before the first
ACE is added, the list permits all packets.
To filter IPX traffic, you use the type mask or lsap lsap mask keywords, depending on the type of IPX
encapsulation being used. Filter criteria for IPX encapsulation types as specified in Novell terminology and
Cisco IOS XE terminology are listed in the following table.
Table 204: IPX Filtering Criteria
IPX Encapsulation Type Filter Criterion
Cisco IOS Name Novell Name
arpa Ethernet II EtherType 0x8137
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1786
Security
permit (MAC access-list configuration)
IPX Encapsulation Type Filter Criterion
Cisco IOS Name Novell Name
snap Ethernet-snap EtherType 0x8137
sap Ethernet 802.2 LSAP 0xE0E0
novell-ether Ethernet 802.3 LSAP 0xFFFF
This example shows how to define the MAC-named extended access list to allow NetBIOS traffic
from any source to MAC address 00c0.00a0.03fa. Traffic matching this list is allowed.
Device> enable
Device# configure terminal
Device(config)# mac access-list extended
Device(config-ext-macl)# permit any host 00c0.00a0.03fa netbios
Device(config-ext-macl)# end
This example shows how to remove the permit condition from the MAC-named extended access list:
Device> enable
Device# configure terminal
Device(config)# mac access-list extended
Device(config-ext-macl)# no permit any 00c0.00a0.03fa 0000.0000.0000 netbios
Device(config-ext-macl)# end
This example permits all packets with EtherType 0x4321:
Device> enable
Device# configure terminal
Device(config)# mac access-list extended
Device(config-ext-macl)# permit any any 0x4321 0
Device(config-ext-macl)# end
You can verify your settings by entering the show access-lists command.
Related Commands Command Description
deny Denies from the M
non-IP traffic to b
mac access-list extended Creates an access
traffic.
show access-lists Displays access co
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1787
Security
protocol (IPv6 snooping)
protocol (IPv6 snooping)
s
To specify that addresses should be gleaned with Dynamic Host Configuration Protocol (DHCP) or Neighbor
Discovery Protocol (NDP), or to associate the protocol with an IPv6 prefix list, use the protocol command
in IPv6 snooping configuration mode. To disable address gleaning with DHCP or NDP, use the no form of
the command.
protocol {dhcp | ndp}
no protocol {dhcp | ndp}
Syntax Description dhcp Specifies that addresses should be gleaned in Dynamic Host Configuration Protocol (DHCP) packets.
ndp Specifies that addresses should be gleaned in Neighbor Discovery Protocol (NDP) packets.
Command Default Snooping and recovery are attempted using both DHCP and NDP.
Command Modes IPv6 snooping configuration mode (config-ipv6-snooping)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines If an address does not match the prefix list associated with DHCP or NDP, then control packets will be dropped
and recovery of the binding table entry will not be attempted with that protocol.
• Using the no protocol {dhcp | ndp} command indicates that a protocol will not be used for snooping
or gleaning.
• If the no protocol dhcp command is used, DHCP can still be used for binding table recovery.
• Data glean can recover with DHCP and NDP, though destination guard will only recovery through DHCP.
This example shows how to define an IPv6 snooping policy name as policy1, and configure the port
to use DHCP to glean addresses:
Device> enable
Device# configure terminal
Device(config)# ipv6 snooping policy policy1
Device(config-ipv6-snooping)# protocol dhcp
Device(config-ipv6-snooping)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1788
Security
radius server
radius server
To configure the RADIUS server parameters, including the RADIUS accounting and authentication, use the
radius server command in global configuration mode. Use the no form of this command to return to the
default settings.
radius server name
address {ipv4 | ipv6} ip{address | hostname} auth-port udp-port acct-port udp-port
key string
automate tester name | retransmit value | timeout seconds
no radius server name
Syntax Description address {ipv4 | ipv6} Specifies the IP address of the RADIUS server.
ip{address | hostname}
auth-port udp-port (Optional) Specifies the UDP port for the RADIUS authentication server. The
range is from 0 to 65536.
acct-port udp-port (Optional) Specifies the UDP port for the RADIUS accounting server. The range
is from 0 to 65536.
key string (Optional) Specifies the authentication and encryption key for all RADIUS
communication between the device and the RADIUS daemon.
Note The key is a text string that must match the encryption key used
on the RADIUS server. Always configure the key as the last item
in this command. Leading spaces are ignored, but spaces within
and at the end of the key are used. If there are spaces in your key,
do not enclose the key in quotation marks unless the quotation
marks are part of the key.
automate tester name (Optional) Enables automatic server testing of the RADIUS server status, and
specify the username to be used.
retransmit value (Optional) Specifies the number of times a RADIUS request is resent when the
server is not responding or responding slowly. The range is 1 to 100. This setting
overrides the radius-server retransmit global configuration command setting.
timeout seconds (Optional) Specifies the time interval that the device waits for the RADIUS
server to reply before sending a request again. The range is 1 to 1000. This
setting overrides the radius-server timeout command.
Command Default • The UDP port for the RADIUS accounting server is 1646.
• The UDP port for the RADIUS authentication server is 1645.
• Automatic server testing is disabled.
• The timeout is 60 minutes (1 hour).
• When the automatic testing is enabled, testing occurs on the accounting and authentication UDP ports.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1789
Security
radius server
• The authentication and encryption key ( string) is not configured.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines • We recommend that you configure the UDP port for the RADIUS accounting server and the UDP port
for the RADIUS authentication server to non-default values.
• You can configure the authentication and encryption key by using the key string command in RADIUS
server configuration mode. Always configure the key as the last item in this command.
• Use the automate-tester name keywords to enable automatic server testing of the RADIUS server status
and to specify the username to be used.
This example shows how to configure 1645 as the UDP port for the authentication server and 1646
as the UDP port for the accounting server, and configure a key string:
Device> enable
Device# configure terminal
Device(config)# radius server ISE
Device(config-radius-server)# address ipv4 10.1.1 auth-port 1645 acct-port 1646
Device(config-radius-server)# key cisco123
Device(config-radius-server)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1790
Security
radius-server dscp
radius-server dscp
To configure DSCP marking for authentication and accounting on RADIUS servers, use the radius-server
command. To disable DSCP marking for authentication and accounting on RADIUS servers, use the no form
of the command.
radius-server dscp { acct dscp_acct_value | auth dscp_auth_value }
Syntax Description acct dscp_acct_value Configures RADIUS DSCP marking value for accounting. The valid range is from
1 to 63. The default value is 0.
auth dscp_auth_value Configures RADIUS DSCP marking value for authentication. The valid range is
from 1 to 63. The default value is 0.
Command Default The DSCP marking on RADIUS packets is disabled by default.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was
introduced.
Example
This example shows how to configure DSCP marking for authentication and accounting on RADIUS
packets:
Device# configure terminal
Device(config)# radius-server dscp auth 10 acct 20
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1791
Security
radius-server dead-criteria
radius-server dead-criteria
To force one or both of the criteria, used to mark a RADIUS server as dead, to be the indicated constant, use
the radius-server dead-criteria command in global configuration mode. To disable the criteria that were set,
use the no form of this command.
radius-server dead-criteria [time seconds] [tries number-of-tries]
no radius-server dead-criteria [{time seconds | tries number-of-tries}]
Syntax Description time seconds (Optional) Minimum amount of time, in seconds, that must elapse from the time that the
device last received a valid packet from the RADIUS server to the time the server is marked
as dead. If a packet has not been received since the device booted, and there is a timeout,
the time criterion will be treated as though it has been met. You can configure the time to
be from 1 through 120 seconds.
• If the seconds argument is not configured, the number of seconds will range from 10
to 60 seconds, depending on the transaction rate of the server.
Note Both the time criterion and the tries criterion must be met for the server to be
marked as dead.
tries (Optional) Number of consecutive timeouts that must occur on the device before the RADIUS
number-of-tries server is marked as dead. If the server performs both authentication and accounting, both
types of packets will be included in the number. Improperly constructed packets will be
counted as though they were timeouts. All transmissions, including the initial transmit and
all retransmits, will be counted. You can configure the number of timeouts to be from 1
through 100.
• If the number-of-tries argument is not configured, the number of consecutive timeouts
will range from 10 to 100, depending on the transaction rate of the server and the
number of configured retransmissions.
Note Both the time criterion and the tries criterion must be met for the server to be
marked as dead.
Command Default The number of seconds and number of consecutive timeouts that occur before the RADIUS server is marked
as dead will vary, depending on the transaction rate of the server and the number of configured retransmissions.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1792
Security
radius-server dead-criteria
Usage Guidelines
Note Both the time criterion and the tries criterion must be met for the server to be marked as dead.
The no form of this command has the following cases:
• If neither the seconds nor the number-of-tries argument is specified with the no radius-server
dead-criteria command, both time and tries will be reset to their defaults.
• If the seconds argument is specified using the originally set value, the time will be reset to the default
value range (10 to 60).
• If the number-of-tries argument is specified using the originally set value, the number of tries will be
reset to the default value range (10 to 100).
Examples The following example shows how to configure the device so that it will be considered dead after 5
seconds and 4 tries:
Device> enable
Device# configure terminal
Device(config)# radius-server dead-criteria time 5 tries 4
The following example shows how to disable the time and number-of-tries criteria that were set for
the radius-server dead-criteria command.
Device(config)# no radius-server dead-criteria
The following example shows how to disable the time criterion that was set for the radius-server
dead-criteria command.
Device(config)# no radius-server dead-criteria time 5
The following example shows how to disable the number-of-tries criterion that was set for the
radius-server dead-criteria command.
Device(config)# no radius-server dead-criteria tries 4
Related Commands Command Description
debug aaa dead-criteria transactions Displays AAA dead-criteria transaction values.
show aaa dead-criteria Displays dead-criteria information for a AAA server.
show aaa server-private Displays the status of all private RADIUS servers.
show aaa servers Displays information about the number of packets sent to and
received from AAA servers.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1793
Security
radius-server deadtime
radius-server deadtime
To improve RADIUS response time when some servers might be unavailable and to skip unavailable servers
immediately, use the radius-server deadtime command in global configuration mode. To set deadtime to 0,
use the no form of this command.
radius-server deadtime minutes
no radius-server deadtime
Syntax Description minutes Length of time, in minutes (up to a maximum of 1440 minutes or 24 hours), for which a RADIUS
server is skipped over by transaction requests.
Command Default Dead time is set to 0.
Command Modes Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use this command to enable the Cisco IOS software to mark as dead any RADIUS servers that fail to respond
to authentication requests, thus avoiding the wait for the request to time out before trying the next configured
server. A RADIUS server marked as dead is skipped by additional requests for the specified duration (in
minutes) or unless there are no servers not marked as dead.
Note If a RADIUS server that is marked as dead receives a directed-request, the directed- request is not omitted
by the RADIUS server. The RADIUS server continues to process the directed-request because the request is
directly sent to the RADIUS server.
The RADIUS server will be marked as dead if both of the following conditions are met:
1. A valid response has not been received from the RADIUS server for any outstanding transaction for at
least the timeout period that is used to determine whether to retransmit to that server, and
2. At at least the requisite number of retransmits plus one (for the initial transmission) have been sent
consecutively across all transactions being sent to the RADIUS server without receiving a valid response
from the server within the requisite timeout.
Examples The following example specifies five minutes of deadtime for RADIUS servers that fail to respond
to authentication requests:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# radius-server deadtime 5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1794
Security
radius-server deadtime
Related Commands Command Description
deadtime (server-group configuration) Configures deadtime within the context of RADIUS server
groups.
radius-server host Specifies a RADIUS server host.
radius-server retransmit Specifies the number of times that the Cisco IOS software
searches the list of RADIUS server hosts before giving up.
radius-server timeout Sets the interval for which a device waits for a server host to
reply.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1795
Security
radius-server directed-request
radius-server directed-request
To allow users to log in to a Cisco network access server (NAS) and select a RADIUS server for authentication,
use the radius-server directed-request command in global configuration mode. To disable the directed-request
function, use the no form of this command.
radius-server directed-request [restricted]
no radius-server directed-request [restricted]
Syntax Description restricted (Optional) Prevents the user from being sent to a secondary server if the specified server is not
available.
Command Default The User cannot log in to a Cisco NAS and select a RADIUS server for authentication.
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The radius-server directed-request command sends only the portion of the username before the “@” symbol
to the host specified after the “@” symbol. In other words, with this command enabled, you can direct a
request to any of the configured servers, and only the username is sent to the specified server.
Note If a private RADIUS server is used as the group server by configuring the server-private (RADIUS) command,
then the radius-server directed-request command cannot be configured.
The following is the sequence of events to send a message to RADIUS servers:
• If the radius-server directed-request command is configured:
• A request is sent to the directed server. If there are more servers with the same IP address, the request
is sent only to the first server with same IP address.
• If a response is not received, requests will be sent to all servers listed in the first method list.
• If no response is received with the first method, the request is sent to all servers listed in the second
method list until the end of the method list is reached.
Note To select the directed server, search the first server group in the method list for a server with the IP address
provided in a directed request. If it is not available, the first server group with the same IP address from the
global pool is considered.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1796
Security
radius-server directed-request
• If the radius-server directed-request restricted command is configured for every server group in the
method list, until the response is received from the directed server or the end of method list is reached,
the following actions occur:
• The first server with an IP address of the directed server will be used to send the request.
• If a server with the same IP address is not found in the server group, then the first server in the
global pool with the IP address of the directed-server will be used.
If the radius-server directed-request command is disabled using the no radius-server directed-request
command, the entire string, both before and after the “@” symbol, is sent to the default RADIUS server. The
router queries the list of servers, starting with the first one in the list. It sends the whole string, and accepts
the first response from the server.
Use the radius-server directed-request restricted command to limit the user to the RADIUS server identified
as part of the username.
If the user request has a server IP address, then the directed server forwards it to a specific server before
forwarding it to the group. For example, if a user request such as [email protected] is sent to the directed server,
and if the IP address specified in this user request is the IP address of a server, the directed server forwards
the user request to the specific server.
If a directed server is configured both on the server group and on the host server, and if the user request with
the configured server name is sent to the directed server, the directed server forwards the user request to the
host server before forwarding it to the server group. For example, if a user request of [email protected] is sent
to the directed server and 10.0.0.1 is the host server address, then the directed server forwards the user request
to the host server before forwarding the request to the server group.
Note When the no radius-server directed-request restricted command is entered, only the restricted flag is
removed, and the directed-request flag is retained. To disable the directed-request function, you must also
enter the no radius-server directed-request command.
Examples The following example shows how to configure the directed-request function:
Device> enable
Device# configure terminal
Device(config)# radius server rad-1
Device(config-radius-server)# address ipv4 10.1.1.2
Device(config-radius-server)# key dummy123
Device(config-radius-server)# exit
Device(config)# radius-server directed-request
Related Commands Command Description
aaa group server Groups different server hosts into distinct lists and distinct methods.
aaa new-model Enables the AAA access control model.
server-private (RADIUS) Configures the IP address of the private RADIUS server for the group server.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1797
Security
radius-server domain-stripping
radius-server domain-stripping
To configure a network access server (NAS) to strip suffixes, or to strip both suffixes and prefixes from the
username before forwarding the username to the remote RADIUS server, use the radius-server
domain-stripping command in global configuration mode. To disable a stripping configuration, use the no
form of this command.
Note The ip vrf default command must be configured in global configuration mode before the radius-server
domain-stripping command is configured to ensure that the default VRF name is a NULL value until the
defaulf vrf name is configured.
radius-server domain-stripping [{ [right-to-left] [ prefix-delimiter character [ character2
. . . character7 ] ] [ delimiter character [ character2 . . . character7 ] ] | strip-suffix
suffix }] [ vrf vrf-name ]
no radius-server domain-stripping [{ [right-to-left] [ prefix-delimiter character [ character2
. . . character7 ] ] [ delimiter character [ character2 . . . character7 ] ] | strip-suffix
suffix }] [ vrf vrf-name ]
Syntax Description right-to-left (Optional) Specifies that the NAS will apply the stripping configuration at the
first delimiter found when parsing the full username from right to left. The default
is for the NAS to apply the stripping configuration at the first delimiter found
when parsing the full username from left to right.
prefix-delimiter (Optional) Enables prefix stripping and specifies the character or characters that
character will be recognized as a prefix delimiter. Valid values for the character argument
[character2...character7] are @, /, $, %, \, #, and -. Multiple characters can be entered without intervening
spaces. Up to seven characters can be defined as prefix delimiters, which is the
maximum number of valid characters. If a \ is entered as the final or only value
for the character argument, it must be entered as \\. No prefix delimiter is defined
by default.
delimiter character (Optional) Specifies the character or characters that will be recognized as a suffix
[character2...character7] delimiter. Valid values for the character argument are @, /, $, %, \, #, and -.
Multiple characters can be entered without intervening spaces. Up to seven
characters can be defined as suffix delimiters, which is the maximum number of
valid characters. If a \ is entered as the final or only value for the character
argument, it must be entered as \\. The default suffix delimiter is the @ character.
strip-suffix suffix (Optional) Specifies a suffix to strip from the username.
vrf vrf-name (Optional) Restricts the domain stripping configuration to a Virtual Private
Network (VPN) routing and forwarding (VRF) instance. The vrf-nameargument
specifies the name of a VRF.
Command Default Stripping is disabled. The full username is sent to the RADIUS server.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1798
Security
radius-server domain-stripping
Command Modes
Global configuration (config)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Use the radius-server domain-stripping command to configure the NAS to strip the domain from a username
before forwarding the username to the RADIUS server. If the full username is [email protected], enabling
the radius-server domain-stripping command results in the username “user1” being forwarded to the
RADIUS server.
Use the right-to-left keyword to specify that the username should be parsed for a delimiter from right to left,
rather than from left to right. This allows strings with two instances of a delimiter to strip the username at
either delimiter. For example, if the username is [email protected]@cisco.net, the suffix could be stripped in
two ways. The default direction (left to right) would result in the username “user” being forwarded to the
RADIUS server. Configuring the right-to-left keyword would result in the username “[email protected]” being
forwarded to the RADIUS server.
Use the prefix-delimiter keyword to enable prefix stripping and to specify the character or characters that
will be recognized as a prefix delimiter. The first configured character that is parsed will be used as the prefix
delimiter, and any characters before that delimiter will be stripped.
Use the delimiter keyword to specify the character or characters that will be recognized as a suffix delimiter.
The first configured character that is parsed will be used as the suffix delimiter, and any characters after that
delimiter will be stripped.
Use strip-suffix suffix to specify a particular suffix to strip from usernames. For example, configuring the
radius-server domain-stripping strip-suffix cisco.net command would result in the username [email protected]
being stripped, while the username [email protected] will not be stripped. You may configure multiple suffixes
for stripping by issuing multiple instances of the radius-server domain-stripping command. The default
suffix delimiter is the @ character.
Note Issuing the radius-server domain-stripping s trip-suffix suffix command disables the capacity to strip
suffixes from all domains. Both the suffix delimiter and the suffix must match for the suffix to be stripped
from the full username. The default suffix delimiter of @ will be used if you do not specify a different suffix
delimiter or set of suffix delimiters using the delimiterkeyword.
To apply a domain-stripping configuration only to a specified VRF, use the vrf vrf-name option.
The interactions between the different types of domain stripping configurations are as follows:
• You may configure only one instance of the radius-server domain-stripping[right-to-left]
[prefix-delimiter character [character2...character7]] [delimiter character [character2...character7]]
command.
• You may configure multiple instances of the radius-server domain-stripping[right-to-left]
[prefix-delimiter character [character2...character7]] [delimiter character [character2...character7]]
[vrf vrf-name] command with unique values for vrf vrf-name.
• You may configure multiple instances of the radius-server domain-stripping strip-suffix suffix[vrf
per-vrf] command to specify multiple suffixes to be stripped as part of a global or per-VRF ruleset.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1799
Security
radius-server domain-stripping
• Issuing any version of the radius-server domain-stripping command automatically enables suffix
stripping using the default delimiter character @ for that ruleset, unless a different delimiter or set of
delimiters is specified.
• Configuring a per-suffix stripping rule disables generic suffix stripping for that ruleset. Only suffixes
that match the configured suffix or suffixes will be stripped from usernames.
Examples The following example configures the router to parse the username from right to left and sets the
valid suffix delimiter characters as @, \, and $. If the full username is cisco/[email protected]$cisco.net,
the username “cisco/[email protected]” will be forwarded to the RADIUS server because the $ character
is the first valid delimiter encountered by the NAS when parsing the username from right to left.
radius-server domain-stripping right-to-left delimiter @\$
The following example configures the router to strip the domain name from usernames only for users
associated with the VRF instance named abc. The default suffix delimiter @ will be used for generic
suffix stripping.
radius-server domain-stripping vrf abc
The following example enables prefix stripping using the character / as the prefix delimiter. The
default suffix delimiter character @ will be used for generic suffix stripping. If the full username is
cisco/[email protected], the username “user” will be forwarded to the RADIUS server.
radius-server domain-stripping prefix-delimiter /
The following example enables prefix stripping, specifies the character / as the prefix delimiter, and
specifies the character # as the suffix delimiter. If the full username is cisco/[email protected]#cisco.net,
the username “[email protected]” will be forwarded to the RADIUS server.
radius-server domain-stripping prefix-delimiter / delimiter #
The following example enables prefix stripping, configures the character / as the prefix delimiter,
configures the characters $, @, and # as suffix delimiters, and configures per-suffix stripping of the
suffix cisco.com. If the full username is cisco/[email protected], the username “user” will be forwarded
to the RADIUS server. If the full username is cisco/[email protected]#cisco.com, the username
“[email protected]” will be forwarded.
radius-server domain-stripping prefix-delimiter / delimiter $@#
radius-server domain-stripping strip-suffix cisco.com
The following example configures the router to parse the username from right to left and enables
suffix stripping for usernames with the suffix cisco.com. If the full username is
cisco/[email protected]@cisco.com, the username “cisco/[email protected]” will be forwarded to the
RADIUS server. If the full username is cisco/[email protected]@cisco.net, the full username will be
forwarded.
radius-server domain-stripping right-to-left
radius-server domain-stripping strip-suffix cisco.com
The following example configures a set of global stripping rules that will strip the suffix cisco.com
using the delimiter @, and a different set of stripping rules for usernames associated with the VRF
named myvrf:
radius-server domain-stripping strip-suffix cisco.com
!
radius-server domain-stripping prefix-delimiter # vrf myvrf
radius-server domain-stripping strip-suffix cisco.net vrf myvrf
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1800
Security
radius-server domain-stripping
Related Commands Command Description
aaa new-model Enables the AAA access control model.
ip vrf Defines a VRF instance and enters VRF configuration mode.
tacacs-server domain-stripping Configures a router to strip a prefix or suffix from the username before
forwarding the username to the TACACS+ server.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1801
Security
sak-rekey
sak-rekey
To configure the Security Association Key (SAK) rekey time interval for a defined MKA policy, use the
sak-rekey command in MKA-policy configuration mode. To stop the SAK rekey timer, use the no form of
this command.
sak-rekey {interval time-interval | on-live-peer-loss}
no sak-rekey {interval | on-live-peer-loss}
Syntax Description interval SAK rekey interval in seconds.
time-interval
The range is from 30 to 65535, and the default is 0.
on-live-peer-loss Peer loss from the live membership.
Command Default The SAK rekey timer is disabled. The default is 0.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.8.1a
Examples The following example shows how to configure the SAK rekey interval:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# sak-rekey interval 300
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
delay-protection Configures MKA to use delay protection in sending MKPDU.
include-icv-indicator Includes ICV indicator in MKPDU.
key-server Configures MKA key-server options.
macsec-cipher-suite Configures cipher suite for deriving SAK.
send-secure-announcements Configures MKA to send secure announcements in sending MKPDUs.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated Ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1802
Security
secret (Parameter Map)
secret (Parameter Map)
To configure the API secret password used for authorization during device registration, use the secret command
in parameter-map type inspect configuration mode. To remove the secret password, use the no form of this
command.
secret { 0 | 6 unencrypted-password }
no secret { 0 | 6 unencrypted-password }
Syntax Description 0 Specifies that an unencrypted password or secret (depending
on the configuration) follows.
6 Specifies that an encrypted password follows.
unencrypted-password The unencrypted (cleartext) user password.
Command Default No password is created for the parameter map.
Command Modes Parameter-map type inspect configuration (config-profile)
Command History Release Modification
Cisco IOS XE Cupertino 17.7.1 This command was introduced.
Usage Guidelines To perform API registration for the Umbrella Switch Connector, the api-key, orgid and secret commands
must be configured one after the other. The values for these commands can be retrieved from the Cisco
Umbrella registration server.
Examples The following example shows how to perform API registration for the Umbrella Switch Connector:
Device> enable
Device# configure terminal
Device(config)# parameter-map type umbrella global
Device(config-profile)# api-key 5f22922exxxxxxxxx51174af822734
Device(config-profile)# orgid 26xxx16
Device(config-profile)# secret 0 a0d176ebxxxxxxxfbb343dfc4fd209
Device(config-profile)# end
Related Commands Command Description
parameter-map type umbrella global Configures a parameter-map type in umbrella mode.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1803
Security
security level (IPv6 snooping)
security level (IPv6 snooping)
To specify the level of security enforced, use the security-level command in IPv6 snooping policy configuration
mode.
security level {glean | guard | inspect}
Syntax Description glean Extracts addresses from the messages and installs them into the binding
table without performing any verification.
guard Performs both glean and inspect. Additionally, RA, and DHCP server
messages are rejected unless they are received on a trusted port or another
policy authorizes them.
inspect Validates messages for consistency and conformance; in particular, address
ownership is enforced. Invalid messages are dropped.
Command Default The default security level is guard.
Command Modes IPv6 snooping configuration (config-ipv6-snooping)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This example shows how to define an IPv6 snooping policy name as policy1 and configure the
security level as inspect:
Device> enable
Device# configure terminal
Device(config)# ipv6 snooping policy policy1
Device(config-ipv6-snooping)# security-level inspect
Device(config-ipv6-snooping)# end
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1804
Security
security passthru
security passthru
To modify the IPsec pass-through, use the security passthru command. To disable, use the no form of the
command.
security passthru ip-address
no security passthru
Syntax Description ip-address IP address of the IPsec gateway that is terminating the VPN tunnel.
Command Default None.
Command Modes wlan
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This example shows how to modify IPSec pass-through.
Device> enable
Device# configure terminal
Device(config)# security passthrough 10.1.1.1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1805
Security
send-secure-announcements
send-secure-announcements
To enable MKA to send secure announcements in MACsec Key Agreement Protocol Data Units (MKPDUs),
use the send-secure-announcements command in MKA-policy configuration mode. To disable sending of
secure announcements, use the no form of this command.
send-secure-announcements
no send-secure-announcements
Syntax Description This command has no arguments or keywords.
Command Default Secure announcements in MKPDUs is disabled.
Command Modes MKA-policy configuration (config-mka-policy)
Command History Release Modification
Cisco IOS XE Fuji This command was introduced.
16.9.1
Usage Guidelines Secure announcements revalidate the MACsec Cipher Suite capabilities which were shared previously through
unsecure announcements.
Examples The following example shows how to enable sending of secure announcements:
Device> enable
Device# configure terminal
Device(config)# mka policy 2
Device(config-mka-policy)# send-secure-announcements
Related Commands Command Description
mka policy Configures an MKA policy.
confidentiality-offset Sets the confidentiality offset for MACsec operations.
delay-protection Configures MKA to use delay protection in sending MKPDU.
include-icv-indicator Includes ICV indicator in MKPDU.
key-server Configures MKA key-server options.
macsec-cipher-suite Configures cipher suite for deriving SAK.
sak-rekey Configures the SAK rekey interval.
ssci-based-on-sci Computes SSCI based on the SCI.
use-updated-eth-header Uses the updated ethernet header for ICV calculation.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1806
Security
server-private (RADIUS)
server-private (RADIUS)
To configure the IP address of the private RADIUS server for the group server, use the server-private
command in RADIUS server-group configuration mode. To remove the associated private server from the
authentication, authorization, and accounting (AAA) group server, use the no form of this command.
server-private ip-address [{auth-port port-number | acct-port port-number}] [non-standard] [timeout
seconds] [retransmit retries] [key string]
no server-private ip-address [{auth-port port-number | acct-port port-number}] [non-standard]
[timeout seconds] [retransmit retries] [key string]
Syntax Description ip-address IP address of the private RADIUS server host.
auth-port port-number (Optional) User Datagram Protocol (UDP) destination port for authentication
requests. The default value is 1645.
acct-port port-number Optional) UDP destination port for accounting requests. The default value is 1646.
non-standard (Optional) RADIUS server is using vendor-proprietary RADIUS attributes.
timeout seconds (Optional) Time interval (in seconds) that the device waits for the RADIUS server
to reply before retransmitting. This setting overrides the global value of the
radius-server timeout command. If no timeout value is specified, the global value
is used.
retransmit retries (Optional) Number of times a RADIUS request is resent to a server, if that server
is not responding or responding slowly. This setting overrides the global setting of
the radius-server retransmit command.
key string (Optional) Authentication and encryption key used between the device and the
RADIUS daemon running on the RADIUS server. This key overrides the global
setting of the radius-server key command. If no key string is specified, the global
value is used.
The string can be 0 (specifies that an unencrypted key follows), 6 (specifies that
an advanced encryption scheme [AES] encrypted key follows), 7 (specifies that a
hidden key follows), or a line specifying the unencrypted (clear-text) server key.
Command Default If server-private parameters are not specified, global configurations will be used; if global configurations are
not specified, default values will be used.
Command Modes
RADIUS server-group configuration (config-sg-radius)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the server-private command to associate a particular private server with a defined server group. To
prevent possible overlapping of private addresses between virtual route forwarding (VRF) instances, private
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1807
Security
server-private (RADIUS)
servers (servers with private addresses) can be defined within the server group and remain hidden from other
groups, while the servers in the global pool (default "radius" server group) can still be referred to by IP
addresses and port numbers. Thus, the list of servers in server groups includes references to the hosts in the
global configuration and the definitions of private servers.
Note • If the radius-server directed-request command is configured, then a private RADIUS server cannot
be used as the group server by configuring the server-private (RADIUS) command.
• Creating or updating AAA server statistics record for private RADIUS servers are not supported. If
private RADIUS servers are used, then error messages and tracebacks will be encountered, but these
error messages or tracebacks do not have any impact on the AAA RADIUS functionality. To avoid these
error messages and tracebacks, configure public RADIUS server instead of private RADIUS server.
Use the password encryption aes command to configure type 6 AES encrypted keys.
Examples The following example shows how to define the sg_water RADIUS group server and associate private
servers with it:
Device> enable
Device# configure terminal
Device(config)# aaa new-model
Device(config)# aaa group server radius sg_water
Device(config-sg-radius)# server-private 10.1.1.1 timeout 5 retransmit 3 key xyz
Device(config-sg-radius)# server-private 10.2.2.2 timeout 5 retransmit 3 key xyz
Device(config-sg-radius)# end
Related Commands Command Description
aaa group server Groups different server hosts into distinct lists and distinct methods.
aaa new-model Enables the AAA access control model.
password encryption aes Enables a type 6 encrypted preshared key.
radius-server host Specifies a RADIUS server host.
radius-server directed-request Allows users to log in to a Cisco NAS and select a RADIUS server for
authentication.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1808
Security
server-private (TACACS+)
server-private (TACACS+)
To configure the IPv4 or IPv6 address of the private TACACS+ server for the group server, use the
server-private command in server-group configuration mode. To remove the associated private server from
the authentication, authorization, and accounting (AAA) group server, use the no form of this command.
server-private { ipv4-address | ipv6-address | fqdn } [ nat ] [ single-connection ] [ port port-number
] [ timeout seconds ] key [{ 0 | 7 }] string
no server-private
Syntax Description ip4-address IPv4 address of the private TACACS+ server host.
ip6-address IPv6 address of the private TACACS+ server host.
fqdn Fully qualified domain name (fqdn) of the private TACACS+ server host for address
resolution from the Domain Name Server (DNS)
nat (Optional) Specifies the port Network Address Translation (NAT) address of the remote
device. This address is sent to the TACACS+ server.
single-connection (Optional) Maintains a single TCP connection between the router and the TACACS+
server.
timeout seconds (Optional) Specifies a timeout value for the server response. This value overrides the
global timeout value set with the tacacs-server timeout command for this server only.
port port-number (Optional) Specifies a server port number. This option overrides the default, which is
port 49.
key [0|7] string (Optional) Specifies an authentication and encryption key. This key must match the key
used by the TACACS+ daemon. Specifying this key overrides the key set by the global
tacacs-server key command for this server only.
If no number or 0 is entered, the string that is entered is considered to be plain text. If
7 is entered, the string that is entered is considered to be encrypted text.
Command Default If server-private parameters are not specified, global configurations will be used; if global configurations are
not specified, default values will be used.
Command Modes
TACACS+ server-group configuration (config-sg-tacacs+)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the server-private command to associate a particular private server with a defined server group. To
prevent possible overlapping of private addresses between virtual route forwardings (VRFs), private servers
(servers with private addresses) can be defined within the server group and remain hidden from other groups,
while the servers in the global pool (default "TACACS+" server group) can still be referred to by IP addresses
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1809
Security
server-private (TACACS+)
and port numbers. Thus, the list of servers in server groups includes references to the hosts in the global
configuration and the definitions of private servers.
The following example shows how to define the tacacs1 TACACS+ group server and associate
private servers with it:
Device> enable
Device# configure terminal
Device(config)# aaa group server tacacs+ tacacs1
Device(config-sg-tacacs+)# server-private 10.1.1.1 port 19 key cisco
Device(config-sg-tacacs+)# exit
Device(config)#ip vrf cisco
Device(config-vrf)# rd 100:1
Device(config-vrf)# exit
Device(config)# interface Loopback0
Device(config-if)#ip address 10.0.0.2 255.0.0.0
Device(config-if)#ip vrf forwarding cisco
Related Commands Command Description
aaa group server Groups different server hosts into distinct lists and distinct methods.
aaa new-model Enables the AAA access control model.
ip tacacs source-interface Uses the IP address of a specified interface for all outgoing TACACS+
packets.
ip vrf forwarding (server-group) Configures the VRF reference of an AAA TACACS+ server group.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1810
Security
show aaa cache group
show aaa cache group
To display all the cache entries stored by the AAA cache, use the show aaa cache group command in privileged
EXEC mode.
show aaa cache group name { all | profile name }
Syntax Description name Text string representing a cache server group.
all Displays all the server group profile details.
profile name Displays the specified individual server group profile details.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The IOSD AAA Auth Cache entries section of the command output displays Cisco IOSd-related AAA
authentication cache entries that get populated when AAA authentication cache is used as the authentication
method for Cisco IOSd use-cases like PPP, login, and so on. The SMD AAA Auth Cache entries section of
the command output displays SMD AAA authentication cache entries that get populated when AAA
authentication cache is being used as the authentication method for session manager daemon (SMD) use cases,
such as 802.1x, MAB, and so on. The show aaa cache group command displays Cisco IOSd use cases-related
AAA authentication cache entries first, followed by SMD use cases-related AAA authentication cache entries.
Examples The following example shows how to display all the cache entries for a group. The fields are
self-explanatory.
Device# show aaa cache group radiusGroup all
IOSD AAA Auth Cache entries:
----------------------------------------------------------
Entries in Profile dB radiusGroup for exact match:
No entries found in Profile dB
SMD AAA Auth Cache entries:
---------------------------------------------------------
***Total number of AAA Auth cache entries is 3
MAC ADDR: 5C85.7E31.756C
Profile Name: CACHE-PROFILE
User Name: test
Timeout: 86400
MAC ADDR: AABB.CCDD.EE00
Profile Name: CACHE-PROFILE
User Name: cache1
Timeout: 86400
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1811
Security
show aaa cache group
MAC ADDR: AABB.CCDD.EE01
Profile Name: CACHE-PROFILE
User Name: cache2
Timeout: 86400
Related Commands Command Description
clear aaa cache group Clears individual entries or all the entries in the cache.
debug aaa cache Debugs the caching mechanism and ensures that entries are cached from AAA
group server responses, and found when queried.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1812
Security
show aaa clients
show aaa clients
To display authentication, authorization, and accounting (AAA) client statistics, use the show aaa clients
command.
show aaa clients [detailed]
Syntax Description detailed (Optional) Shows detailed AAA client statistics.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of output from the show aaa clients command:
Device> enable
Device# show aaa clients
Dropped request packets: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1813
Security
show aaa command handler
show aaa command handler
To display authentication, authorization, and accounting (AAA) command handler statistics, use the show
aaa command handler command.
show aaa command handler
Syntax Description This command has no aruguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of output from the show aaa command handler command:
Device# show aaa command handler
AAA Command Handler Statistics:
account-logon: 0, account-logoff: 0
account-query: 0, pod: 0
service-logon: 0, service-logoff: 0
user-profile-push: 0, session-state-log: 0
reauthenticate: 0, bounce-host-port: 0
disable-host-port: 0, update-rbacl: 0
update-sgt: 0, update-cts-policies: 0
invalid commands: 0
async message not sent: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1814
Security
show aaa dead-criteria
show aaa dead-criteria
To display dead-criteria detection information for an authentication, authorization, and accounting (AAA)
server, use the show aaa dead-criteria command in privileged EXEC mode.
show aaa dead-criteria {security-protocol ip-address} [auth-port port-number] [acct-port
port-number][server-group-name]
Syntax Description security-protocol Security protocol of the specified AAA server. Currently, the only protocol that is
supported is RADIUS.
ip-address IP address of the specified AAA server.
auth-port (Optional) Authentication port for the RADIUS server that was specified.
port-number (Optional) Number of the authentication port. The default is 1645 (for a RADIUS
server).
acct-port (Optional) Accounting port for the RADIUS server that was specified.
port-number (Optional) Number of the accounting port. The default is 1646 (for a RADIUS server).
server-group-name (Optional) Server group with which the specified server is associated. The default is
radius (for a RADIUS server).
Command Default Currently, the port-number argument for the auth-port keyword and the port-number argument for the
acct-port keyword default to 1645 and 1646, respectively. The default for the server-group-name argument
is radius.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines Multiple RADIUS servers having the same IP address can be configured on a device. The auth-port and
acct-port keywords are used to differentiate the servers. The dead-detect interval of a server that is associated
with a specified server group can be obtained by using the server-group-name keyword. (The dead-detect
interval and retransmit values of a RADIUS server are set on the basis of the server group to which the server
belongs. The same server can be part of multiple server groups.)
Examples The following example shows that dead-criteria-detection information has been requested for a
RADIUS server at the IP address 172.19.192.80:
Device# show aaa dead-criteria radius 172.19.192.80 radius
RADIUS Server Dead Critieria:
=============================
Server Details:
Address : 172.19.192.80
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1815
Security
show aaa dead-criteria
Auth Port : 1645
Acct Port : 1646
Server Group : radius
Dead Criteria Details:
Configured Retransmits : 62
Configured Timeout : 27
Estimated Outstanding Transactions: 5
Dead Detect Time : 25s
Computed Retransmit Tries: 22
Statistics Gathered Since Last Successful Transaction
=====================================================
Max Computed Outstanding Transactions: 5
Max Computed Dead Detect Time: 25s
Max Computed Retransmits : 22
The Max Computed Dead Detect Time is displayed in seconds. The other fields shown in the
display are self-explanatory.
Related Commands Command Description
debug aaa dead-criteria transactions Displays AAA dead-criteria transaction values.
radius-server dead-criteria Forces one or both of the criteria, used to mark a RADIUS server
as dead, to be the indicated constant.
show aaa server-private Displays the status of all private RADIUS servers.
show aaa servers Displays information about the number of packets sent to and
received from AAA servers.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1816
Security
show aaa local
show aaa local
To display authentication, authorization, and accounting (AAA) local method options, use the show aaa local
command.
show aaa local {netuser {name | all } | statistics | user lockout}
Syntax Description netuser Specifies the AAA local network or guest user database.
name Network user name.
all Specifies the network and guest user information.
statistics Displays statistics for local authentication.
user Specifies the AAA local locked-out user.
lockout
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
This is an example of output from the show aaa local statistics command:
Device# show aaa local statistics
Local EAP statistics
EAP Method Success Fail
-------------------------------------
Unknown 0 0
EAP-MD5 0 0
EAP-GTC 0 0
LEAP 0 0
PEAP 0 0
EAP-TLS 0 0
EAP-MSCHAPV2 0 0
EAP-FAST 0 0
Requests received from AAA: 0
Responses returned from EAP: 0
Requests dropped (no EAP AVP): 0
Requests dropped (other reasons): 0
Authentication timeouts from EAP: 0
Credential request statistics
Requests sent to backend: 0
Requests failed (unable to send): 0
Authorization results received
Success: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1817
Security
show aaa local
Fail: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1818
Security
show aaa servers
show aaa servers
To display all authentication, authorization, and accounting (AAA) servers as seen by the AAA server MIB,
use the show aaa servers command.
show aaa servers [private|public|[detailed]]
Syntax Description detailed (Optional) Displays private AAA servers as seen by the AAA server
MIB.
public (Optional) Displays public AAA servers as seen by the AAA server
MIB.
detailed (Optional) Displays detailed AAA server statistics.
Command Modes User EXEC (>)
Privileged EXEC (>)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Cisco IOS XE Fuji 16.9.1 The output of the command was
updated.
Examples The following is a sample output from the show aaa servers command:
Device# show aaa servers
Bad authenticators: 0
RADSEC: Packet count since last idletimeout 0,
Send handshake count 0,
Handshake Success 0,
Total Packets Transmitted 0,
Total Packets Received 0,
Total Connection Resets 9,
Connection Reset due to idle timeout 0,
Connection Reset due to No Response 0,
Connection Reset due to Malformed packet 0,
Connection Reset by Peer 0,
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1819
Security
show aaa sessions
show aaa sessions
To display authentication, authorization, and accounting (AAA) sessions as seen by the AAA Session MIB,
use the show aaa sessions command.
show aaa sessions
Syntax Description This command has no arguments or keywords.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is sample output from the show aaa sessions command:
Device# show aaa sessions
Total sessions since last reload: 7
Session Id: 4007
Unique Id: 4025
User Name: *not available*
IP Address: 0.0.0.0
Idle Time: 0
CT Call Handle: 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1820
Security
show access-lists fqdn statistics
show access-lists fqdn statistics
To display the latency statistics of the fully qualified domain name (FQDN) ACLs, use the show access-lists
fqdn statistics command in privileged EXEC mode.
show access-lists fqdn statistics
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.6.1 This command was introduced.
Examples The following is a sample output from the show access-lists fqdn statistics command:
Device# show access-lists fqdn statistics
IPv4 ACL programming requests: 231
IPv4 ACL programming timeout: 24
IPv4 ACL programming latency:
Min 2 ms
Max 134 ms
Avg 56 ms
IPv6 ACL programming requests: 178
IPv6 ACL programming timeout: 6
IPv6 ACL programming latency:
Min 2 ms
Max 253 ms
Avg 24 ms
Related Commands Command Description
show fqdn Displays the resolved IP addresses for the FQDN entries from the local cache database.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1821
Security
show authentication brief
show authentication brief
To display brief information about authentication sessions for a given interface, use the show authentication
brief command in either user EXEC or privileged EXEC mode.
show authentication brief[switch{switch-number|active|standby}{R0}]
Syntax Description switch-number Valid values for the switch-number variable are from
1 to 9.
R0 Displays information about the Route Processor (RP)
slot 0.
active Specifies the active instance.
standby Specifies the standby instance.
Command Modes Privileged EXEC (#)
User EXEC (>)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is a sample output from the show authentication brief command:
Device# show authentication brief
Interface MAC Address AuthC AuthZ Fg Uptime
-----------------------------------------------------------------------------
Gi2/0/14 0002.0002.0001 m:NA d:OK AZ: SA- X 281s
Gi2/0/14 0002.0002.0002 m:NA d:OK AZ: SA- X 280s
Gi2/0/14 0002.0002.0003 m:NA d:OK AZ: SA- X 279s
Gi2/0/14 0002.0002.0004 m:NA d:OK AZ: SA- X 278s
Gi2/0/14 0002.0002.0005 m:NA d:OK AZ: SA- X 278s
Gi2/0/14 0002.0002.0006 m:NA d:OK AZ: SA- X 277s
Gi2/0/14 0002.0002.0007 m:NA d:OK AZ: SA- X 276s
Gi2/0/14 0002.0002.0008 m:NA d:OK AZ: SA- X 276s
Gi2/0/14 0002.0002.0009 m:NA d:OK AZ: SA- X 275s
Gi2/0/14 0002.0002.000a m:NA d:OK AZ: SA- X 275s
Gi2/0/14 0002.0002.000b m:NA d:OK AZ: SA- X 274s
Gi2/0/14 0002.0002.000c m:NA d:OK AZ: SA- X 274s
Gi2/0/14 0002.0002.000d m:NA d:OK AZ: SA- X 273s
Gi2/0/14 0002.0002.000e m:NA d:OK AZ: SA- X 273s
Gi2/0/14 0002.0002.000f m:NA d:OK AZ: SA- X 272s
Gi2/0/14 0002.0002.0010 m:NA d:OK AZ: SA- X 272s
Gi2/0/14 0002.0002.0011 m:NA d:OK AZ: SA- X 271s
Gi2/0/14 0002.0002.0012 m:NA d:OK AZ: SA- X 271s
Gi2/0/14 0002.0002.0013 m:NA d:OK AZ: SA- X 270s
Gi2/0/14 0002.0002.0014 m:NA d:OK AZ: SA- X 270s
Gi2/0/14 0002.0002.0015 m:NA d:OK AZ: SA- X 269s
The following is a sample output from the show authentication brief command for active instances:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1822
Security
show authentication brief
Device# show authentication brief switch active R0
Interface MAC Address AuthC AuthZ Fg Uptime
-----------------------------------------------------------------------------
Gi2/0/14 0002.0002.0001 m:NA d:OK AZ: SA- X 1s
Gi2/0/14 0002.0002.0002 m:NA d:OK AZ: SA- X 0s
Gi2/0/14 0002.0002.0003 m:NA d:OK AZ: SA- X 299s
Gi2/0/14 0002.0002.0004 m:NA d:OK AZ: SA- X 298s
Gi2/0/14 0002.0002.0005 m:NA d:OK AZ: SA- X 298s
Gi2/0/14 0002.0002.0006 m:NA d:OK AZ: SA- X 297s
Gi2/0/14 0002.0002.0007 m:NA d:OK AZ: SA- X 296s
Gi2/0/14 0002.0002.0008 m:NA d:OK AZ: SA- X 296s
Gi2/0/14 0002.0002.0009 m:NA d:OK AZ: SA- X 295s
Gi2/0/14 0002.0002.000a m:NA d:OK AZ: SA- X 295s
Gi2/0/14 0002.0002.000b m:NA d:OK AZ: SA- X 294s
Gi2/0/14 0002.0002.000c m:NA d:OK AZ: SA- X 294s
Gi2/0/14 0002.0002.000d m:NA d:OK AZ: SA- X 293s
Gi2/0/14 0002.0002.000e m:NA d:OK AZ: SA- X 293s
Gi2/0/14 0002.0002.000f m:NA d:OK AZ: SA- X 292s
Gi2/0/14 0002.0002.0010 m:NA d:OK AZ: SA- X 292s
Gi2/0/14 0002.0002.0011 m:NA d:OK AZ: SA- X 291s
Gi2/0/14 0002.0002.0012 m:NA d:OK AZ: SA- X 291s
Gi2/0/14 0002.0002.0013 m:NA d:OK AZ: SA- X 290s
Gi2/0/14 0002.0002.0014 m:NA d:OK AZ: SA- X 290s
Gi2/0/14 0002.0002.0015 m:NA d:OK AZ: SA- X 289s
Gi2/0/14 0002.0002.0016 m:NA d:OK AZ: SA- X 289s
The following is a sample output from the show authentication brief command for standby instances:
Device# show authentication brief switch standby R0
No sessions currently exist
The table below describes the significant fields shown in the displays.
Table 205: show authentication brief Field Descriptions
Field Description
Interface The type and number of the authentication interface.
MAC Address The MAC address of the client.
AuthC Indicates authentication status.
AuthZ Indicates authorization status.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1823
Security
show authentication brief
Field Description
Fg Flag indicates the current status. The valid values are:
• A—Applying policy (multi-line status for details)
• D—Awaiting removal
• F—Final removal in progress
• I—Awaiting IIF ID allocation
• P—Pushed session
• R—Removing user profile (multi-line status for
details)
• U—Applying user profile (multi-line status for
details)
• X—Unknown blocker
Uptime Indicates the duration since which the session came
up
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1824
Security
show authentication history
show authentication history
To display the authenticated sessions alive on a device, use the show authentication history command in
user EXEC or privileged EXEC mode.
show authentication history [min-uptime seconds]
Syntax Description min-uptime seconds (Optional) Displays sessions within the minimum uptime. The range is from 1
through 4294967295 seconds.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show authentication history command to display the authenticated sessions alive on the device.
The following is sample output from the show authentication history command:
Device# show authentication history
Interface MAC Address Method Domain Status Uptime
Gi3/0/2 0021.d864.07c0 dot1x DATA Auth 38s
Session count = 1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1825
Security
show authentication sessions
show authentication sessions
To display information about current Auth Manager sessions, use the show authentication sessions command.
show authentication sessions [database][handle handle-id [details]][interface type number
[details][mac mac-address [interface type number][method method-name [interface type number
[details] [session-id session-id [details]]
Syntax Description database (Optional) Shows only data stored in session database.
handle handle-id (Optional) Specifies the particular handle for which Auth Manager information is to
be displayed.
details (Optional) Shows detailed information.
interface type number (Optional) Specifies a particular interface type and number for which Auth Manager
information is to be displayed.
mac mac-address (Optional) Specifies the particular MAC address for which you want to display
information.
method method-name (Optional) Specifies the particular authentication method for which Auth Manager
information is to be displayed. If you specify a method (dot1x, mab, or webauth),
you may also specify an interface.
session-id session-id (Optional) Specifies the particular session for which Auth Manager information is
to be displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show authentication sessions command to display information about all current Auth Manager
sessions. To display information about specific Auth Manager sessions, use one or more of the keywords.
This table shows the possible operating states for the reported authentication sessions.
Table 206: Authentication Method States
State Description
Not run The method has not run for this session.
Running The method is running for this session.
Failed over The method has failed and the next method is expected
to provide a result.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1826
Security
show authentication sessions
State Description
Success The method has provided a successful authentication
result for the session.
Authc Failed The method has provided a failed authentication result
for the session.
This table shows the possible authentication methods.
Table 207: Authentication Method States
State Description
dot1x 802.1X
mab MAC authentication bypass
webauth web authentication
The following example shows how to display all authentication sessions on the device:
Device# show authentication sessions
Interface MAC Address Method Domain Status Session ID
Gi1/0/48 0015.63b0.f676 dot1x DATA Authz Success 0A3462B1000000102983C05C
Gi1/0/5 000f.23c4.a401 mab DATA Authz Success 0A3462B10000000D24F80B58
Gi1/0/5 0014.bf5d.d26d dot1x DATA Authz Success 0A3462B10000000E29811B94
The following example shows how to display all authentication sessions on an interface:
Device# show authentication sessions interface gigabitethernet2/0/47
Interface: GigabitEthernet2/0/47
MAC Address: Unknown
IP Address: Unknown
Status: Authz Success
Domain: DATA
Oper host mode: multi-host
Oper control dir: both
Authorized By: Guest Vlan
Vlan Policy: 20
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462C8000000000002763C
Acct Session ID: 0x00000002
Handle: 0x25000000
Runnable methods list:
Method State
mab Failed over
dot1x Failed over
----------------------------------------
Interface: GigabitEthernet2/0/47
MAC Address: 0005.5e7c.da05
IP Address: Unknown
User-Name: 00055e7cda05
Status: Authz Success
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1827
Security
show authentication sessions
Domain: VOICE
Oper host mode: multi-domain
Oper control dir: both
Authorized By: Authentication Server
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462C8000000010002A238
Acct Session ID: 0x00000003
Handle: 0x91000001
Runnable methods list:
Method State
mab Authc Success
dot1x Not run
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1828
Security
show device-tracking capture-policy
show device-tracking capture-policy
To display the rules that the system pushes to the hardware (forwarding layer), enter the show device-tracking
capture-policy command in privileged EXEC mode. These rules determine which packets are punted to SISF
for further action. These rules are a translation of the policy that is applied to the interface or VLAN.
show device-tracking capture-policy [ interface inteface_type_no | vlan vlan_id ]
Syntax Description interface inteface_type_no Displays message capture policy information for the interface you specify. Enter
an interface type and number.
Use the question mark (?) online help function to display the types of interfaces
on the device.
vlan vlan_id Displays message capture policy information for the VLAN ID you specify.
The valid value range is from 1 to 4095.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The output of this command is used by the technical support team, for troubleshooting.
Examples
The following is sample output from the show device-tracking capture-policy command:
Device# show device-tracking capture-policy interface tengigabitethernet1/0/1
HW Target Te1/0/1 HW policy signature 0001DF9F policies#:1 rules 14 sig 0001DF9F
SW policy sisf-01 feature Device-tracking - Active
Rule DHCP4 CLIENT Protocol UDP mask 00000400 action PUNT match1 0 match2 67#feat:1
feature Device-tracking
Rule DHCP4 SERVER SOURCE Protocol UDP mask 00001000 action PUNT match1 0 match2
68#feat:1
feature Device-tracking
Rule DHCP4 SERVER Protocol UDP mask 00000800 action PUNT match1 67 match2 0#feat:1
feature Device-tracking
Rule ARP Protocol IPV4 mask 00004000 action PUNT match1 0 match2 0#feat:1
feature Device-tracking
Rule DHCP SERVER SOURCE Protocol UDP mask 00000200 action PUNT match1 0 match2
546#feat:1
feature Device-tracking
Rule DHCP CLIENT Protocol UDP mask 00000080 action PUNT match1 0 match2 547#feat:1
feature Device-tracking
Rule DHCP SERVER Protocol UDP mask 00000100 action PUNT match1 547 match2 0#feat:1
feature Device-tracking
Rule RS Protocol ICMPV6 mask 00000004 action PUNT match1 133 match2 0#feat:1
feature Device-tracking
Rule RA Protocol ICMPV6 mask 00000008 action PUNT match1 134 match2 0#feat:1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1829
Security
show device-tracking capture-policy
feature Device-tracking
Rule NS Protocol ICMPV6 mask 00000001 action PUNT match1 135 match2 0#feat:1
feature Device-tracking
Rule NA Protocol ICMPV6 mask 00000002 action PUNT match1 136 match2 0#feat:1
feature Device-tracking
Rule REDIR Protocol ICMPV6 mask 00000010 action PUNT match1 137 match2 0#feat:1
feature Device-tracking
Rule DAR Protocol ICMPV6 mask 00008000 action PUNT match1 157 match2 0#feat:1
feature Device-tracking
Rule DAC Protocol ICMPV6 mask 00010000 action PUNT match1 158 match2 0#feat:1
feature Device-tracking
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1830
Security
show device-tracking counters
show device-tracking counters
To display information about the number of broadcast, multicast, bridged, unicast, probe, dropped
device-tracking messages and faults received on an interface or VLAN or both, enter the show device-tracking
counters command in privileged EXEC mode. Where applicable, the messages are categorized by protocol.
The list of protocols include Address Resolution Protocol (ARP), Neighbor Discovery Protocol (NDP),
DHCPv6, DHCPv4, Address Collision Detection (ACD), and Duplicate Address Detection (DAD).
show device-tracking counters [ all | interface inteface_type_no | vlan vlan_id ]
Syntax Description all Displays information for all interfaces and VLANs on the device where a policy
is attached.
interface inteface_type_no Displays information for the specified interface. Enter an interface type and
number.
Use the question mark (?) online help function to display the types of interfaces
on the device.
vlan vlan_id Displays information for the VLAN ID you specify. The range is from 1 to
4095.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines When you enter the show device-tracking counterscommand, you must enter one of the keywords that
follow, that is, all, or interface inteface_type_no , or vlan vlan_id .
If you specify an interface or VLAN where a policy is not attached, the following message is displayed: % no
ipv6 snooping policy attached on <interface number or VLAN ID>
Examples
The following is sample output from theshow device-tracking counters command. Information
relating to a particular VLAN (VLAN 10) is displayed here:
Device# show device-tracking counters vlan 10
Received messages on vlan 10 :
Protocol Protocol message
NDP RA[2479] NS[1757] NA[2794]
DHCPv6
ARP REP[878]
DHCPv4
ACD&DAD --[3]
Received Broadcast/Multicast messages on vlan 10 :
Protocol Protocol message
NDP RA[2479] NS[3] NA[5]
DHCPv6
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1831
Security
show device-tracking counters
ARP REP[1]
DHCPv4
Bridged messages from vlan 10 :
Protocol Protocol message
NDP RA[1238] NS[1915] NA[878]
DHCPv6
ARP REQ[877]
DHCPv4
ACD&DAD --[1]
Broadcast/Multicast converted to unicast messages from vlan 10 :
Protocol Protocol message
NDP
DHCPv6
ARP
DHCPv4
ACD&DAD
Probe message on vlan 10 :
Type Protocol message
PROBE_SEND NS[1037] REQ[877]
PROBE_REPLY NA[1037] REP[877]
Limited Broadcast to Local message on vlan 10 :
Type Protocol message
NDP
DHCPv6
ARP
DHCPv4
Dropped messages on vlan 10 :
Feature Protocol Msg [Total dropped]
Device-tracking: NDP RA [1241]
reason: Packet not authorized on port [1241]
NS [2]
reason: Silent drop [2]
NA [1039]
reason: Silent drop [1037]
reason: Packet accepted but not forwarded [2]
ARP REP [878]
reason: Silent drop [877]
reason: Packet accepted but not forwarded [1]
ACD&DAD: -- -- [2]
Faults on vlan 10 :
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1832
Security
show device-tracking database
show device-tracking database
To display details of the binding table database, enter the show device-tracking database command in
privileged EXEC mode.
show device-tracking database [ address { hostname_address | all } [ interface inteface_type_no ] [
vlanid vlan ] [ details ] | details | interface inteface_type_no [ details ] [ vlanid vlan ] | mac [
48_bit_hw_add ] [ details ] [ interface inteface_type_no ] [ vlanid vlan ] | prefix [ prefix_address |
all ] [ details ] [ interface inteface_type_no ] | vlanid vlanid [ details ] ]
Syntax Description address {hostname_address | Displays binding table information for a particular IP address or for all
all} addresses
interface inteface_type_no Displays binding table information for the specified interface. Enter an
interface type and number.
Use the question mark (?) online help function to display the types of
interfaces on the device.
vlanid vlan Displays binding table information for the VLAN ID you specify. The
valid value range is from 1 to 4095.
details Displays detailed information.
mac Displays binding table information for the MAC address you specify.
48_bit_hw_add Enter a 48-bit hardware address.
prefix Displays binding table information for the IPv6 prefix you specify.
prefix_address Enter an IPv6 prefix.
all Displays binding table information for all the available IPv6 prefixes.
Command Modes Privileged EXEC (# )
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples
The following is sample output for the show device-tracking database detailscommand. The
accompanying table describes the significant fields shown in the display.
Device# show device-tracking database details
Binding table configuration:
----------------------------
max/box : no limit
max/vlan : no limit
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1833
Security
show device-tracking database
max/port : no limit
max/mac : no limit
Binding table current counters:
------------------------------
dynamic : 5
local : 1
total : 5
Binding table counters by state:
----------------------------------
REACHABLE : 5
DOWN : 1
total : 6
Codes: L - Local, S - Static, ND - Neighbor Discovery, ARP - Address Resolution Protocol,
DH4 - IPv4 DHCP, DH6 - IPv6 DHCP, PKT - Other Packet, API - API created
Preflevel flags (prlvl):
0001:MAC and LLA match 0002:Orig trunk 0004:Orig access
0008:Orig trusted trunk 0010:Orig trusted access 0020:DHCP assigned
0040:Cga authenticated 0080:Cert authenticated 0100:Statically assigned
Network Layer Address Link Layer Address Interface mode vlan(prim) prlvl
age state Time left Filter In Crimson Client ID Session ID
Policy (feature)
ARP 192.0.9.29 001b.4411.3ab7(S) Te1/0/4 trunk 200 ( 200) 0003
6mn REACHABLE 331 s no yes 0000.0000.0000 (unspecified)
sisf-01 (Device-tracking)
ARP 192.0.9.28 001b.4411.3ab7(S) Te1/0/4 trunk 200 ( 200) 0003
6mn REACHABLE 313 s no yes 0000.0000.0000 (unspecified)
sisf-01 (Device-tracking)
ARP 192.0.9.27 001b.4411.3ab7(S) Te1/0/4 trunk 200 ( 200) 0003
6mn REACHABLE 323 s no yes 0000.0000.0000 (unspecified)
sisf-01 (Device-tracking)
ARP 192.0.9.26 001b.4411.3ab7(S) Te1/0/4 trunk 200 ( 200) 0003
6mn REACHABLE 311 s no yes 0000.0000.0000 (unspecified)
sisf-01 (Device-tracking)
ARP 192.0.9.25 001b.4411.3ab7(S) Te1/0/4 trunk 200 ( 200) 0003
6mn REACHABLE 313 s no yes 0000.0000.0000 (unspecified)
sisf-01 (Device-tracking)
L 192.168.0.1 00a5.bf9d.0462(D) Vl200 svi 200 ( 200) 0100
6mn DOWN no yes 0000.0000.0000 (unspecified)
sisf-01 (sisf_local)
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1834
Security
show device-tracking database
Table 208: show device-tracking database details Field Descriptions
Field Description
Binding table configuration: Displays binding table settings. The values correspond
with what is configured using the device-tracking
• max/box
binding command in global configuration mode.
• max/vlan • max/box: The value displayed here corresponds
• max/port with the configured value for the max-entries
no_of_entries keyword.
• max/mac
• max/vlan: The value displayed here corresponds
with the configured value for the vlan-limit
no_of_entries keyword.
• max/port: The value displayed here corresponds
with the configured value for the port-limit
no_of_entries keyword.
• max/mac: The value displayed here corresponds
with the configured value for the mac-limit
no_of_entries keyword.
Binding table current counters: Displays the number of entries in the table.
• dynamic • dynamic: Dynamic entries are created by learning
events that dynamically populate the binding
• local table.
• total • local: Local entries are automatically created
when you configure an SVI on the device.
One of ways in which SISF uses a local entry, is
in the context of polling. If polling is enabled,
the SVI address is used as the source address of
an ARP probe.
• total: The total is a sum of the dynamic, local,
and static binding entries.
Binding table counters by state: Displays the number of entries in each state. The state
can be REACHABLE, STALE, DOWN.
Codes Clarifies abbreviations that are used to signify learning
events.
The first column of a binding entry uses an
abbreviated code, which tells you about the learning
event that resulted in creation of that binding entry.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1835
Security
show device-tracking database
Field Description
Preflevel flags (prlvl) A list of preference level number codes and
clarification for what the number codes in the prlvl
column of the binding table mean.
The codes signify a broad classification and multiple
codes can apply to an entry. What is displayed in the
prlvl column is a sum of these number codes and
signifies a corresponding preference level.
For example if an ARP entry (preference code: 0001)
is learned from an access interface (preference code:
0004), the value displayed in the prlvl column is
"0005".
1 is the lowest preference level, and 100 is the highest.
A binding entry with a higher preference is given
preference in case of a collision. For example, if the
same entry is seen on two different interfaces, the
value in the prlvl column, determines which entry
is retained.
Network Layer Address The IP address of the host from which a packet is
received.
Link Layer Address The MAC address of the host.
Mode Displays one of the following values: "invalid",
"unsupp", "access", "trunk", "vpc", "svi", "virtual",
"pseudowire", "unkn", "bdi", "pseudoport".
vlan(prim) The host's VLAN ID
prlvl A value between 1 and 100 is displayed, with 1 having
the lowest preference level, and 100 having the highest
preference level.
See Preflevel flags above to know what the value
displayed here means.
age The total age of the entry in seconds (s) or minutes
(mn) since the the last time the entry was refreshed.
When it is refreshed (sign-of-life from the host), this
value is reset.
state The current state of an entry, which can be one of the
stable or transitional states.
Stable state values are: REACHABLE, DOWN, and
STALE,
Transitional states values are: VERIFY,
INCOMPLETE, and TENTATIVE.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1836
Security
show device-tracking database
Field Description
Time left Displays the amount of time left until the next action
in the current state.
In Crimson A yes or no value which indicates if the entry has been
added to another database. The information is then
used by other applications, like Cisco DNA Center.
Typically, all the entries that are in a binding table are
also added to this database.
This is used by the technical support team, for
troubleshooting and to diagnose a problem.
Client ID This field is applicable only to virtual machines (VMs)
in Cisco Software-Defined Access (SDA)
deployments.
It refers to the actual MAC address of a VM in a
bridged networking mode, where the hosting device
is a wireless client with a non-promiscuous network
interface (NIC).
Session ID This field is applicable only to VMs in SDA
deployments.
It refers to an access session ID for a VM in a bridged
networking mode. Each Session ID is associated with
a Client ID. SISF maintains this association and
transfers it along as the VM roams or moves across
fabric edges in an SDA setup.
Policy (feature) Displays the name of the policy applied to the
interface or VLAN.
The "(feature)" displayed is always "Device-tracking",
because only SISF-based device-tracking supports
the creation of binding entries.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1837
Security
show device-tracking events
show device-tracking events
To display SISF binding table-related events, enter the show device-tracking events command in privileged
EXEC mode. The types of events that are displayed includes the creation of binding table entries and all
updates to an entry. Updates may be state changes, or, changes in the MAC, VLAN, or interface information
for an entry.
show device-tracking events
Syntax Description This command has no arguments or keywords.
Command Default SISF binding table events are displayed.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Usage Guidelines The output of this command is used by the technical support team, for troubleshooting.
Examples
The following is sample output for the show device-tracking events command. It shows you the
kind of binding table events that the system logs:
Device# show device-tracking events
[Wed Mar 23 19:08:33.000] SSID 0 FSM Feature Table running for event ACTIVE_REGISTER in
state CREATING
[Wed Mar 23 19:08:33.000] SSID 0 Transition from CREATING to READY upon event ACTIVE_REGISTER
[Wed Mar 23 19:08:33.000] SSID 1 FSM Feature Table running for event ACTIVE_REGISTER in
state CREATING
[Wed Mar 23 19:08:33.000] SSID 1 Transition from CREATING to READY upon event ACTIVE_REGISTER
[Wed Mar 23 19:09:25.000] SSID 0 FSM sisf_mac_fsm running for event MAC_TENTV in state
MAC-CREATING
[Wed Mar 23 19:09:25.000] SSID 0 Transition from MAC-CREATING to MAC-TENTATIVE upon event
MAC_TENTV
[Wed Mar 23 19:09:25.000] SSID 1 Created Entry origin IPv4 ARP MAC 00a5.bf9c.e051 IPV4
10.0.0.1
[Wed Mar 23 19:09:25.000] SSID 0 FSM sisf_mac_fsm running for event MAC_VERIFIED in state
MAC-TENTATIVE
[Wed Mar 23 19:09:25.000] SSID 0 Transition from MAC-TENTATIVE to MAC-REACHABLE upon event
MAC_VERIFIED
[Wed Mar 23 19:09:25.000] SSID 1 FSM Binding table running for event VALIDATE_LLA in state
CREATING
[Wed Mar 23 19:09:25.000] SSID 1 FSM Binding table running for event SET_TENTATIVE in state
CREATING
[Wed Mar 23 19:09:25.000] SSID 1 Transition from CREATING to TENTATIVE upon event
SET_TENTATIVE
[Wed Mar 23 19:09:25.000] SSID 1 Entry State changed origin IPv4 ARP MAC 00a5.bf9c.e051
IPV4 10.0.0.1
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1838
Security
show device-tracking events
[Wed Mar 23 20:07:27.000] SSID 0 FSM sisf_mac_fsm running for event MAC_DELETE_NOS in state
MAC-REACHABLE
[Wed Mar 23 20:07:27.000] SSID 0 Transition from MAC-REACHABLE to MAC-NONE upon event
MAC_DELETE_NOS
[Wed Mar 23 20:07:27.000] SSID 1 Transition from REACHABLE to NONE upon event DELETE
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1839
Security
show device-tracking features
show device-tracking features
To display the device-tracking features that are enabled, enter the show device-tracking features command
in privileged EXEC mode. The "features" include SISF-based device-tracking, and security features like IPv6
RA Guard, IPv6 DHCP Guard, Layer 2 DHCP Relay, and so on, that use SISF.
show device-tracking features
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples
The following is sample output for the show device-tracking features command.
Device# show device-tracking features
Feature name priority state
Device-tracking 128 READY
Source guard 32 READY
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1840
Security
show device-tracking messages
show device-tracking messages
To display a list of device-tracking related activities, enter the show device-tracking messages command in
privileged EXEC mode.
show device-tracking messages [ detailed no_of_messages ]
Syntax Description detailed no_of_messages Displays a more detailed format of the list of device-tracking messages. Enter
a value between 1 and 255, to specify the number of messages that must be
displayed in a detailed format.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
The following is sample output for the show device-tracking messages command. The summarized
and detailed versions of the output are displayed:
Device# show device-tracking messages
[Wed Mar 23 19:09:25.000] VLAN 1, From Te1/0/2 MAC 00a5.bf9c.e051: ARP::REP, 10.0.0.1,
[Wed Mar 23 20:03:22.000] VLAN 1, From Te1/0/2 MAC 00a5.bf9c.e051: ARP::REP, 10.0.0.1,
Device# show device-tracking messages detailed 255
[Wed Mar 23 19:09:25.000] VLAN 1, From Te1/0/2 seclvl [guard], MAC 00a5.bf9c.e051: ARP::REP,
1 addresses advertised:
IPv6 addr: 10.0.0.1,
[Wed Mar 23 20:03:22.000] VLAN 1, From Te1/0/2 seclvl [guard], MAC 00a5.bf9c.e051: ARP::REP,
1 addresses advertised:
IPv6 addr: 10.0.0.1,
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1841
Security
show device-tracking policies
show device-tracking policies
To display all the device-tracking policies on the device, enter the show device-tracking policies command
in privileged EXEC mode.
show device-tracking policies [ details | interface interface_type_no [ details ] | vlan vlanid ]
Syntax Description details Displays information about the policy targets and policy parameters of all
device-tracking policies on the device
interface interface_type_no Displays all policies applied to the the specified interface. Enter an interface
type and number.
Use the question mark (?) online help function to display the types of interfaces
on the device.
vlan vlanid Displays all policies applied to the the specified VLAN. The valid value range
is from 1 to 4095.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples
The following is sample output for the show device-tracking policies command with the details
keyword. It shows that there is only one policy on the device. It shows the target to which the policy
is applied and the policy parameters.
Device# show device-tracking policies details
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-01 Device-tracking vlan all
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
tracking enable
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-01 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1842
Security
show device-tracking policy
show device-tracking policy
To display information about a particular policy, enter the show device-tracking policy command in privileged
EXEC mode. Displayed information includes the list of targets to which the policy is applied, and policy
parameters.
show device-tracking policy policy_name
Syntax Description policy_name Enter the name of the
policy.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was
introduced.
Examples
The following is sample output for the show device-tracking policy command. Details of policy
sisf-01 are displayed.
Device# show device-tracking policy sisf-01
Device-tracking policy sisf-01 configuration:
security-level guard
device-role node
gleaning from Neighbor Discovery
gleaning from DHCP6
gleaning from ARP
gleaning from DHCP4
NOT gleaning from protocol unkn
tracking enable
Policy sisf-01 is applied on the following targets:
Target Type Policy Feature Target range
Te1/0/1 PORT sisf-01 Device-tracking vlan all
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1843
Security
show dot1x
show dot1x
To display IEEE 802.1x statistics, administrative status, and operational status for a device or for the specified
port, use the show dot1x command in user EXEC or privileged EXEC mode.
show dot1x [all [count | details | statistics | summary]] [interface type number [details |
statistics]] [statistics]
Syntax Description all (Optional) Displays the IEEE 802.1x information for all
interfaces.
count (Optional) Displays total number of authorized and unauthorized
clients.
details (Optional) Displays the IEEE 802.1x interface details.
statistics (Optional) Displays the IEEE 802.1x statistics for all interfaces.
summary (Optional) Displays the IEEE 802.1x summary for all interfaces.
interface type number (Optional) Displays the IEEE 802.1x status for the specified port.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is sample output from the show dot1x all command:
Device# show dot1x all
Sysauthcontrol Enabled
Dot1x Protocol Version 3
The following is sample output from the show dot1x all count command:
Device# show dot1x all count
Number of Dot1x sessions
-------------------------------
Authorized Clients = 0
UnAuthorized Clients = 0
Total No of Client = 0
The following is sample output from the show dot1x all statistics command:
Device# show dot1x statistics
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1844
Security
show dot1x
Dot1x Global Statistics for
--------------------------------------------
RxStart = 0 RxLogoff = 0 RxResp = 0 RxRespID = 0
RxReq = 0 RxInvalid = 0 RxLenErr = 0
RxTotal = 0
TxStart = 0 TxLogoff = 0 TxResp = 0
TxReq = 0 ReTxReq = 0 ReTxReqFail = 0
TxReqID = 0 ReTxReqID = 0 ReTxReqIDFail = 0
TxTotal = 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1845
Security
show cisp
show cisp
To display Client Information Signaling Protocol (CISP) information for a specified interface, use the show
cisp command in privileged EXEC mode.
show cisp {[clients | interface interface-id] | registrations | summary}
Syntax Description clients (Optional) Display CISP client details.
interface interface-id (Optional) Display CISP information about the specified interfac
channels.
registrations Displays CISP registrations.
summary (Optional) Displays CISP summary.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is sample output from the show cisp interface command:
Device# show cisp interface fastethernet 0/1/1
CISP not enabled on specified interface
The following is sample output from the show cisp registration command:
Device# show cisp registrations
Interface(s) with CISP registered user(s):
------------------------------------------
Fa1/0/13
Auth Mgr (Authenticator)
Gi2/0/1
Auth Mgr (Authenticator)
Gi2/0/2
Auth Mgr (Authenticator)
Gi2/0/3
Auth Mgr (Authenticator)
Gi2/0/5
Auth Mgr (Authenticator)
Gi2/0/9
Auth Mgr (Authenticator)
Gi2/0/11
Auth Mgr (Authenticator)
Gi2/0/13
Auth Mgr (Authenticator)
Gi3/0/3
Gi3/0/5
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1846
Security
show cisp
Gi3/0/23
Related Commands Command Description
cisp enable Enables CISP.
dot1x credentials profile Configures a profile on a supplicant device.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1847
Security
show eap pac peer
show eap pac peer
To display stored Protected Access Credentials (PAC) for Extensible Authentication Protocol (EAP) Flexible
Authentication via Secure Tunneling (FAST) peers, use the show eap pac peer command in privileged EXEC
mode.
show eap pac peer
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
The following is sample output from the show eap pac peers command:
Device# show eap pac peers
No PACs stored
Related Commands Command Description
clear eap sessions Clears EAP session information for the device or for the spec
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1848
Security
show fqdn
show fqdn
To display the resolved IP addresses for the fully qualified domain name (FQDN) entries in the local cache
database, use the show fqdn command in either user EXEC mode or privileged EXEC mode.
show fqdn { database [{ dump | fqdn name [ ipv4 address | ipv6 address ] | statistics }] |
packet statistics | summary }
Syntax Description database Displays the FQDN-to-IP address bindings, along with the time-to-live (TTL) for those
bindings, and the status of the bindings.
dump (Optional) Displays all the cached and transient FQDN entries from the database.
fqdn name (Optional) Displays cached entries from the database for the specified FQDN.
ipv4 address (Optional) Displays cached entries from the database for the specified IP address.
ipv6 address (Optional) Displays cached entries from the database for the specified IPv6 address.
statistics (Optional) Displays FQDN database statistics.
packet statistics Displays FQDN packet statistics.
summary Displays FQDN TTL timeout factor and a summary of the registered FQDNs.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Bengaluru 17.5.1 This command was introduced.
Cisco IOS XE Bengaluru 17.6.1 This command was modified. The ipv6 keyword was introduced.
Examples The following is a sample output from the show fqdn summary command:
Device# show fqdn summary
Registered FQDNs:
FQDN: host1.9k.com
Registered Module IDs: FQDN ACL Mgr,
FQDN: host2.9k.com
Registered Module IDs: FQDN ACL Mgr,
FQDN: host3.9k.com
Registered Module IDs: FQDN ACL Mgr,
FQDN: host4.9k.com
Registered Module IDs: FQDN ACL Mgr,
The following is a sample output from the show fqdn database command:
Device# show fqdn database
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1849
Security
show fqdn
====================== MAIN DB =======================
FQDN Name: example.cisco.com
IP Address Type TTL
10.11.224.132 IPv4 313/370
10.11.112.150 IPv4 313/370
The following is a sample output from the show fqdn packet statistics command:
Device# show fqdn packet statistics
Total DNS Pkts Rcvd : 676
IPv4 DNS Pkts Rcvd : 676
IPv6 DNS Pkts Rcvd : 0
Total DNS Pkts for registered FQDNs : 2
Total DNS Pkts with induced latency : 2
DNS Packet Latency:
Min : 34 ms
Max : 3002 ms
Avg : 1518 ms
Total DNS Pkts Injected : 676
DNS Pkts Injected by Ack : 2
DNS Pkts with parse error : 0
DNS Pkts with no answer : 674
DNS Pkts with no A/AAAA Record : 0
DNS Pkts with FQDN not registered : 0
DNS Pkts with FQDN already cached : 0
Total DNS Pkts Dropped by Nack : 0
Average Input rate - 1 min : 11 pps
Average Input rate - 5 min : 11 pps
Average Input rate - 1 hr : 11 pps
Related Commands Command Description
show ip access-lists Displays the contents of all the current IP access lists.
show ipv6 access-lists Displays the contents of all the current IPv6 access lists.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1850
Security
show ip access-lists
show ip access-lists
To display the contents of all current IP access lists, use the show ip access-lists command in user EXEC or
privileged EXEC modes.
show ip access-lists [{ access-list-number access-list-number-expanded-range access-list-name | dynamic
[dynamic-access-list-name] | interface name number [{ in | out }] }]
Syntax Description access-list-number (Optional) Number of the IP access list to display.
access-list-number-expanded-range (Optional) Expanded range of the IP access list to display.
access-list-name (Optional) Name of the IP access list to display.
dynamic dynamic-access-list-name (Optional) Displays the specified dynamic IP access lists.
interface name number (Optional) Displays the access list for the specified interface.
in (Optional) Displays input interface statistics.
out (Optional) Displays output interface statistics.
Note Statistics for OGACL is not supported
Command Default All standard and expanded IP access lists are displayed.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest This command was introduced.
16.5.1a
Usage Guidelines The show ip access-lists command provides output identical to the show access-lists command, except that
it is IP-specific and allows you to specify a particular access list.
The output of the show ip access-lists interface command does not display dACL or ACL filter IDs. This is
because the ACLs are attached to the virtual ports created by multidomain authentication for each authentication
session; instead of the physical interface. To display dACL or ACL filter IDs, use the show ip access-lists
access-list-name command. The access-list-name should be taken from the show access-session interface
interface-name detail command output. The access-list-name is case sensitive.
Examples The following is a sample output from the show ip access-lists command when all access lists are
requested:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1851
Security
show ip access-lists
Device# show ip access-lists
Extended IP access list 101
deny udp any any eq nntp
permit tcp any any
permit udp any any eq tftp
permit icmp any any
permit udp any any eq domain
Role-based IP access list r1
10 permit tcp dst eq telnet
20 permit udp
FQDN IP access list facl
10 permit ip host 10.1.1.1 host dynamic www.google.com
20 permit tcp 10.10.0.0 0.255.255.255 eq ftp host dynamic www.cisco.com log
30 permit udp host dynamic www.youtube.com any
40 permit ip 10.3.4.0 0.0.0.255 any
Extended Resolved IP access list facl
200000 permit tcp 10.0.0.0 0.255.255.255 eq ftp host 10.10.10.1 log
200001 permit tcp 10.0.0.0 0.255.255.255 eq ftp host 10.10.10.2 log
300000 permit udp host dynamic 10.11.11.11 any
300001 permit udp host dynamic 10.11.11.12 any
400000 permit ip 10.3.4.0 0.0.0.255 any
The table below describes the significant fields shown in the display.
Table 209: show ip access-lists Field Descriptions
Field Description
Extended IP access list Extended IP access-list name/number.
Role-based IP access list Role-based IP access-list name.
FQDN IP access list FQDN IP access-list name.
Extended Resolved IP access list Extended resolved IP access-list name.
deny Packets to reject.
udp User Datagram Protocol.
any Source host or destination host.
eq Packets on a given port number.
nntp Network News Transport Protocol.
permit Packets to forward.
dynamic Dynamically resolves domain name.
tcp Transmission Control Protocol.
tftp Trivial File Transfer Protocol.
icmp Internet Control Message Protocol.
domain Domain name service.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1852
Security
show ip access-lists
The following is a sample output from the show ip access-lists command when the name of a specific
access list is requested:
Device# show ip access-lists Internetfilter
Extended IP access list Internetfilter
permit tcp any 192.0.2.0 255.255.255.255 eq telnet
deny tcp any any
deny udp any 192.0.2.0 255.255.255.255 lt 1024
deny ip any any log
The following is a sample output from the show ip access-lists command using the dynamic keyword:
Device# show ip access-lists dynamic CM_SF#1
Extended IP access list CM_SF#1
10 permit udp any any eq 5060 (650 matches)
20 permit tcp any any eq 5060
30 permit udp any any dscp ef (806184 matches)
Related Commands Command Description
deny Sets conditions in a named IP access list or OGACL that will deny packets.
ip access-group Applies an ACL or OGACL to an interface or a service policy map.
ip access-list Defines an IP access list or OGACL by name or number.
object-group network Defines network object groups for use in OGACLs.
object-group service Defines service object groups for use in OGACLs.
permit Sets conditions in a named IP access list or OGACL that will permit packets.
show object-group Displays information about object groups that are configured.
show run interfaces cable Displays statistics on the cable modem.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1853
Security
show ip dhcp snooping statistics
show ip dhcp snooping statistics
To display DHCP snooping statistics in summary or detail form, use the show ip dhcp snooping statistics
command in user EXEC or privileged EXEC mode.
show ip dhcp snooping statistics [detail ]
Syntax Description detail (Optional) Displays detailed statistics information.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines In a device stack, all statistics are generated on the stack's active switch. If a new active device is elected, the
statistics counters reset.
The following is sample output from the show ip dhcp snooping statistics command:
Device> show ip dhcp snooping statistics
Packets Forwarded = 0
Packets Dropped = 0
Packets Dropped From untrusted ports = 0
The following is sample output from the show ip dhcp snooping statistics detail command:
Device> show ip dhcp snooping statistics detail
Packets Processed by DHCP Snooping = 0
Packets Dropped Because
IDB not known = 0
Queue full = 0
Interface is in errdisabled = 0
Rate limit exceeded = 0
Received on untrusted ports = 0
Nonzero giaddr = 0
Source mac not equal to chaddr = 0
Binding mismatch = 0
Insertion of opt82 fail = 0
Interface Down = 0
Unknown output interface = 0
Reply output port equal to input port = 0
Packet denied by platform = 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1854
Security
show ip dhcp snooping statistics
This table shows the DHCP snooping statistics and their descriptions:
Table 210: DHCP Snooping Statistics
DHCP Snooping Statistic Description
Packets Processed by DHCP Snooping Total number of packets handled by DHCP snooping, including
forwarded and dropped packets.
Packets Dropped Because IDB not Number of errors when the input interface of the packet cannot be
known determined.
Queue full Number of errors when an internal queue used to process the
packets is full. This might happen if DHCP packets are received
at an excessively high rate and rate limiting is not enabled on the
ingress ports.
Interface is in errdisabled Number of times a packet was received on a port that has been
marked as error disabled. This might happen if packets are in the
processing queue when a port is put into the error-disabled state
and those packets are subsequently processed.
Rate limit exceeded Number of times the rate limit configured on the port was exceeded
and the interface was put into the error-disabled state.
Received on untrusted ports Number of times a DHCP server packet (OFFER, ACK, NAK, or
LEASEQUERY) was received on an untrusted port and was
dropped.
Nonzero giaddr Number of times the relay agent address field (giaddr) in the DHCP
packet received on an untrusted port was not zero, or the no ip
dhcp snooping information option allow-untrusted global
configuration command is not configured and a packet received on
an untrusted port contained option-82 data.
Source mac not equal to chaddr Number of times the client MAC address field of the DHCP packet
(chaddr) does not match the packet source MAC address and the
ip dhcp snooping verify mac-address global configuration
command is configured.
Binding mismatch Number of times a RELEASE or DECLINE packet was received
on a port that is different than the port in the binding for that MAC
address-VLAN pair. This indicates someone might be trying to
spoof the real client, or it could mean that the client has moved to
another port on the device and issued a RELEASE or DECLINE.
The MAC address is taken from the chaddr field of the DHCP
packet, not the source MAC address in the Ethernet header.
Insertion of opt82 fail Number of times the option-82 insertion into a packet failed. The
insertion might fail if the packet with the option-82 data exceeds
the size of a single physical packet on the internet.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1855
Security
show ip dhcp snooping statistics
DHCP Snooping Statistic Description
Interface Down Number of times the packet is a reply to the DHCP relay agent, but
the SVI interface for the relay agent is down. This is an unlikely
error that occurs if the SVI goes down between sending the client
request to the DHCP server and receiving the response.
Unknown output interface Number of times the output interface for a DHCP reply packet
cannot be determined by either option-82 data or a lookup in the
MAC address table. The packet is dropped. This can happen if
option 82 is not used and the client MAC address has aged out. If
IPSG is enabled with the port-security option and option 82 is not
enabled, the MAC address of the client is not learned, and the reply
packets will be dropped.
Reply output port equal to input port Number of times the output port for a DHCP reply packet is the
same as the input port, causing a possible loop. Indicates a possible
network misconfiguration or misuse of trust settings on ports.
Packet denied by platform Number of times the packet has been denied by a platform-specific
registry.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1856
Security
show platform software dns-umbrella statistics
show platform software dns-umbrella statistics
To display the Domain Name Syatem (DNS) umbrella statistics of a device, use the show platform software
dns-umbrella statistics command in privileged EXEC mode.
show platform software dns-umbrella statistics
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (>)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following is a sample output of the show platform software dns-umbrella statistics command:
Device> enable
Device# show platform software dns-umbrella statistics
========================================
Umbrella Statistics
========================================
Total Packets : 7848
DNSCrypt queries : 3940
DNSCrypt responses : 0
DNS queries : 0
DNS bypassed queries(Regex) : 0
DNS responses(Umbrella) : 0
DNS responses(Other) : 3906
Aged queries : 34
Dropped pkts : 0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1857
Security
show platform software umbrella switch F0
show platform software umbrella switch F0
To display umbrella configuration of Embedded Service Processor (ESP) slot 0, use the show platform
software umbrella switch {switch_number | active | standby} F0 command in privileged EXEC mode.
show platform software umbrella switch {switch_number | active | standby} F0 {config | interface-info
| local-domain}
Syntax Description switch {switch_number | active | standby} Specifies the switch.
• switch_number: ID of the switch. The range is from
1 to 8.
• active: Specifies the active switch.
• standby: Specifies the standby switch.
config Displays global configurations of ESP slot 0.
interface-info Displays interface-related configuration of ESP slot 0.
local-domain Displays local domain-related configuration of ESP slot 0.
Command Modes Privileged EXEC (>)
Command History Release Modification
Cisco IOS XE Amsterdam 17.1.1 This command was introduced.
Examples The following is a sample output of the show platform software umbrella switch active F0 config
command:
Device> show platform software umbrella switch active F0 config
+++ Umbrella Config +++
Umbrella feature:
------------------
Init: Enabled
Dnscrypt: disabled
Timeout:
------------------
udp timeout: 5
OrgId :
------------------
orgid : 2427270
Resolver config:
RESOLVER IP's
---------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1858
Security
show platform software umbrella switch F0
208.67.220.220
208.67.222.222
2620:119:35::35
2620:119:53::53
Dnscrypt Info:
public_key:
magic_key:
serial number:
ProfileID DeviceID Mode Resolver Local-Domain Tag
------------------------------------------------------------------------------
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1859
Security
show radius server-group
show radius server-group
To display properties for the RADIUS server group, use the show radius server-group command in user
EXEC or privileged EXEC mode.
show radius server-group {name | all}
Syntax Description name Name of the server group. The character string used to name the group of servers must be defined
using the aaa group server radius command.
all Displays properties for all of the server groups.
Command Modes User EXEC (>)
Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines Use the show radius server-group command to display the server groups that you defined by using the aaa
group server radius command.
The following is sample output from the show radius server-group all command:
Device# show radius server-group all
Server group radius
Sharecount = 1 sg_unconfigured = FALSE
Type = standard Memlocks = 1
This table describes the significant fields shown in the display.
Table 211: show radius server-group command Field Descriptions
Field Description
Server group Name of the server group.
Sharecount Number of method lists that are sharing this server
group. For example, if one method list uses a
particular server group, the sharecount would be 1. If
two method lists use the same server group, the
sharecount would be 2.
sg_unconfigured Server group has been unconfigured.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1860
Security
show radius server-group
Field Description
Type The type can be either standard or nonstandard. The
type indicates whether the servers in the group accept
nonstandard attributes. If all servers within the group
are configured with the nonstandard option, the type
will be shown as "nonstandard".
Memlocks An internal reference count for the server-group
structure that is in memory. The number represents
how many internal data structure packets or
transactions are holding references to this server
group. Memlocks is used internally for memory
management purposes.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1861
Security
show storm-control
show storm-control
To display broadcast, multicast, or unicast storm control settings on the device or on the specified interface
or to display storm-control history, use the show storm-control command in user EXEC or privileged EXEC
mode.
show storm-control [{interface-id}] [{broadcast | multicast | unicast}]
Syntax Description interface-id (Optional) Interface ID for the physical port (including type, stack member for stacking-capable
devices, module, and port number).
broadcast (Optional) Displays broadcast storm threshold setting.
multicast (Optional) Displays multicast storm threshold setting.
unicast (Optional) Displays unicast storm threshold setting.
Command Modes User EXEC (>)
Privileged EXEC (>)
Command History Release Modification
Cisco IOS XE Everest 16.5.1a This command was introduced.
Usage Guidelines When you enter an interface ID, the storm control thresholds appear for the specified interface. If you do not
enter an interface ID, settings appear for one traffic type for all ports on the device. If you do not enter a traffic
type, settings appear for broadcast storm control.
The following is sample partial output from the show storm-control command when no keywords
are entered. Because no traffic-type keyword was entered, the broadcast storm control settings appear.
Device> show storm-control
Interface Filter State Upper Lower Current
--------- ------------- ---------- --------- ---------
Gi1/0/1 Forwarding 20 pps 10 pps 5 pps
Gi1/0/2 Forwarding 50.00% 40.00% 0.00%
<output truncated>
The following is sample output from the show storm-control command for a specified interface.
Because no traffic-type keyword was entered, the broadcast storm control settings appear.
Device> show storm-control gigabitethernet 1/0/1
Interface Filter State Upper Lower Current
--------- ------------- ---------- --------- ---------
Gi1/0/1 Forwarding 20 pps 10 pps 5 pps
The following table describes the fields in the show storm-control display:
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1862
Security
show storm-control
Table 212: show storm-control Field Descriptions
Field Description
Interface Displays the ID of the interface.
Filter State Displays the status of the filter:
• Blocking—Storm control is enabled, and a storm
has occurred.
• Forwarding—Storm control is enabled, and no
storms have occurred.
• Inactive—Storm control is disabled.
Upper Displays the rising suppression level as a percentage
of total available bandwidth in packets per second or
in bits per second.
Lower Displays the falling suppression level as a percentage
of total available bandwidth in packets per second or
in bits per second.
Current Displays the bandwidth usage of broadcast traffic or
the specified traffic type (broadcast, multicast, or
unicast) as a percentage of total available bandwidth.
This field is only valid when storm control is enabled.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1863
Security
show tech-support acl
show tech-support acl
To display access control list (ACL)-related information for technical support, use the show tech-support
acl command in privileged EXEC mode.
show tech-support acl
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Cisco IOS XE Gibraltar 16.11.1
Usage Guidelines The output of the show tech-support acl command is very long. To better manage this output, you can redirect
the output to an external file (for example, show tech-support acl | redirect flash:show_tech_acl.txt) in the
local writable storage file system or remote file system.
The output of this command displays the following commands:
Note On stackable platforms, these commands are executed on every switch in the stack. On modular platforms,
like Catalyst 9400 Series Switches, these commands are run only on the active switch.
Note The following list of commands is a sample of the commands available in the output; these may differ based
on the platform.
• show clock
• show version
• show running-config
• show module
• show interface
• show access-lists
• show logging
• show platform software fed switch switch-number acl counters hardware
• show platform software fed switch switch-number ifm mapping
• show platform hardware fed switch switch-number fwd-asic drops exceptions
• show platform software fed switch switch-number acl info
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1864
Security
show tech-support acl
• show platform software fed switch switch-number acl
• show platform software fed switch switch-number acl usage
• show platform software fed switch switch-number acl policy intftype all cam
• show platform software fed switch switch-number acl cam brief
• show platform software fed switch switch-number acl policy intftype all vcu
• show platform hardware fed switch switch-number acl resource usage
• show platform hardware fed switch switch-number fwd-asic resource tcam table acl
• show platform hardware fed switch switch-number fwd-asic resource tcam utilization
• show platform software fed switch switch-number acl counters hardware
• show platform software classification switch switch-number all F0 class-group-manager class-group
• show platform software process database forwarding-manager switch switch-number R0 summary
• show platform software process database forwarding-manager switch switch-number F0 summary
• show platform software object-manager switch switch-number F0 pending-ack-update
• show platform software object-manager switch switch-number F0 pending-issue-update
• show platform software object-manager switch switch-number F0 error-object
• show platform software peer forwarding-manager switch switch-number F0
• show platform software access-list switch switch-number f0 statistics
• show platform software access-list switch switch-number r0 statistics
• show platform software trace message fed switch switch-number
• show platform software trace message forwarding-manager switch switch-number F0
• show platform software trace message forwarding-manager switch R0 switch-number R0
Examples The following is sample output from the show tech-support acl command:
Device# show tech-support acl
.
.
.
------------------ show platform software fed switch 1 acl cam brief ------------------
Printing entries for region ACL_CONTROL (143) type 6 asic 0
========================================================
TAQ-4 Index-0 (A:0,C:0) Valid StartF-1 StartA-1 SkipF-0 SkipA-0
Output IPv4 VACL
VCU Result: Not In-Use
L3 Length: 0000, L3 Protocol: 17 (UDP), L3 Tos: 00
Source Address/Mask
0.0.0.0/0.0.0.0
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1865
Security
show tech-support acl
Destination Address/Mask
0.0.0.0/0.0.0.0
Router MAC: Disabled, Not First Fragment: Disabled, Small Offset: Disabled
L4 Source Port/Mask L4 Destination Port/Mask
0x0044 (68)/0xffff 0x0043 (67)/0xffff
TCP Flags: 0x00 ( NOT SET )
ACTIONS: Forward L3, Forward L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
-----------------------------------------
TAQ-4 Index-1 (A:0,C:0) Valid StartF-0 StartA-0 SkipF-0 SkipA-0
Output IPv4 VACL
VCU Result: Not In-Use
L3 Length: 0000, L3 Protocol: 17 (UDP), L3 Tos: 00
Source Address/Mask
0.0.0.0/0.0.0.0
Destination Address/Mask
0.0.0.0/0.0.0.0
Router MAC: Disabled, Not First Fragment: Disabled, Small Offset: Disabled
L4 Source Port/Mask L4 Destination Port/Mask
0x0043 (67)/0xffff 0x0044 (68)/0xffff
TCP Flags: 0x00 ( NOT SET )
ACTIONS: Forward L3, Forward L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
-----------------------------------------
TAQ-4 Index-2 (A:0,C:0) Valid StartF-0 StartA-0 SkipF-0 SkipA-0
Output IPv4 VACL
VCU Result: Not In-Use
L3 Length: 0000, L3 Protocol: 17 (UDP), L3 Tos: 00
Source Address/Mask
0.0.0.0/0.0.0.0
Destination Address/Mask
0.0.0.0/0.0.0.0
Router MAC: Disabled, Not First Fragment: Disabled, Small Offset: Disabled
L4 Source Port/Mask L4 Destination Port/Mask
0x0043 (67)/0xffff 0x0043 (67)/0xffff
TCP Flags: 0x00 ( NOT SET )
ACTIONS: Forward L3, Forward L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
-----------------------------------------
TAQ-4 Index-3 (A:0,C:0) Valid StartF-0 StartA-0 SkipF-0 SkipA-0
Input IPv4 PACL
VCU Result: Not In-Use
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1866
Security
show tech-support acl
L3 Length: 0000, L3 Protocol: 00 (HOPOPT), L3 Tos: 00
Source Address/Mask
0.0.0.0/0.0.0.0
Destination Address/Mask
0.0.0.0/0.0.0.0
Router MAC: Disabled, Not First Fragment: Disabled, Small Offset: Disabled
L4 Source Port/Mask L4 Destination Port/Mask
0x0000 (0)/0x0000 0x0000 (0)/0x0000
TCP Flags: 0x00 ( NOT SET )
ACTIONS: Drop L3, Drop L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
-----------------------------------------
TAQ-4 Index-4 (A:0,C:0) Valid StartF-0 StartA-0 SkipF-0 SkipA-0
Output IPv4 PACL
VCU Result: Not In-Use
L3 Length: 0000, L3 Protocol: 00 (HOPOPT), L3 Tos: 00
Source Address/Mask
0.0.0.0/0.0.0.0
Destination Address/Mask
0.0.0.0/0.0.0.0
Router MAC: Disabled, Not First Fragment: Disabled, Small Offset: Disabled
L4 Source Port/Mask L4 Destination Port/Mask
0x0000 (0)/0x0000 0x0000 (0)/0x0000
TCP Flags: 0x00 ( NOT SET )
ACTIONS: Drop L3, Drop L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
-----------------------------------------
TAQ-4 Index-5 (A:0,C:0) Valid StartF-0 StartA-0 SkipF-0 SkipA-0
Output MAC PACL
VLAN ID/MASK : 0x000 (000)/0x000
Source MAC/Mask : 0000.0000.0000/0000.0000.0000
Destination MAC/Mask : 0000.0000.0000/0000.0000.0000
isSnap: Disabled, isLLC: Disabled
ACTIONS: Drop L3, Drop L2, Logging Disabled
ACL Priority: 2 (15 is Highest Priority)
.
.
.
Output fields are self-explanatory.
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1867
Security
show tech-support identity
show tech-support identity
To display identity/802.1x-related information for technical support, use the show tech-support identity
command in privileged EXEC mode.
show tech-support identity mac mac-address interface interface-name
Syntax Description mac mac-address Displays information about the client
MAC address.
interface interface-name Displays information about the client
interface.
Command Modes Privileged EXEC (#)
Command History Release Modification
Cisco IOS XE Gibraltar 16.10.1 This command was introduced.
Cisco IOS XE Gibraltar 16.11.1
Usage Guidelines The output of the show tech-support platform command is very long. To better manage this output, you can
redirect the output to an external file (for example, show tech-support identity mac mac-address interface
interface-name | redirect flash:filename) in the local writable storage file system or remote file system.
The output of this command displays the following commands:
• show clock
• show module
• show version
• show switch
• show redundancy
• show dot1x statistics
• show ip access-lists
• show interface
• show ip interface brief
• show vlan brief
• show running-config
• show logging
• show interface controller
• show platform authentication sbinfo interface
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1868
Security
show tech-support identity
• show platform host-access-table
• show platform pm port-data
• show spanning-tree interface
• show access-session mac detail
• show platform authentication session mac
• show device-tracking database mac details
• show mac address-table address
• show access-session event-logging mac
• show authentication sessions mac details R0
• show ip admission cache R0
• show platform software wired-client R0
• show platform software wired-client F0
• show platform software process database forwarding-manager R0 summary
• show platform software process database forwarding-manager F0 summary
• show platform software object-manager F0 pending-ack-update
• show platform software object-manager F0 pending-issue-update
• show platform software object-manager F0 error-object
• show platform software peer forwarding-manager R0
• show platform software peer forwarding-manager F0
• show platform software VP R0 summary
• show platform software VP F0 summary
• show platform software fed punt cpuq
• show platform software fed punt cause summary
• show platform software fed inject cause summary
• show platform hardware fed fwd-asic drops exceptions
• show platform hardware fed fwd-asic resource tcam table acl
• show platform software fed acl counter hardware
• show platform software fed matm macTable
• show platform software fed ifm mappings
• show platform software trace message fed reverse
• show platform software trace message forwarding-manager R0 reverse
• show platform software trace message forwarding-manager F0 reverse
Command Reference, Cisco IOS XE Cupertino 17.7.x (Catalyst 9300 Switches)
1869
Security
show tech-support identity
• show platform software trace message smd R0 reverse
• show authentication sessions mac details
• show platform software wired-client
• show platform software process database forwarding-manager summary
You might also like
- Network Security All-in-one: ASA Firepower WSA Umbrella VPN ISE Layer 2 SecurityFrom EverandNetwork Security All-in-one: ASA Firepower WSA Umbrella VPN ISE Layer 2 SecurityNo ratings yet
- Command Reference, Cisco IOS XE Gibraltar 16.12.x (Catalyst 9300 Switches)No ratings yetCommand Reference, Cisco IOS XE Gibraltar 16.12.x (Catalyst 9300 Switches)1,836 pages
- Cisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #3From EverandCisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #34.5/5 (2)
- Command Reference, Cisco IOS XE 17.15.x (Catalyst 9400 Switches)No ratings yetCommand Reference, Cisco IOS XE 17.15.x (Catalyst 9400 Switches)2,468 pages
- Command Reference, Cisco IOS XE 17.13.x (Catalyst 9200 Switches)No ratings yetCommand Reference, Cisco IOS XE 17.13.x (Catalyst 9200 Switches)2,072 pages
- Software Configuration Guide, Cisco IOS XE Amsterdam 17.3.x (Catalyst 9300 Switches)No ratings yetSoftware Configuration Guide, Cisco IOS XE Amsterdam 17.3.x (Catalyst 9300 Switches)30 pages
- Cisco Catalyst 9400 Series Hardware Installation ManualNo ratings yetCisco Catalyst 9400 Series Hardware Installation Manual26 pages
- Cisco IOS IP Command Reference Part 1 of 3No ratings yetCisco IOS IP Command Reference Part 1 of 3448 pages
- Cisco IOS Interface and Hardware Component Command Reference PDFNo ratings yetCisco IOS Interface and Hardware Component Command Reference PDF2,524 pages
- Software Configuration Guide, Cisco IOS XE 17.13.x (Catalyst 9200 Switches)No ratings yetSoftware Configuration Guide, Cisco IOS XE 17.13.x (Catalyst 9200 Switches)26 pages
- Cisco Mobility Express Command Reference, Release 8.3100% (1)Cisco Mobility Express Command Reference, Release 8.31,158 pages
- CIsco IOS Configuration Fundamentals Command ReferenceNo ratings yetCIsco IOS Configuration Fundamentals Command Reference974 pages
- Catalyst 2950 and Catalyst 2955 Switch Command Reference, 12.1 (22) EA11 and LaterNo ratings yetCatalyst 2950 and Catalyst 2955 Switch Command Reference, 12.1 (22) EA11 and Later674 pages
- 3 - Configuring A Network Operating SystemNo ratings yet3 - Configuring A Network Operating System66 pages
- Catalyst 3750 Switch Software Configuration Guide: Cisco IOS Release 12.2 (46) SE August 2008No ratings yetCatalyst 3750 Switch Software Configuration Guide: Cisco IOS Release 12.2 (46) SE August 20081,298 pages
- Catalyst 4500 Series Switch Software Configuration Guide, 12.2 (53) SGNo ratings yetCatalyst 4500 Series Switch Software Configuration Guide, 12.2 (53) SG1,358 pages
- CISCO PACKET TRACER LABS: Best practice of configuring or troubleshooting NetworkFrom EverandCISCO PACKET TRACER LABS: Best practice of configuring or troubleshooting NetworkNo ratings yet
- Network with Practical Labs Configuration: Step by Step configuration of Router and Switch configurationFrom EverandNetwork with Practical Labs Configuration: Step by Step configuration of Router and Switch configurationNo ratings yet
- Mastering Python Network Automation: Automating Container Orchestration, Configuration, and Networking with Terraform, Calico, HAProxy, and IstioFrom EverandMastering Python Network Automation: Automating Container Orchestration, Configuration, and Networking with Terraform, Calico, HAProxy, and IstioNo ratings yet
- Building Telephony Systems with OpenSIPS - Second EditionFrom EverandBuilding Telephony Systems with OpenSIPS - Second EditionNo ratings yet
- WAN TECHNOLOGY FRAME-RELAY: An Expert's Handbook of Navigating Frame Relay NetworksFrom EverandWAN TECHNOLOGY FRAME-RELAY: An Expert's Handbook of Navigating Frame Relay NetworksNo ratings yet
- Mastering C++ Network Automation: Run Automation across Configuration Management, Container Orchestration, Kubernetes, and Cloud NetworkingFrom EverandMastering C++ Network Automation: Run Automation across Configuration Management, Container Orchestration, Kubernetes, and Cloud NetworkingNo ratings yet
- Python Networking 101: Navigating essentials of networking, socket programming, AsyncIO, network testing, simulations and AnsibleFrom EverandPython Networking 101: Navigating essentials of networking, socket programming, AsyncIO, network testing, simulations and AnsibleNo ratings yet
- LEARN MPLS FROM SCRATCH PART-B: A Beginners guide to next level of networkingFrom EverandLEARN MPLS FROM SCRATCH PART-B: A Beginners guide to next level of networkingNo ratings yet
- IP Addressing Scheme (Topic 4) : TextbookNo ratings yetIP Addressing Scheme (Topic 4) : Textbook37 pages
- NDG Network Virtualization concepts Course Questions اسئلةNo ratings yetNDG Network Virtualization concepts Course Questions اسئلة5 pages
- Oxe12.1 SD CommonHwBoards 8AL91022USAF 1 enNo ratings yetOxe12.1 SD CommonHwBoards 8AL91022USAF 1 en44 pages
- Services Architecture v3.2 Student Guide DownloadNo ratings yetServices Architecture v3.2 Student Guide Download430 pages
- TRP-C34H: Ethernet To 4 RS232/422/485 ConverterNo ratings yetTRP-C34H: Ethernet To 4 RS232/422/485 Converter44 pages
- Firewall Installation, Configuration, and Management: Essentials INo ratings yetFirewall Installation, Configuration, and Management: Essentials I1 page
- Mimosa by Airspan C5x Datasheet - DS 0016 30 PDFNo ratings yetMimosa by Airspan C5x Datasheet - DS 0016 30 PDF4 pages
- Satish Chandra Memorial School: Case Study Based Questions100% (2)Satish Chandra Memorial School: Case Study Based Questions4 pages
- CS L04 Network Attacks 1598792374424 PDFNo ratings yetCS L04 Network Attacks 1598792374424 PDF58 pages
- Network Basic Configuration PT Practice SBANo ratings yetNetwork Basic Configuration PT Practice SBA2 pages
- AR7241: A High Performance and Cost-Effective Network ProcessorNo ratings yetAR7241: A High Performance and Cost-Effective Network Processor38 pages
